WEB CONTROL PANEL ================================== NCheck administration and configuration application is a control panel application. This is a web-based application that can be accessed using popular web browsers using following URL. .. _Ref181699467: Start web Control panel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. list-table:: Launch NCheck 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. NCheck control panel launcher application with extended data capture capabilities is available with the NCheck Server and NCheck Admin client installations. This application can be launched from .. list-table:: Launch NCheck control panel from server and clients :widths: 2245 5670 * - Server - #. Right click on the NCheck server tray application icon #. select Control panel menu item as :numref:`Ref37254907` * - Windows Admin client - #. Open the application menu #. select control panel as shown in :numref:`Ref37254975` . * - Android Admin Client - #. Open the side bar menu #. Select control panel as shown in :numref:`Ref37255043` .. _Ref37254975: .. figure:: Images/chapter_control_panel/image114.PNG :width: 95 :figclass: align-center NCheck Windows Admin client main menu .. _Ref37255043: .. figure:: Images/chapter_control_panel/image116.PNG :width: 135 :figclass: align-center NCheck Android Admin client main menu .. note:: NCheck 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 the Internet Explorer browser. .. _Ref32491676: Sign in to web Control Panel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Once the NCheck 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/chapter_control_panel/image118.PNG :width: 307 :figclass: align-center Browser warning without SSL certificate #. You may use the 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 the trusted server list. Once the warning has been resolved as mentioned above, user will be asked to login to NCheck control panel as shown in :numref:`Ref34135353` . .. _Ref34135353: .. figure:: Images/chapter_control_panel/image120.PNG :width: 264 :figclass: align-center NCheck control panel sign in #. Google login button If you are using your Gmail email address to login to the NCheck control panel, you can use this option to login into control panel, signing with the Gmail account. #. Intuit login button If you have `Quickbook `_ account, you can login to the NCheck control panel if you are using same email address. #. Username #. Password. #. Forget password link The forgot password view appears as shown in :numref:`Ref29390483` . #. Email address #. Security check for human #. Reset password button Password reset email will be sent to the email address if that is specified to a user in NCheck. In on-premises mode Administrator allows to reset user password as mentioned in :ref:`Change password` section. The error message could appear as shown in :numref:`Ref37255455` #. Remember me Once you logged in to the NCheck control panel, the logged in session will expire after limited time and you will be asked to login again. To continue the logged in session without expiration, select this option. #. Login button After successful login in, you will be landed in the NCheck Control Panel Dashboard. The possible error messages after selecting login button are shown in :numref:`Ref37255442` #. Sign up link This is available only on NCheck Cloud. It loads the signup page for subscribing to NCheck Cloud. .. note:: For NCheck 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. .. _Ref29390483: .. figure:: Images/chapter_control_panel/image122.PNG :width: 279 :figclass: align-center Request password reset After signing in, those who have administrator privileges will be landed in the NCheck Control Panel Dashboard, it will show a tour to demonstrate how to setup NCheck for attendance recording. .. figure:: Images/chapter_control_panel/image124.PNG :width: 559 :figclass: align-center Once you login to the system, it will show onboarding checklist menu in the :ref:`Navigation bar` . This will guide you to set up the attendance and visitor management system for the first time use. The onboarding checklist is shown below. .. figure:: Images/chapter_control_panel/image125.PNG :width: 236 :figclass: align-center Onboarding checklist menu #. Onboarding checklist progress #. Onboarding checklist #. Add users This will open Add employee dialog as mentioned in :ref:`Add employee/visitor` section. #. Register devices This will open Register device dialog as mentioned in :ref:`Register device` section to generate registration token to register NCheck client device with the system. #. Create group This will guide open Add employee group dialog to create new employee group as mentioned :ref:`Create group` in section. #. Create shifts This will open Add shift dialog to create new shift as mentioned in :ref:`Add/edit shift` section. #. Creates employee schedules This will open create schedule dialog to create employee schedule as mentioned in :ref:`Add/edit bio attendance schedule` section. #. Create visitor schedules. This will open create schedule dialog to create visitor schedule as mentioned in :ref:`Add/edit visitor schedules` section. #. Finish onboarding Once the onboarding checklist is done, select the finish onboarding section to close the menu. Once the initial setting up has done, users will be able to access the NCheck control panel as assigned roles mentioned in :ref:`Web Control Panel Roles` section. .. _Ref29818266: Web Control Panel Roles ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The 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. #. Visitor administrator Visitor administrator can manage all visitor data such as visitors, schedules, appointments, etc. #. Visitor admin auditor Visitor admin auditor can access all visitor data as visitor administrator. But it does not allow to change and save. #. 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 Control Panel provides self service functions for standard users. Web Control Panel View ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ NCheck Control Panel has following components .. figure:: Images/chapter_control_panel/image127.PNG :width: 404 :figclass: align-center NCheck control panel #. :ref:`Navigation bar` #. :ref:`Side bar` #. :ref:`Tab content view` .. _Ref174107228: Navigation bar ------------------------------------------------------ .. figure:: Images/chapter_control_panel/image129.PNG :width: 505 :figclass: align-center NCheck Bio Attendance navigation bar #. Brading logo #. Onboarding checklist menu A virtual demonstration which guides how to setup NCheck for attendance recording. This will be popup once you login to the system as mentioned in :ref:`Sign in to web Control Panel` section. #. Resource center #. Onboarding tutorial Open onboarding checklist menu. #. User guide Open NCheck user guide. #. Contact us #. Report a bug This will open the email client application installed in the device to report bugs via email. NCheck support team will respond immediately. #. System info Show information such as NCheck server version, terms and conditions, privacy policy. #. Notification button Open notification dialog #. Language selection To change NCheck server control panel language. #. Account menu Refer section for more details. Account menu +++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image131.PNG :width: 196 :figclass: align-center NCheck sign in user account view #. :ref:`Logged in user account details view` #. :ref:`Switch profile by role` #. :ref:`My Account` #. :ref:`Login options` #. Sign out Sign out from NCheck server control panel. .. _Ref178686044: Logged in user account details view """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image133.PNG :width: 427 :figclass: align-center Logged in user account detail’s view #. Company logo #. Name of the admin user #. Role name #. This appears, if the user logged in from the customer account .. _Ref178686052: Switch profile by role """""""""""""""""""""""""""""""""""""""""""""""""""" .. _Ref174110897: My Account """""""""""""""""""""""""""""""""""""""" This can be used to edit your account details. Depending on the current role, this view is different. .. figure:: Images/chapter_control_panel/image135.PNG :width: 326 :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. #. Remove photo Rest the profile picture to the NCheck default profile picture as shown in Figure 510 #. Admin name 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/chapter_control_panel/image137.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 that could be appeared are sown in :numref:`Ref183008708` . #. Close button .. _Ref183008708: .. 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. .. _Ref178686067: Login options """"""""""""""""""""""""""""""""""""""""""" Login options dialog allows to change login details for the admin role as follows. .. figure:: Images/chapter_control_panel/image139.PNG :width: 442 :figclass: align-center Login options dialog #. Profile picture #. Upload button To select the profile image from locale file system. #. Remove button Remove profile image. #. Full name #. New password Password must contain at least 8 characters including once upper case, lower case, number and special character from ("!", "@", "#", "$", "%", "^", "&", "*"). #. Confirm password #. Update button The update button will be disabled if data :ref:`Validation errors` exists. All error messages are shown in the table below. #. Close button .. 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. .. _Ref174107235: Side bar ------------------------------------------------ The side bar contains branding, and the main menu is as follows. .. figure:: Images/chapter_control_panel/image141.PNG :width: 148 :figclass: align-center NCheck Bio Attendance side bar #. :ref:`Main menu` #. Download app #. Name of the organization #. Number of existing users out of total number of users allowed. #. Number of existing appointments out of total number of appointments allowed. #. Collapse sidebar Collapse/show sidebar .. _Ref178692292: Main menu +++++++++++++++++++++++++++++++++++++++++++++++++ NCheck Web Control Panel Menu is used to access main functions of control panel. Control panel provides the following functions through the menu. #. :ref:`Dashboard` #. :ref:`User Management` #. User groups. :ref:`Manage Employee Groups` #. Schedule and shifts :ref:`Manage schedule and shifts` #. Locations :ref:`Manage Locations` #. Appointments :ref:`Manage appointments` #. Leave and holiday :ref:`Manage Leaves and holidays` #. Devices :ref:`Manage devices` #. Event log :ref:`Manage Event logs` #. :ref:`Reports` #. :ref:`Settings` #. :ref:`Admin Tasks` #. :ref:`Subscription` Based on the current role, available menu items may be different. Also, the functionality inside the menu item is also different. .. list-table:: :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/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Manage Users` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Manage user Groups` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Manage Shifts and Rosters` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Manage leaves and holidays - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Manage devices` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Manage Event logs` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Reports` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Admin Tasks` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Settings` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Subscription` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center .. _Ref180570000: Tab content view -------------------------------------------------------- Tab content view is where the content of the select menu from :ref:`Side bar` is showing. Menu content view is shown below. .. figure:: Images/chapter_control_panel/image143.PNG :width: 554 :figclass: align-center user management tab content view #. Bio attendance and visitor management mode selection switch Switch between bio attendance and visitor management features for the selected tab. #. Content area .. _Ref180571463: Bio attendance and visitor mode selection +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ NCheck allows to manage employee and visitor functions in the system. In the control panel, for menus such as :ref:`Dashboard` , :ref:`User Management` , :ref:`Manage schedule and shifts` , etc. are showing bio attendance and visitor mode selection view to show the specific view in the content area. Bio attendance and visitor mode selection controller can appear in following ways. .. figure:: Images/chapter_control_panel/image145.PNG :width: 300 :figclass: align-center Bio attendance and visitor management switch view .. figure:: Images/chapter_control_panel/image147.PNG :width: 215 :figclass: align-center Employee and visitor switch view .. _Ref31022752: .. _tooltip_control_panel_dashboard_title: Dashboard ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _tooltip_control_panel_dashboard_desc: The dashboard provides a graphical summary of the employee and visitor activities of the NCheck customer account. Customer account administrator and users marked as administrators can access the Dashboard. Summary includes. Dashboard view is shown below. .. figure:: Images/chapter_control_panel/image149.PNG :width: 564 :figclass: align-center Dashboard view #. :ref:`Dashboard controls` #. Dashboard data view Dashboard data view is showing :ref:`Employee dashboard` and :ref:`Visitor dashboard` . .. _Ref182908662: Dashboard controls ---------------------------------------------------------- .. figure:: Images/chapter_control_panel/image151.PNG :width: 504 :figclass: align-center Dashboard controls view #. Welcome note for logged in user #. User group selection Select a user group from the list to load the statistics in the :ref:`Employee dashboard` . This is unavailable for :ref:`Visitor dashboard` . #. Employee/visitor switch Switch between :ref:`Employee dashboard` and :ref:`Visitor dashboard` . .. _Ref182908583: Employee dashboard ---------------------------------------------------------- Employee dashboard is shown below. .. figure:: Images/chapter_control_panel/image153.PNG :width: 668 :figclass: align-center Employee dashboard view #. :ref:`Employees Summary` #. :ref:`Employee device summery` #. :ref:`Recent Employee activity` #. :ref:`Leaves and holidays` .. _Ref31022975: .. _tooltip_control_panel_dashboard_employee_title: Employees Summary ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_control_panel_dashboard_employee_desc: The employee summery graph shows an overview of the employee activities at the current date and time. .. figure:: Images/chapter_control_panel/image155.PNG :width: 299 :figclass: align-center Employee summery view of the Dashboard #. Legend #. Percentage of checked-in users #. Percentage of checked-out users #. Percentage of users on leave #. Add user button Open add employee dialog to create new employee as mentioned in :ref:`Add employee/visitor` section. The number of users of each activity is showing when hovering on the graph. .. _Ref182910371: .. _tooltip_control_panel_dashboard_eemployee_device_title: Employee device summery ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_control_panel_dashboard_eemployee_device_desc: The employee device summary is showing the NCheck Windows, Android and IOS admin and attend clients registered with the system. .. figure:: Images/chapter_control_panel/image157.PNG :width: 323 :figclass: align-center Employee device summery view #. Legend #. Number of Windows, Android and IOS Attend clients registered for employees. #. Number of Windows And droid Admin clients registered with the selected group. #. Register devices button This will open register device dialog to generate registration token to register Admin and attend clients as mentioned in :ref:`Register device` section. .. _Ref31023415: .. _tooltip_control_panel_dashboard_recent_users_title: Recent Employee activity +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_control_panel_dashboard_recent_users_desc: The recent employee activity view shows the last event of all employees in the current day. .. figure:: Images/chapter_control_panel/image159.PNG :width: 270 :figclass: align-center Employee activity view of the Dashboard #. Event type tabs Select event type from check-in, check-out and access, to filter out the last user events. #. Event list Event list is showing check-in, check-out and access events according to the selected event type from the event type tab. Refer :ref:`Recent employee event view` section for more details about event information. #. Fix attendance events button Add events for users. This opens the :ref:`Events view for employee/visitor event logs` in :ref:`Manage Event logs` . #. Manage overtime approvals button Manager overtime approvals. This opens the :ref:`Overtime view for employee events logs` in :ref:`Manage Event logs` section. #. Refresh button .. _Ref182924820: Recent employee event view """""""""""""""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image161.PNG :width: 340 :figclass: align-center Recent employee event view #. Username and event date time #. Event type Event type as in(check-in), out(check-out) or access .. _Ref37614614: .. _tooltip_control_panel_dashboard_leaves_and_holiday_title: Leaves and holidays +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image163.PNG :width: 530 :figclass: align-center Leave and holiday view #. Legend #. The leaves and holidays calendar Calendar is showing dates with available leaves and holidays. Leaves, holidays and recurring holidays are shown in separate color codes. For the selected date, all available leaves and holidays are shown in the leave and holidays list view. The leave tab shows a list of :ref:`Leave view` and holiday tab is showing list of :ref:`Holiday view` available for the selected date in the calendar. #. Leave and holidays list view This view is showing available leaves and holidays for the selected date from the calendar. #. Manage leaves button You will be redirect to the Leave and holiday section. .. _Ref178703899: Leave view """""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image165.PNG :width: 305 :figclass: align-center Leave view #. Username and leave date .. _Ref178703915: Holiday view """""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image167.PNG :width: 264 :figclass: align-center Holiday view #. Holiday name and date .. _Ref182908588: Visitor dashboard --------------------------------------------------------- The visitor dashboard is shown below. .. figure:: Images/chapter_control_panel/image169.PNG :width: 645 :figclass: align-center Visitor dashboard view #. :ref:`Appointment summery` #. :ref:`Visitor device summery` #. :ref:`Recent visitor activity` #. :ref:`Recent visitor event view` .. _Ref182925340: Appointment summery +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Appointment summery graph shows an overview of all appointments on the current date. .. figure:: Images/chapter_control_panel/image171.PNG :width: 333 :figclass: align-center Appointment summery view #. Not attended The appointments are considered as not attended if the visitor has not been recorded for the appointment before finished #. Pending appointments The appointments that visitors have not been recorded #. In progress appointments The appointments that visitors have already been recorded as in progress appointments. #. Cancelled appointments The appointments set a cancelled #. Completed appointments The appointments set as completed appointments #. Add appointments This will redirect to the Appointments section to add new appointment. .. _Ref182925469: .. _tooltip_control_panel_dashboard_visitor_device_title: Visitor device summery +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_control_panel_dashboard_visitor_device_desc: The visitor devices summary is showing the NCheck Windows, Android and IOS admin and attend clients registered with the system. .. figure:: Images/chapter_control_panel/image157.PNG :width: 323 :figclass: align-center Employee device summery view #. Legend #. Number of Windows, Android and IOS Attend clients registered for a location. #. Register devices button This will open register device dialog to generate registration token to register Admin and attend clients as mentioned in :ref:`Register device` section. .. _Ref174350227: Recent visitor activity +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The recent visitor activity view shows last event of the visitors in the current day. .. figure:: Images/chapter_control_panel/image173.PNG :width: 325 :figclass: align-center Recent visitor activity view of the dashboard #. Event type tabs Select event type from check-in, check-out and access, to filter out the last visitor events #. Event list Event list is showing all recent events of visitors according to the selected event type from the event type tab. Refer :ref:`Recent visitor event view` section for more information about visitor events. #. Fix visitor event button Add events for visitors. This opens the :ref:`Events view for employee/visitor event logs` in :ref:`Manage Event logs` . #. Refresh button .. _Ref182925548: Recent visitor event view """"""""""""""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image175.PNG :width: 334 :figclass: align-center Recent visitor event view #. Username and event date time #. Event type Event type as in(check-in), out(check-out) or access Schedules view +++++++++++++++++++++++++++++++++ Schedule and appointment view is shown below. .. figure:: Images/chapter_control_panel/image177.PNG :width: 613 :figclass: align-center #. Scheule calendar #. List of schedules view The list of schedules and number of appointments for the selected date showing this view. #. Manage appointments button This opens :ref:`Manage appointments` view. .. _Ref37614517: User Management ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ User management allows employees to manage and visitors’ data such as personal information’s, biometrics, appointments etc. The user management view can be switched to either employee or visitor as mentioned in :ref:`Bio attendance and visitor mode selection` section. The user management view is shown below. .. figure:: Images/chapter_control_panel/image178.PNG :width: 539 :figclass: align-center Employee management view .. figure:: Images/chapter_control_panel/image180.PNG :width: 542 :figclass: align-center Visitor management view #. Action view #. Add employees/visitor menu #. Add employee/visitor button Refer :ref:`Add employee/visitor` section for more details. #. Create employee from deleted employees (Employee only) Refer :ref:`Create employee from deleted employees` section for more details. #. Import button Refer :ref:`Import employees/visitors` section for more details. #. Employee/visitor list view A :ref:`Data table` represent list of employees/visitors. Selected employee/visitor information can be seen in :ref:`Employee/visitor view` . The employee/visitor :ref:`Quick access menu` is showing following options #. Edit Refer :ref:`Edit profile` section for more details. #. Delete Refer :ref:`Remove` section for more details. #. Biometrics Refer :ref:`Update employee/visitor biometrics` section for more details. #. Search employee/visitor Search employee/visitor from the list .. _Ref178842800: .. _tooltip_server_user_add_users_title: Add employee/visitor ------------------------------------------------------------------------------------------------------ .. _tooltip_server_user_add_users_desc: Add employee/visitor is a 3 steps flow including followings. #. Add employee/visitor information This step is mandatory. Employee/visitor name, employee/visitor code should be given. #. Biometric authentication Enroll biometrics such as face, finger and iris. This is not mandatory. #. Register client application (Employee only) Register NCheck client application for the employee for personal attendance recording. This step is not mandatory. Add employee/visitor dialog is shown below. .. figure:: Images/chapter_control_panel/image182.PNG :width: 522 :figclass: align-center Add employee/visitor dialog #. Title as adds employee or adds visitor #. Steps involve adding a new employee/visitor. The current step is highlighted in blue color. #. Content area to show the current step The current steps will be shown in this area. The available steps are #. :ref:`Basic employee/visitor details view` #. :ref:`Biometric authentication view` #. :ref:`Register NCheck app (Employee only)` #. Next button Proceed to the next step. #. Close button .. _Ref178776627: Basic employee/visitor detail’s view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image184.PNG :width: 364 :figclass: align-center Basic employee/visitor details view #. Full name This is a mandatory field. #. Employee/visitor email #. Employee/visitor code This is a mandatory field. Refer :ref:`Employee/visitor code` for more details #. Send invite email to new employees (Employee only) The employee will receive an email containing a one-time registration token and links to download NCheck client application once employee created successfully. To send email notifications, :ref:`Email notification settings` should be configured first. #. See more fields Click this to expand additional fields for employee/visitor. Refer :ref:`Additional employee/visitor fields` section for more details. .. _Ref178770150: Employee/visitor code """"""""""""""""""""""""""""""""""""""""""""""""""" The employee/visitor code is a unique identification for employee/visitor. Employee/visitor code can be given as following when adding employee/visitor .. figure:: Images/chapter_control_panel/image186.PNG :width: 303 :figclass: align-center Employee/visitor code view #. Generate code Generate code by the system #. Use existing code .. _Ref178770219: Additional employee/visitor fields """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Additional information for employees/visitors which are not mandatory when adding. .. figure:: Images/chapter_control_panel/image188.PNG :width: 297 :figclass: align-center Additional employee/visitor fields #. Role (Employee only) Assign employee role as employee, admin, or admin auditor. Refer :ref:`Web Control Panel Roles` section for more details. #. Groups (Employee only) Employee groups to assign employees. By default, employees are assigned to the all-user group. Refer :ref:`Manage User Groups` section for more details about employee groups. #. Primary group (Employee only) #. Username (Employee only) The username to allow to login users to the NCheck control panel. Select User email address as username option to use the email address as the username. #. Address line 1 #. Address line 2 #. City #. Country #. State #. Zip code #. Telephone #. Designation .. _Ref178776636: Biometric authentication view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Biometric authentication view is used to enroll biometrics for the employee and visitors. .. figure:: Images/chapter_control_panel/image190.PNG :width: 313 :figclass: align-center Biometric authentication view #. Biometrics List of enrolled biometrics for the employee/visitor are showing here. To see the biometric details, click on each biometric image. #. Upload biometrics button Upload face, finger and iris images from the local file system. A warning message will appear if the selected image is larger than 2 MB as shown in :numref:`Ref182926926` . #. Enroll from history button Refer :ref:`Enroll biometric from history` section for more details. #. Delete button Delete selected biometrics. .. _Ref182926926: .. figure:: Images/chapter_control_panel/image192.PNG :width: 360 :figclass: align-center Biometric image size warning .. _Ref178775884: Enroll biometric from history """"""""""""""""""""""""""""""""""""""""""""""""""""""""""" Enroll biometric from history option allows users to enroll biometric for unidentified event images. .. figure:: Images/chapter_control_panel/image194.PNG :width: 563 :figclass: align-center Enroll biometrics from history dialog #. Date selection controls Select the from and to date to retrieve unidentified images #. Biometric type Biometric type from Face, finger and iris #. Closely matching biometrics #. Filter by person device #. Filter by user group Filter unidentified event images according to the selected group which client devices are registered. #. Refresh button Refresh unidentified event images. #. Unidentified event images list #. Number of selected images to enroll. Select deselect button to deselect all. #. Paging for unidentified event image list #. Timeline of the event image list retrieved. #. Enroll button Enroll selected images #. Close button .. _Ref178776647: Register NCheck app (Employee only) +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Refer :ref:`Client registering view` section for more details. .. _Ref178842837: Import employees/visitors ----------------------------------------------------------------- The import option is to add many employees/visitors to the system as a zip file. Refer :ref:`Import and Export information` section for more details for importing file structure. To import employees/visitors, .. figure:: Images/chapter_control_panel/image196.PNG :width: 453 :figclass: align-center Import users data view #. The employee/visitor information to be imported Check information needs to be imported. #. User profile information Refer :ref:`User profile information` section for more details about user profile information. #. User location restrictions (Employees only) Refer :ref:`User/user group location restrictions` section for more details. #. Biometrics Refer :ref:`User biometrics and template files` section for more details about importing biometrics. #. Option to send invitation emails for successfully imported employees/visitors #. Option to send device registration token with invitation email (Employees only) Select this option to send registration token to register NCheck personal client for the user for attendance recording. #. Import button Select the Import button to select the import location. Refer :ref:`Select import location` section for more details about selecting import location. #. Close button .. _Ref178842825: Create employee from deleted employees ------------------------------------------------------------------------------ Deleted employees can be restored from this option. This option will restore the employee details only. Previous biometric data, event logs and other data will not be restored. Create employee from deleted employees’ dialog is shown below. .. figure:: Images/chapter_control_panel/image198.PNG :width: 561 :figclass: align-center ..Create employee from deleted employees dialog #. Deleted employees A :ref:`Data table` represent a list of deleted employee list. Select employees from the list to be restored. #. Restore button Restore selected employees. #. Close button .. _Ref178920073: Employee/visitor view ------------------------------------------------------------- Employee/visitor view allows employees/visitor data to manage as below. .. figure:: Images/chapter_control_panel/image200.PNG :width: 430 :figclass: align-center Employee data view #. Employee/visitor data type tab view A list of data types available for employees/visitor #. Details Refer :ref:`Employee/visitor details` section for more information. #. Appointments (Visitor only) Refer :ref:`Appointments` section for more information. #. Devices (Employee only) Refer :ref:`Devices` section for more information. #. Groups (Employees only) Refer :ref:`Groups` section for more details. #. Locations (Employees only) Refer :ref:`Locations` section for more details. #. Leaves (Employees only) Refer :ref:`Leaves` section for more details. #. Employee/visitor content view The content related to the selected employee/visitor data type is shown here. .. _Ref178865089: Employee/visitor details ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image203.PNG :width: 503 :figclass: align-center Employee/visitor detail view #. Profile image Hover the profile image to update profile image as mentioned in :ref:`Manage profile image` section. #. Full name #. Email #. Phone #. Address #. Employee code #. Status The status either activate, block or terminate. #. Biometrics Number of enrolled face, finger and iris biometrics are showing here. #. Employee/visitor options #. Add biometrics button Refer :ref:`Update employee/visitor biometrics` section for more details #. Register devices button (Employee only) Refer :ref:`Client registering view` section for more details. #. :ref:`Edit profile` #. Employee/visitor additional options #. Passes Refer :ref:`Passes` section for more details. #. Show events Show all events for the employee/visitor. You will be navigated to the event logs section. Refer :ref:`Manage Event logs` section for more information. #. :ref:`Change password` #. :ref:`Block` #. :ref:`Terminate` #. :ref:`Activate` #. :ref:`Export` #. :ref:`Remove` .. _Ref178849026: Manage profile image """""""""""""""""""""""""""""""""""""""""""""""""" Profile image of employee/visitor can be updated as below. This view is showing when hovering the mouse icon over profile image., .. figure:: Images/chapter_control_panel/image205.PNG :width: 223 :figclass: align-center Manage profile image view #. Upload photo button Select profile image from the local file system #. History button Select profile image from unidentified event images. Refer :ref:`Choose from unidentified images` section for more details. .. _Ref178848718: Choose from unidentified images ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' Once employee/visitor event record events which are not matched with any employee/visitor in the system, which are known as unidentified events. Unidentified event images can be selected as employee/visitor profile images as follows. .. figure:: Images/chapter_control_panel/image207.PNG :width: 562 :figclass: align-center Choose from unidentified images dialog #. Unidentified events dates filters Select from and to date to retrieve all unidentified images in between. #. Refresh button Refresh unidentified event images. #. Unidentified event images list #. Previous button Browse previous page of unidentified event images #. Next button Browse previous page of unidentified event images. #. Select button #. Close button .. _Ref178853812: Update employee/visitor biometrics """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Update biometrics dialog is shown below. .. figure:: Images/chapter_control_panel/image209.PNG :width: 547 :figclass: align-center Update biometrics dialog #. Biometric authentication view Refer :ref:`Biometric authentication view` section for more information. #. Save button #. Close button .. note:: Biometric enrollment will fail if the image already enrolled for another employee/visitor. .. _Ref178853823: Register devices """""""""""""""""""""""""""""""""""""""""""""" Register NCheck personal client for employee .. figure:: Images/chapter_control_panel/image211.PNG :width: 513 :figclass: align-center #. Registration information view Refer :ref:`Register NCheck app (Employee only)` section for more details. #. Save button #. Close button .. _Ref178853839: Edit profile """""""""""""""""""""""""""""""""""""""""" Edit employee/visitor profile details. The edit profile dialog is shown below. .. figure:: Images/chapter_control_panel/image212.PNG :width: 581 :figclass: align-center Edit profile dialog view #. Employee/visitor detail view Refer :ref:`Basic employee/visitor details view` section for more details. #. Profile image Hover on the profile image to update profile image as mentioned in :ref:`Manage profile image` section. #. Save button #. Close button .. _Ref178853940: Change password """"""""""""""""""""""""""""""""""""""""""""" After assigning a username as mentioned in :ref:`Add employee/visitor` section, the password can be changed. Password must consist of one digit and 6 characters. .. figure:: Images/chapter_control_panel/image214.PNG :width: 474 :figclass: align-center Change user password view #. User name #. Email #. Password Password must have atleast 6 characters and one digit. To gegerate strong password, click generate button instead. #. Graphical representatio for enetered password strength #. Change button Change button will be disabled if the :ref:`Validation errors` exits. :numref:`Ref183008835` is showing the error messages could appear. #. Close button .. _Ref183008835: .. 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. .. _Ref178853910: .. _Ref183009842: Block/unblock """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Block/unblock employee/visitor from the system. Blocked employees/visitors are not allowed to record attendances. .. _Ref178853915: Terminate """"""""""""""""""""""""""""""""""""""" Once employees/visitors terminate, they will not identify with the system. .. _Ref178853921: Activate """""""""""""""""""""""""""""""""""""" Activate blocked/terminated employee/visitors. .. _Ref178853926: Export """""""""""""""""""""""""""""""""""" Refer :ref:`Export data` section for more information. .. _Ref178853930: Remove """""""""""""""""""""""""""""""""""" Delete employee/visitor from the system. .. _Ref178865124: Devices +++++++++++++++++++++++++++++++++++++++++++++++ The device view is showing all NCheck client applications registered with the selected employee as follows. .. figure:: Images/chapter_control_panel/image216.PNG :width: 390 :figclass: align-center Employee devices view #. Name of the registered device #. Unregister button Unregister client application registered to the employee. Once unregistered, the client cannot be used to record employee attendance until it registered again. .. _Ref178865145: Groups ++++++++++++++++++++++++++++++++++++++++++++++ All employee groups that the employee has been added are shown under groups as follows. .. figure:: Images/chapter_control_panel/image218.PNG :width: 450 :figclass: align-center Employee groups view #. Name Unique identification for employee group #. Code Unique code for employee group #. Remove button To remove employee from the employee group. .. _Ref178865159: Locations +++++++++++++++++++++++++++++++++++++++++++++++++ This option allows employees to restrict their specific locations. Refer :ref:`Location restrictions` section for more information about location. .. _Ref178865178: Leaves ++++++++++++++++++++++++++++++++++++++++++++++ The leave view is showing employee leave statistics as follows. .. figure:: Images/chapter_control_panel/image220.PNG :width: 451 :figclass: align-center Employee leaves view #. Leave year #. :ref:`Leave table` #. Details button Refer :ref:`Leave details` section for more details. #. Edit entitlement button Refer :ref:`Edit leave entitlement` section for more details. .. _Ref178864010: Leave table """"""""""""""""""""""""""""""""""""""""" The leave table shows leave usage of the employee. The left table is shown below. .. figure:: Images/chapter_control_panel/image222.PNG :width: 402 :figclass: align-center Employee leave table #. Leave type Refer :ref:`Configure leave type` section for more details about leave type. #. Days taken #. Days available Number of total leaves for each leave type. .. _Ref178864023: Leave details """"""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image224.PNG :width: 561 :figclass: align-center Employee leave summery dialog #. Leave summer for the selected year #. Leaves table A :ref:`Data table` represent list of employee leaves requested. Table contains the following data. #. Leave type Configured leave type. Refer :ref:`Configure leave type` section for more information about configuring leave types. #. Start date Start date of the applied leave(s). #. End date End date of the applied leave(s). #. No of days #. Reasons request #. Approval reason #. Leave policy #. Approval state Approval state as pending, rejected or approved. #. Show rejected leave option Show rejected leaves in the leaves table #. Close button .. _Ref178864042: Edit leave entitlement """""""""""""""""""""""""""""""""""""""""""""""""""" Edit existing leave entitlement for employees. Edit leave entitlement dialog is shown below. .. figure:: Images/chapter_control_panel/image226.PNG :width: 336 :figclass: align-center Edit employee leave e.ntitlment dialog #. :ref:`Leave entitlement for leave type` #. Update button #. Close button .. _Ref178863983: Leave entitlement for leave type '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' .. figure:: Images/chapter_control_panel/image228.PNG :width: 463 :figclass: align-center .....Leave entitlement for leave type view #. Leave type #. Number of taken leave from total number of leaves #. Number of leave entitlement #. Reset button Reset the default number of leave entitlement as mentioned in :ref:`Configure leave type` section. .. _Ref183008788: Appointments ++++++++++++++++++++++++++++++++++++++++++++++++++++ Appointments for the visitors can be seen in this view as shown below. .. figure:: Images/chapter_control_panel/image230.PNG :width: 403 :figclass: align-center Visitor appointment view #. New appointment button Create new appointment for the visitor. This will navigate to the appointments section to create a new appointment as mentioned in section. #. Appointment date #. :ref:`Visitor appointment view` .. _Ref178865023: Visitor appointment view """""""""""""""""""""""""""""""""""""""""""""""""""""" The visitor appointment view is shown below. .. figure:: Images/chapter_control_panel/image232.PNG :width: 314 :figclass: align-center visitor appointment view #. Appointment schedule #. Appointment date and time #. Appointments button This will navigate to the appointment section to see the appointment information as mentioned in section. #. Event logs button This will navigate to the visitor event log section to show the visitor events recorded to this appointment. .. _Ref38783216: .. _tooltip_control_panel_manage_user_groups_title: Manage Employee Groups ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _tooltip_control_panel_manage_user_groups_desc: Administrator and employee group administrators allow managing users as user groups. All user groups are the default employee group including all employees and it is accessible for administrator only. The employee group management view is shown below. .. figure:: Images/chapter_control_panel/image234.PNG :width: 633 :figclass: align-center Employe group management view #. Create group button #. Import button #. Search field Search group #. Employee group list view A :ref:`Data table` represent list of employee groups. Selected employee group information can be seen in employee group view. The employee group :ref:`Quick access menu` is showing following options. #. Edit #. Delete #. Update employees .. _Ref182903185: Create group ---------------------------------------------------- Creating an employee group is 3 steps flow as follows. #. Enter group details This is required step. This requires unique code for employee group and description #. Add employees to the group Add employees to the group #. Register group device Register NCheck client application for the group to record attendance of employees within the group. Create group dialog is shown below. .. figure:: Images/chapter_control_panel/image236.PNG :width: 570 :figclass: align-center #. Steps involve adding a employee group. The current step is highlighted in blue color. #. Content area to show the current step The current steps will be shown in this area. The available steps are #. Group details Refer :ref:`Employee group detail view` section for more information. #. Add employees to group Refer :ref:`Add employees to the group view` section for more details. #. Register group device Refer :ref:`Register group device view` section for more information. #. Next button Proceed to the next step. #. Close button .. _Ref182927307: Employee group detail view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The information to create a new employee group is taken from this view. .. figure:: Images/chapter_control_panel/image237.PNG :width: 398 :figclass: align-center Add employee group view #. Employee group code A unique identification for the employee group. #. Description A description that explains use of the employee group. .. _Ref178933069: Add employees to the group view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Select employees to add to the employee group from available employee list as follows. .. figure:: Images/chapter_control_panel/image239.PNG :width: 547 :figclass: align-center #. Search field Search employee by employee name or employee code #. Employee list A :ref:`Data table` show list of employees. Select employees to add to the employee group. .. _Ref182927353: Register group device view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Refer :ref:`Client registering view` section for more details. Import employee groups. ------------------------------------------ The import option can be used to add a number of employee groups or restore previously exported employee groups. The data imported as zip file. Refer :ref:`Import and Export information` section for more details for importing file structure. To import employee group, .. figure:: Images/chapter_control_panel/image240.PNG :width: 481 :figclass: align-center Import employee groups #. The employee group information to be imported Check information needs to be imported. #. User group information Refer :ref:`User profile information` section for more details about user profile information. #. Employee group memberships Refer :ref:`User group memberships information` section for more details. #. Group admins #. Employee group location restrictions. Refer :ref:`User/user group location restrictions information` section for more details. #. Import button Select the Import button to select the import location. Refer :ref:`Select import location` section for more details about selecting import location. #. Close button Employee group view -------------------------------------- The selected employee group information can be seen in Employee group view. The employee group view is shown below. .. figure:: Images/chapter_control_panel/image242.PNG :width: 406 :figclass: align-center Employee group view #. Employee group data type tab view Following data types are showing here. #. Details Refer :ref:`Employee group details` for more details #. :ref:`Employees` #. :ref:`Devices` #. :ref:`Locations` #. :ref:`Admins` #. Employee group type content view The content related to the selected employee group data type is shown here .. _Ref178940268: Employee group details ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image244.PNG :width: 485 :figclass: align-center #. Employee group code #. Employee group description #. Employees Number of employees added to the group #. Devices The devices registered with the employee group. #. Employee group options #. Register devices button Refer :ref:`Register devices` section for more details. #. Edit button Refer :ref:`Edit employee group` section for more details. #. Update users button Refer :ref:`Update group employes` section for more details. #. Employee group additional options #. Import Refer :ref:`Import group employees` section for more information. #. Export Refer :ref:`Export group employees` section for more information. #. Delete all users Refer :ref:`Delete all group employees` section for more information. #. Restore deleted users Refer :ref:`Restore deleted group employees` section for more information. #. :ref:`Group admins` #. Settings Refer :ref:`User group specific settings` section for more information. #. Delete Refer :ref:`Delete employee group` section for more information. .. _Ref178940373: Registered devices """""""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image245.PNG :width: 387 :figclass: align-center Registered devices list #. Refresh button Refresh devices list #. Registered devices list All registered devices for the employee group are showing here. Each device is shown with device name and unregister button next to it. The device will be unregistered if click on this button and the device cannot be used with the server. .. _Ref178940392: Register devices """""""""""""""""""""""""""""""""""""""""""""" Generate registration token to register NCheck client device. Register devices dialog is shown below. .. figure:: Images/chapter_control_panel/image247.PNG :width: 424 :figclass: align-center Register device dialog #. Registration detail view. This view contains all information to register device. Refer :ref:`Client registering view` section for more details. #. Save button #. Close button .. _Ref178940398: .. _tooltip_server_user_group_edit_users_title: Edit employee group """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_user_group_edit_users_desc: This option allows employees to edit group. Update employee group dialog is shown below. .. figure:: Images/chapter_control_panel/image249.PNG :width: 379 :figclass: align-center Edit employee group dialog #. Employee group profile image Upload profile image for the employee group from local file system. Hovering on the thumbnail image will be shown upload button and remove button to update profile image. #. Employee group code Unique identification for employee group. #. Description A description mentioning the usage. #. Save button #. Close button .. note:: All user group is not allowed to edit .. _Ref38111163: .. list-table:: Error messages of add/edit user group :widths: 1615 5850 * - Error code - Description * - 2020 - Selected file is not a valid image file. * - 2027 - User group code already exists. .. _Ref178940403: Update group employes """"""""""""""""""""""""""""""""""""""""""""""""""" This option allows to add/remove employees in the group. Update group employees dialog is shown below. .. figure:: Images/chapter_control_panel/image251.PNG :width: 497 :figclass: align-center Update group employees dialog #. Add employees to group view This allows to add/remove employees to the group. Refer :ref:`Add employees to the group view` section for more details. #. Save button #. Close button .. _Ref178940851: Import group employees """""""""""""""""""""""""""""""""""""""""""""""""""" The import group employees option is using to add many employees to the employee group as a zip file. Refer :ref:`Import and Export information` section for more details for importing file structure. To import employees/visitors, .. figure:: Images/chapter_control_panel/image196.PNG :width: 453 :figclass: align-center Import users data view #. The group employees information to be imported Check information needs to be imported. #. User profile information Refer :ref:`User profile information` section for more details about user profile information. #. User location restrictions Refer :ref:`User/user group location restrictions` section for more details. #. Biometrics Refer :ref:`User biometrics and template files` section for more details about importing biometrics. #. Option to send invitation emails for successfully imported employees/visitors #. Option to send device registration token with invitation email (Employees only) Select this option to send registration token to register NCheck personal client for the user for attendance recording. #. Import button Select the Import button to select the import location. Refer :ref:`Select import location` section for more details about selecting import location. #. Close button .. note:: To send email notification, :ref:`Email notification settings` should be configured. .. _Ref178940857: Export group employees """""""""""""""""""""""""""""""""""""""""""""""""""" Export group employees information as a zip file. Refer :ref:`Import and Export information` section for more details for importing file structure. Export group employees dialog is shown below. .. figure:: Images/chapter_control_panel/image253.PNG :width: 533 :figclass: align-center Export group employees dialog. #. Group employees information to be exported #. Employee profile information Refer :ref:`User profile information` section for more details about user profile information. #. Employee location restrictions. Refer :ref:`User/user group location restrictions` section for more details #. Start export button Refer :ref:`Select export location` for more details. #. Close button .. _Ref178940868: Delete all group employees """""""""""""""""""""""""""""""""""""""""""""""""""""""" Delete all group employees from the employee group as well as the system. .. _Ref178940876: Restore deleted group employees """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""" This option allows to restore deleted employees to the group. Restore deleted employee dialog is shown below. .. figure:: Images/chapter_control_panel/image255.PNG :width: 421 :figclass: align-center Restore deleted employees dialog #. Restoring options #. Recover all employees Restore all previously deleted employees. #. Deleted after Restore deleted employees after specified date. #. Recover button Start restoring employees to the group. #. Cancel button .. note:: Please note that once restored users, user details will be available. Past employee details such as event logs, enrolled biometrics, etc. will not be restored. .. _Ref178940892: .. _tooltip_control_panel_user_group_group_admin_title: Group admins """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_control_panel_user_group_group_admin_desc: Group admins have permission to manage the employee group. There are two types of group admins. #. Group admin Group admin has full permission to do changes to the group such as add/remove employees, import /export data etc. #. Group admin auditor Group admin allows to review the employee group such as export data, generate registration token etc. Group admin is not allowed to make any changes to the group. Group admin may have group manger permission. Group admins who have group manager permission can approve restricted leaves of the employees in the group (Refer section for more information). There can be only one group manager for the employee group. Selecting a different manager will be caused to remove previously selected group manager. Select group admin dialog is shown below. .. note:: Group admins are not available for the All users group .. figure:: Images/chapter_control_panel/image257.PNG :width: 405 :figclass: align-center \ Select group admin dialog #. Search field Search employee by name or employee code #. Employee list A :ref:`Data table` represent the list of employees in the groups. Select checkbox before the employee code to select employees to be group admins. A selected group admin can assign group manager by select manager checkbox. The permission can be assigned as follows. #. Read write Assign full permission to group admins to manager employee group. #. Read only Assign read only permission for group admin auditors. #. Save button #. Close button .. _Ref178940899: User group specific settings """""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image259.PNG :width: 541 :figclass: align-center Group specific settings view #. :ref:`Maximum occupancy for group premises` .. _Ref43201989: Maximum occupancy for group premises ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' Administrator/user group administrator allows the limit the number of employees/users of the user group on the premises. To limit users, enable this setting and add the number of allowed users. The users who are entitled to the user group as the primary user group will be counted 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. .. _Ref178940904: Delete employee group """"""""""""""""""""""""""""""""""""""""""""""""""" Delete employee group from the system. This deletes employee groups and employees will remain in the system. .. _Ref178940292: Employees +++++++++++++++++++++++++++++++++++++++++++++++++ All employees added to the employee group can be seen in this view. All employees are showing in a :ref:`Data table` as below. .. figure:: Images/chapter_control_panel/image261.PNG :width: 461 :figclass: align-center Employees of employee group view .. _Ref178940297: Devices +++++++++++++++++++++++++++++++++++++++++++++++ The devices view is showing all NCheck client applications registered with the employee group as follows. .. figure:: Images/chapter_control_panel/image216.PNG :width: 390 :figclass: align-center Employee devices view #. Name of the registered device #. Unregister button Unregister client application registered to the employee. Once unregistered, the client cannot be used to record employee attendance until it is registered again. .. _Ref178940302: Locations +++++++++++++++++++++++++++++++++++++++++++++++++ This option allows to restrict group employees to specific locations. Refer :ref:`Location restrictions` section for more information about adding location restriction for the selected employe group. .. _Ref178940306: Admins ++++++++++++++++++++++++++++++++++++++++++++++ Employee group admins are shown here. .. figure:: Images/chapter_control_panel/image263.PNG :width: 371 :figclass: align-center Group admins view #. Name Group admin name #. Options Remove button to remove group admins from the employee group. .. _Ref31022807: .. _Ref180570695: .. _tooltip_manage_shifts_and_rosters_title: Manage schedule and shifts ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _tooltip_manage_shifts_and_rosters_desc: Schedule and shift can be used to manage attendance and visitor activities in the organization. When it comes to attendance operations, schedule and shifts can be used to manage employee work hours during the working period. By default, NCheck has 24 hours shift and 7 days schedule. In visitor management, schedules can be used to manage visitor attendance based on the use cases. The schedule and shift view can be switched as either bio attendance or visitor management as mentioned in :ref:`Bio attendance and visitor mode selection` section Schedule and shift for bio attendance view is shown below. .. figure:: Images/chapter_control_panel/image265.PNG :width: 591 :figclass: align-center Schedule and shift view for bio attendance #. Schedule and shift tabs Switch between following views #. Shift management view Refer :ref:`Shift management` section for more details. #. Schedule management view Refer :ref:`Schedule management` section for more details. #. Selected tab content .. _Ref182258902: Shift --------------------------------------------- Shift is used to define the following #. Shift start and end #. Check in start and end #. Check out start and check out end Shift defines the work time and by means of the start of the shift and end of the shift. Users can check in after the start of the shift and check out at the end of the shift. Allowed time for check in and check out can be also configured. Allowed check in time can be configured by means of check in start and check in end. Similarly Allowed check out time also can be configured by means of check out start and check out end. .. figure:: Images/chapter_control_panel/image267.PNG :width: 602 :figclass: align-center Check-in and check-out events recording in the shift Default shift is a system defined shift which will be used for attendance tracking if there is no scheduled shift. Refer :ref:`Shift management` section for more details about shift management. .. _Ref180568642: Shift management -------------------------------------------------------- The shift management view is shown below. .. figure:: Images/chapter_control_panel/image269.PNG :width: 668 :figclass: align-center Shift management view #. Create shift button #. Import button Import shift as mentioned in :ref:`Import shifts` section. #. A :ref:`Data table` shows all available shifts. Each shift :ref:`Quick access menu` is showing following options. #. Edit Edit selected shift as mentioned in section. #. Actions menu Action menu appears with following options for selected shifts from the :ref:`Data table` . #. Export shift data Refer :ref:`Export shifts` section for more details. #. Delete shifts Delete all selected shifts. #. Number of selected shifts from the :ref:`Data table` . .. _Ref181282241: Add/edit shift ++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image271.PNG :width: 668 :figclass: align-center Add/edit shift dialog #. Shift stepper #. :ref:`Shift details view` #. :ref:`Additional shift settings` #. Selected stepper view #. Next/save button .. _Ref179299183: .. _tooltip_control_panel_shift_add_title: Shift details view """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image273.PNG :width: 524 :figclass: align-center Shift detail view #. Shift color This color is using in the UI to identify the shift from other shift in the access schedule, #. Shift name #. Description #. :ref:`Shift time view` #. :ref:`Break time view` .. _Ref183008987: Shift time view """"""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image275.PNG :width: 539 :figclass: align-center Shift time view #. Shift start time Shift start in hours and minutes. Default shifts start time 00:00 hours. You allow to select between 00:00 hours and 24:00 hours. #. Duration hours Shift duration in hours and minutes. Default value is 24 hours. The shift end can be a value between 00:00 hours and 7 days. #. Shift end Shift end in hours and minutes #. Duration in days, hours, and minutes #. Work hours .. _Ref183009884: Break time view """"""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image277.PNG :width: 526 :figclass: align-center #. Add break time button Add new break time to the shift as mentioned in :ref:`Add/edit break time` section. #. Beak time list view .. _Ref183009911: Add/edit break time """"""""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image278.PNG :width: 435 :figclass: align-center Add/edit break time dialog #. Break name #. Break start time Break start time in hours and minutes. #. Break end time Break end time in hours minutes and seconds. #. Duration hours Break duration in minutes and seconds. #. OK button .. _Ref179299194: Additional shift settings +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image280.PNG :width: 470 :figclass: align-center Additional shift settings view #. Restrict check-in in the below interval Refer :ref:`Check-in restriction` section for more details. #. Restrict check-out in the below interval Refer :ref:`Check-out restriction` section for more details #. Restrict overtime hours Refer :ref:`Overtime restrictions` section for more details #. Maximum OT hours allowed Refer :ref:`Max OT hours` section for more details #. Apply this change to the shift to old event lo .. _Ref179295529: Check-in restriction """""""""""""""""""""""""""""""""""""""""""""""""" Restrict user check-ins before and after the shift starts. .. figure:: Images/chapter_control_panel/image282.PNG :width: 539 :figclass: align-center Check-in restriction view #. Check-in start Number of hours restrict check-ins before shift start. The default value is Minimum (Shift end -24 hours, Shift start). Check-in start hours could be between shift start and (shift start -24 hours). #. Check-in end Number of hours restrict check-in after shift start. The default value is shift end. Check-in end could be between shift end and 7 days. .. _Ref179295534: Check-out restriction """"""""""""""""""""""""""""""""""""""""""""""""""" Restrict user check-outs before and after the shift ends. .. figure:: Images/chapter_control_panel/image284.PNG :width: 611 :figclass: align-center Check-out restriction view #. Check-out start Number of hours restrict check-out before the shift end. The default value equals to shift start. Check-out start restriction could be a value between (shift start - 24 hours) and 7 days. #. Check-out end Number of hours restrict check-out after the shift end. The default value is minimum (shift start + 24 hours, shift end). Check-out end restriction could be a value between 0 hours and 7 days. .. _Ref179295542: Overtime restrictions """"""""""""""""""""""""""""""""""""""""""""""""""" Overtime hours allowed after the shift ends. .. figure:: Images/chapter_control_panel/image286.PNG :width: 590 :figclass: align-center Overtime restriction view #. Overtime start Overtime starts hours from the shift end. The default value is 0. Overtime start could be a value between 0 and overtime end. #. Over time end Overtime end hours from the shift end. The default value is 0. Overtime end could be a value between 0 and 7 days. .. _Ref179295548: Max OT hours """""""""""""""""""""""""""""""""""""""""" Maximum overtime hours allowed. .. _Ref179296625: Import shifts +++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image288.PNG :width: 447 :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. .. _Ref179296644: Export shifts +++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image290.PNG :width: 502 :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. .. _Ref181629563: .. _tooltip_control_panel_rosters_title: Schedule ------------------------------------------------------------------------------------------ .. _tooltip_control_panel_rosters_desc: A schedule is a list of shifts assigned to each user or user group over a specific period. Refer :ref:`Schedule management` section for more information about managing employee and visitor schedules. .. _Ref180568733: Schedule management ----------------------------------------------------------- Schedule management view is shown below. .. figure:: Images/chapter_control_panel/image292.PNG :width: 561 :figclass: align-center Roster management view #. Create schedule button Create new bio attendance or visitor schedules. #. Refer :ref:`Add/edit bio attendance schedule` section for more details about creating bio attendance schedules #. Refer :ref:`Add/edit visitor schedules` section for more details about creating visitor schedules. #. Import button Import schedules. Refer :ref:`Import schedules` section for more details. #. Schedules view Schedules view is showing list schedules as shown in :numref:`Ref179298807` . .. _Ref179298807: .. figure:: Images/chapter_control_panel/image294.PNG :width: 446 :figclass: align-center Schedule view #. Schedule details A schedule summery. Refer section for more information about schedule information. #. Schedule options menu #. Edit Edit bio attendance or visitor schedule. #. Refer :ref:`Add/edit bio attendance schedule` section for more details about creating bio attendance schedules #. Refer :ref:`Add/edit visitor schedules` section for more details about creating visitor schedules. #. Delete Delete the schedule. #. Export data Export schedule data as mentioned in :ref:`Export schedule` section. #. Access schedule Refer :ref:`Access schedule` section for more details. .. _Ref179300169: .. _tooltip_control_panel_rosters_add_title: Add/edit bio attendance schedule ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_control_panel_rosters_add_desc: Add/edit schedule dialog is shown below. .. figure:: Images/chapter_control_panel/image296.PNG :width: 385 :figclass: align-center Add/edit schedule dialog #. Schedule stepper #. :ref:`Schedule detail view` #. :ref:`Add group or employees` #. Selected stepper view #. Next/save button .. _Ref179300025: Schedule detail view """""""""""""""""""""""""""""""""""""""""""""""""" Schedule detail view is shown below. .. figure:: Images/chapter_control_panel/image298.PNG :width: 430 :figclass: align-center Schedule detail view #. Schedule 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. .. _Ref179300032: .. _Ref179304745: Add group or employees view """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Add group or employees view is shown below. .. figure:: Images/chapter_control_panel/image300.PNG :width: 361 :figclass: align-center Add group or schedules view #. Select groups Select employee groups to add to the schedule from available. #. Select users Select employees to add for the schedule. .. note:: Add group or employees view is available when adding schedule only. .. _Ref180575933: Add/edit visitor schedules ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Add/edit visitor schedules involves two steps #. Select scenario #. Schedule details Select scenario """""""""""""""""""""""" Select scenario from the available scenario list in the scenario selection dialog as below. .. figure:: Images/chapter_control_panel/image302.PNG :width: 277 :figclass: align-center Select scenario view #. Scenario list #. Next button Select next button to enter the schedule details as mentioned in :ref:`Schedule details` section. #. Close button .. note:: Once the schedule is created the scenario cannot be changed .. _Ref180576438: Schedule details """""""""""""""""""""""""""""""""""""""""""""" Schedule details dialog is shown below. .. figure:: Images/chapter_control_panel/image304.PNG :width: 524 :figclass: align-center Schedule details dialog #. Schedule detail stepper Schedule detail stepper contains following sections. #. :ref:`Schedule detail view` #. :ref:`Payment detail view` #. :ref:`Booking configuration` #. :ref:`Visitor detail form builder` #. :ref:`Ticket parameters` #. :ref:`Additional settings` #. Schedule detail view Detail view for each section in the schedule detail stepper. #. Back and Next button Stepper back and next navigation #. Close button .. _Ref180583629: Schedule detail view '''''''''''''''''''''''''''''''''''''''''''''''''' Enter primary details of the schedule in the schedule detail view. Schedule detail view is shown below. .. figure:: Images/chapter_control_panel/image306.PNG :width: 250 :figclass: align-center Schedule detail view #. Schedule name Schedule name is a mandatory field. #. Schedule description #. :ref:`Slot time` #. :ref:`Slot occupancy` #. :ref:`Online booking` #. :ref:`Allow changing appointment time` #. :ref:`Reservation time out` .. _Ref180583636: .. _Ref179300604: Payment detail view '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' Configure payment and pricing details. Payment detail view is shown below .. figure:: Images/chapter_control_panel/image308.PNG :width: 289 :figclass: align-center Payment detail view #. Allow payments If the allow payments setting is disabled, visitors can create appointments without payment. #. :ref:`Payment gateway configuration` #. Currency configuration The currency that should be used for the payment can be configured here. The default currency is USD #. :ref:`Pricing configuration` .. _Ref180580929: Payment gateway configuration ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' Payment gateway configuration allows to configure payment gateway(s) for the schedule. If “Configure payment gateway” setting is disabled, the payment is considered as manual payment so that visitor can pay to the person in charge (Ex: Cashier). Any payment gateway can be configured upon the customer request. The payment gateway configuration view is shown below. .. figure:: Images/chapter_control_panel/image310.PNG :width: 619 :figclass: align-center Payment gateway configuration view #. Configure payment gateway setting Enable/disable payment gateways for the schedule. If the setting is disabled, the payment will be a manual payment so the visitor who create appointment should pay to the person in charge (Ex: cashier). #. Available payment gateways Select the payment gateway to configure. The selected payment gateway is shown in blue color. #. Payment gateway configuration Relevant parameters for the selected payment gateway should be provided here. As an example, for PayPal payment gateway, the configurations are client ID and client secret. #. Save change button This button will be appeared if the valid configurations are provided. Once select the save changes, the payment gateway will be shown with the check icon as shown in :numref:`Ref180580508` . #. Remove selected payment gateway configuration .. _Ref180580508: .. figure:: Images/chapter_control_panel/image312.PNG :width: 143 :figclass: align-center Checkbox appeared for the payment gateway once configured .. _Ref180580945: Pricing configuration ''''''''''''''''''''''''''''''''''''''''''''''''''' The pricing details are for charge from the visitor. This section can be changed according to the customer requirements .. figure:: Images/chapter_control_panel/image314.PNG :width: 387 :figclass: align-center Pricing configuration view #. Pricing details The amount should be charge from the visitor on appointment creation #. Add seating group button Add new seating group. #. Seating group view Pricing detail can be changed depending on the use case. By default, a basic detail view is shown with the following details. #. Name #. Capacity Number of seats allows for the group. #. Number of seats in a row This parameter is used to generate seating view as rows. #. Price Price per seat .. _Ref180583644: Booking configuration ''''''''''''''''''''''''''''''''''''''''''''''''''' The booking configuration view is shown below. .. figure:: Images/chapter_control_panel/image316.PNG :width: 405 :figclass: align-center Booking configuration view #. :ref:`Period` #. :ref:`Booking open` #. :ref:`Booking close` .. _Ref116478757: .. _tooltip_control_panel_schedules_and_locations_visitor_booking_period_title: Period ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' .. _tooltip_control_panel_schedules_and_locations_visitor_booking_period_desc: Normally the booking time for an appointment is in a single day. But some tasks like a class, seminar etc. span for several days period they can be defined with no of days, weeks, or months. The period view has shown below. .. figure:: Images/chapter_control_panel/image318.PNG :width: 191 :figclass: align-center Period configuration view #. Value #. Period type #. Days #. Weeks #. Months #. Schedule end Period will end on schedule end date if schedule date has specified. .. _Ref180582019: .. _tooltip_control_panel_schedules_and_locations_visitor_booking_booking_open_title: Booking open ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' .. _tooltip_control_panel_schedules_and_locations_visitor_booking_booking_open_desc: Booking starts before n days restricts booking appointments before that time. Booking open configuration view has the following options. .. figure:: Images/chapter_control_panel/image320.PNG :width: 154 :figclass: align-center Booking open configuration view #. Always If single appointment, booking opens when schedule start. Otherwise, on period start. #. Before If single appointment, booking opens for specified number of days before schedule start. Otherwise, the number of specified days before period start. .. _Ref180582023: .. _tooltip_control_panel_schedules_and_locations_visitor_booking_booking_close_title: Booking close ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' .. _tooltip_control_panel_schedules_and_locations_visitor_booking_booking_close_desc: Booking close setting allows to book appointments after starting to book period. Booking close configuration is shown below. .. figure:: Images/chapter_control_panel/image322.PNG :width: 221 :figclass: align-center Booking close configuration view #. No closing No closing date. Can be booked booking open date to schedule ends if 1 day period schedule. Otherwise booking open day to period closing date #. After Minus day(s) to specify number of days booking close before schedule start if 1 day schedule. Otherwise, minus and plus day(s) to specify number of days booking close before period start and after period start. .. _Ref180583652: Visitor detail form builder ''''''''''''''''''''''''''''''''''''''''''''''''''''''''' Visitor detail forms are used to collect visitor details when booking appointments for the schedule. This section allows to create a visitor form for the schedule by drag and drop form fields from existing fields. By default, schedule have default visitor form fields inherit from the scenario. .. figure:: Images/chapter_control_panel/image324.PNG :width: 460 :figclass: align-center Visitor detail form builder view #. Form fields By default following form fields are available. Depending on the customer requirement, custom fields can be added. #. Name #. Phone #. Email #. Address #. Age #. ID #. City #. To Meet #. Reason #. Amount #. Account number #. :ref:`Form field view` .. _Ref180582814: Form field view ''''''''''''''''''''''''''''''''''''''''''''' Visitor form for the schedule. Visitor form can be populated, dropping fields from the form fields. .. figure:: Images/chapter_control_panel/image326.PNG :width: 329 :figclass: align-center Visitor form field view #. Field name #. Field input #. Field configuration Field configuration allows the behavior of the form fields to change. For example, field is required or not, minimum, and maximum validation of a number input. #. Remove button Remove the field from the field. .. _Ref181628891: Ticket printing view '''''''''''''''''''''''''''''''''''''''''''''''''' Print the ticket once an appointment is created. Ticket printing view is shown below. .. figure:: Images/chapter_control_panel/image328.PNG :width: 446 :figclass: align-center Ticket print view #. URL Path of the external executable file (exe or bat) in the windows registration device or API URL #. :ref:`Ticket parameters` .. _Ref180583230: Ticket parameters ''''''''''''''''''''''''''''''''''''''''''''''' Select parameters from the available to pass to the external executable. By default, the following parameters are available. Custom parameters can be introduced based on the requirements. .. list-table:: :widths: 3006 3005 3005 * - Parameter - Single appointment schedule - Session appointment schedule * - Schedule name - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Pass code - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - First name - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Last name - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Appointment start time - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center * - Appointment end time - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center * - Period start date - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Period end date - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center .. note:: Exe and bat files can be executed in windows registration devices only. .. _Ref180583675: Additional settings ''''''''''''''''''''''''''''''''''''''''''''''''' An additional settings view is shown below. .. figure:: Images/chapter_control_panel/image330.PNG :width: 438 :figclass: align-center Additional settings view #. :ref:`Automatic approval of visit requests` #. :ref:`Biometric collection` #. :ref:`Pass type` #. :ref:`Visitor pass generation` #. :ref:`Custom visitor feedback view` Export schedule ++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image332.PNG :width: 529 :figclass: align-center Export rosters view Roster information can be exported as a password protected zip file as follows. #. Select data from the list for export #. :ref:`Rosters information` #. :ref:`Roster items information` #. Select the Start Export button to select the export location Refer the :ref:`Import and Export information` section for more details. .. _Ref179304603: Import schedules ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image334.PNG :width: 476 :figclass: align-center Import rosters view Roster information can be imported as mentioned in :ref:`Import and Export information` section. To 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. .. _Ref179304650: Access schedule ------------------------------------------------------- The access schedule option allows to manage schedule items of each day for visitors and employees. Once shifts and schedules are created, the schedule items should be added for the working days to record attendance for the shift and schedule. Schedule view is shown below. .. figure:: Images/chapter_control_panel/image336.PNG :width: 668 :figclass: align-center Access schedule view for bio attendance .. figure:: Images/chapter_control_panel/image338.PNG :width: 599 :figclass: align-center #. :ref:`Access schedule filter view` #. More actions menu #. :ref:`Add/edit schedule item` #. Repetition selector #. Schedule items view Schedule items for all employee groups and employees added to the schedule for selected week from the repetition selector. Refer :ref:`Schedule items view` section for more information. #. Add more users button Update employee groups and employees in the schedule. Refer :ref:`Add group or employees view` section for more information. .. _Ref179304762: Access schedule filter view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Access schedule filter view is shown below. .. figure:: Images/chapter_control_panel/image339.PNG :width: 450 :figclass: align-center Access schedule filter view #. Calendar view Select date range to retrieve employee groups and employees with schedule items. #. Group selector Select employee groups from the list. #. Shift selector Select shift from the list .. note:: Group filer is not available in access schedule view for visitor management .. _Ref179304717: .. _tooltip_control_panel_add_roster_items_title: Add/edit schedule item +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_control_panel_add_roster_items_desc: Schedule item is a combination of a employee group/employee with a shift for selected date, which represents how employees should be worked during the day. Add schedule item dialog is shown below. .. figure:: Images/chapter_control_panel/image341.PNG :width: 483 :figclass: align-center Add schedule item dialog #. Shift Select shift from available. #. Location Refer :ref:`Manage Locations` section for more details about locations. #. Employee/employee group #. Start date #. End date If no end date is selected, schedule items will be created infinitely. #. Save button Add new schedule item or save changes for the existing schedule item. #. Close button .. note:: Schedule items for bio attendance are added to the selected user or user group from the access schedule view. Therefore, user or user group of the adding schedule item is pre-selected and cannot be edited in bio attendance. .. _Ref179304792: Schedule items view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image343.PNG :width: 668 :figclass: align-center Schedule items view #. Employee groups/employees added to the schedule This column is unavailable in access schedules for visitor management. #. Days for the selected week Each table cell for a day and the employee group/employee represent schedules item(s) for the employee group/employee for the day. You can add schedule item for each cell using the add button that appears in the bottom right corner when hovering on the table cell. A table cell view is shown below. .. figure:: Images/chapter_control_panel/image345.PNG :width: 226 :figclass: align-center table cell view #. :ref:`Schedule item view` #. Add button. Add schedule item for the relevant employee group/employee and the day. Refer :ref:`Add schedule item` section for more details. .. _Ref179304841: Schedule item view """""""""""""""""""""""""""""""""""""""""""""""" Schedule item view bio attendances and visitor management are shown below. .. figure:: Images/chapter_control_panel/image347.PNG :width: 293 :figclass: align-center Schedule item view for bio attendance .. figure:: Images/chapter_control_panel/image349.PNG :width: 313 :figclass: align-center Schedule item view for visitor management #. Details of the schedule item The details are shown as below #. Visitor management Shift start and end date with the shift name and location name are showing #. Bio attendance Shift start and end time with the day are showing. #. Menu button #. Edit Edit schedule item. Refer :ref:`Add/edit schedule item` section for more information. #. Booking info This option is available for schedule item in visitor management. Refer :ref:`Booking info` section for more information/ #. Copy to Create same schedule item instance for other selected dates in the schedule. Refer :ref:`Copy schedule item` section for details. #. Delete Delete schedule item. .. _Ref179304892: Copy schedule item """""""""""""""""""""""""""""""""""""""""""""""" Copy schedule item dialog is shown below. .. figure:: Images/chapter_control_panel/image351.PNG :width: 425 :figclass: align-center Copy schedule item dialog #. Repetition weeks #. Selected date to copy the schedule item #. Copy button Copy schedule item for the selected date. .. _Ref180590676: Booking info '''''''''''''''''''''''''''''''''''''''''' The appointment details of each schedule item in visitor management can be seen from booking info. Booking info dialog is shown below. .. figure:: Images/chapter_control_panel/image353.PNG :width: 668 :figclass: align-center Booking info dialog #. Name of the schedule #. Name of the shift using in the selected schedule item1 #. Total number of appointments added to the schedule item #. Day number #. Appointment information .. _Ref180589067: Manage Locations ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Visit location is the place where the visitor visits for the purpose of visit. By default, NCheck has default location. .. note:: The default location is the system generated location. It is not allowed to change or delete. The location management view is shown below. .. figure:: Images/chapter_control_panel/image355.PNG :width: 668 :figclass: align-center Location management view #. Add location button Add new location. Refer :ref:`Add/edit location` section for more information. #. Import button Import location(s) to the system. Refer :ref:`Import location data` for more details. #. Location list view A :ref:`Data table` represent list of locations. Selected location information can be seen in location view. The employee group :ref:`Quick access menu` is showing following options. #. Edit Edit selected location. Refer :ref:`Add/edit location` section for more information #. Delete The :ref:`Actions view` of the selected locations shows the following options. #. Export data Refer :ref:`Export location data` section for more details. #. Search field Search locations in the location list from location name or description. .. _Ref179877529: Add/edit location --------------------------------------------------------- Add edit location dialog is shown below. .. figure:: Images/chapter_control_panel/image357.PNG :width: 561 :figclass: align-center Add edit location dialog #. Name Name of the location #. Description Description for the location #. Time zone Time zone of the location. The default time zone is browser time zone. #. Set GPS coordinates Select this option if the location have longitude and latitudes. This coordination will be used as fallback location for attendance. After enable the view will be extended as shown below. #. Latitude #. Longitude #. Select the location from the map You can configure map from :ref:`Web interface settings view` section to select to select GPS coordinates form the map as showing below. #. Map view #. Map marker Selected location will be pointed with this marker. .. figure:: Images/chapter_control_panel/image359.PNG :width: 383 :figclass: align-center .. _Ref179876367: .. figure:: Images/chapter_control_panel/image360.PNG :width: 433 :figclass: align-center GPS coordinate view in add/edit location dialog .. _Ref179877643: Import location data ------------------------------------------------------------ The import locations to the system are as a zip file. Refer :ref:`Import and Export information` section for more details for importing file structure. The import location data dialog is shown below. .. figure:: Images/chapter_control_panel/image362.PNG :width: 469 :figclass: align-center Import location data dialog Select the Import button to select the import location. Refer :ref:`Select import location` section for more details about selecting import location. .. _Ref179877499: Export location data ------------------------------------------------------------ Export selected location information as a zip file. Refer :ref:`Import and Export information` section for more details for importing file structure. Export location data dialog is shown below. .. figure:: Images/chapter_control_panel/image364.PNG :width: 503 :figclass: align-center Export location data dialog Select start export button to select export location as mentioned in :ref:`Select export location` section. Location view -------------------------------- The selected location information can be seen from the view. .. figure:: Images/chapter_control_panel/image366.PNG :width: 353 :figclass: align-center Location view #. Tabs view #. Location details #. Access locations #. Selected tab content Location details +++++++++++++++++++++++++++++++++++ Location detail’s view contains following operations. #. Edit button Edit location as mentioned in :ref:`Add/edit location` section. #. Register device button #. Delete button Delete location from the system. Register device for location """"""""""""""""""""""""""""""""""""" A device can be registered to a location so that the visitors who have appointments for the specific location can be used to record their attendances. The device registration dialog for location is shown below. .. figure:: Images/chapter_control_panel/image368.PNG :width: 573 :figclass: align-center #. The select location name and description to generate the registration token. #. Generate button To generate the registration token. The :ref:`Registration token view` will be shown once the token generated. #. Links to download clients. #. Close button Access locations +++++++++++++++++++++++++++++++++++ By default, a visitor is allowed to access the appointment location. If the location cannot access directly and visitor must pass additional doors or gates, those places also should be allowed to access. Such locations can be added as access locations for the location. The access location view is showing a list of access locations added to the “Main office” location. .. figure:: Images/chapter_control_panel/image369.PNG :width: 502 :figclass: align-center Access location dialog #. Access location list A :ref:`Data table` represent a list of access locations. The access location can be deleted from the Delete options. #. Update button Update access location list. Refer :ref:`Update access location` section for more information. .. _Ref179881229: Update access location """""""""""""""""""""""""""""""""""""""""""""""""""" The access locations for the selected location can be added/removed from the select location dialog as below. .. figure:: Images/chapter_control_panel/image371.PNG :width: 518 :figclass: align-center Select location dialog #. Add new button Add new location as mentioned in :ref:`Add/edit location` section. #. List of location. A :ref:`Data table` represent list of locations. Use select options to select locations to be updated as access locations. Unselect locations to be removed from the access location list. #. Update button Update selected locations as access locations. #. Cancel button. .. _Ref182302381: Manage appointments ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Visitor appointment is a request from the visitor for the visit with specific date and time as defined for the visit schedule. Appointments management is allowing to manage all visitor appointments, .. figure:: Images/chapter_control_panel/image373.PNG :width: 626 :figclass: align-center Appointments view #. New appointment button Create new appointment as mentioned in :ref:`New appointment` section. #. Advanced menu #. :ref:`Import data` #. :ref:`Export data` #. Refresh appointment Refresh appointments #. :ref:`Appointment filter view` #. Appointments list A :ref:`Data table` shows list of appointments. .. _Ref115448909: Import data --------------------------------------------------- .. figure:: Images/chapter_control_panel/image375.PNG :width: 544 :figclass: align-center Import appointments data dialog Select appointments checkbox to import appointments. Once select Start Import button, it will show import data dialog to select import file location as mentioned in :ref:`Select import location` section. .. _Ref115448913: Export data --------------------------------------------------- .. figure:: Images/chapter_control_panel/image377.PNG :width: 586 :figclass: align-center Export appointments data dialog Select appointments to export all appointments. Once select Start Export button, it will show export data dialog to select export location as mentioned in :ref:`Select export location` section. .. _Ref108195416: New appointment ------------------------------------------------------- To book an appointment, #. :ref:`Select visit schedule` #. :ref:`Add/edit appointment detail` .. _Ref108195461: Select visit schedule +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image379.PNG :width: 669 :figclass: align-center Visit schedule date selection dialog #. :ref:`Schedule item filter view` #. :ref:`Schedule item list view` #. Close button .. _Ref108447016: Schedule item filter view """"""""""""""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image381.PNG :width: 538 :figclass: align-center Schedule item filter view #. Schedule Schedule name #. From Schedule items start date #. To Schedule items end date #. Search button Filter schedule items according to the selected filters .. _Ref108447009: Schedule item list view """"""""""""""""""""""""""""""""""""""""""""""""""""" Schedule item is an instance of the schedule for specific date. Schedule item list view is shown below. .. figure:: Images/chapter_control_panel/image383.PNG :width: 585 :figclass: align-center Schedule item list view #. :ref:`Schedule view` #. Schedule items paging .. _Ref108195467: Add/edit appointment detail +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image385.PNG :width: 582 :figclass: align-center Appointment detail view #. :ref:`Schedule quick view` #. Appointment start time If the :ref:`Slot time` is 0, the default appointment start time is schedule start time. If the :ref:`Slot time` is greater than 0, the default appointment start time is default slot start time. Default appointment start time allows to change between schedule ( :ref:`Slot time` = 0)/slot ( :ref:`Slot time` >0) start time and appointment end time. #. Appointment end time If the :ref:`Slot time` is 0, the default appointment end time is schedule end time. If the :ref:`Slot time` is greater than 0, the default appointment end time is default slot end time. Default appointment start time allow to change between appointment start and schedule ( :ref:`Slot time` = 0)/slot ( :ref:`Slot time` >0) end time. #. Break time view #. Time slot view Refer :ref:`Time slots` section for more details. #. :ref:`Visitor form` #. Back button Open :ref:`Select visit schedule` view. This button is not available when editing an appointment. #. Create/Save changes button When add appointment, create the appointment with the selected details. When editing an appointment, save changes with the given details. #. Close button .. _Ref108195435: Appointment filter view --------------------------------------------------------------- .. figure:: Images/chapter_control_panel/image387.PNG :width: 501 :figclass: align-center Appointment filter view #. Visitor name First and last name of the visitor #. Schedule Name of the schedule #. From Appointments start date #. To Appointment end date .. _Ref108195443: Appointment table --------------------------------------------------------- .. figure:: Images/chapter_control_panel/image389.PNG :width: 530 :figclass: align-center Appointment table view #. Visitor First name and last name of the visitor #. Schedule Name of the schedule #. Appointment starts Date and time of the appointment start #. Appointment end Date and time of the appointment end #. :ref:`Table menu` .. _Ref108195452: Appointment overview ------------------------------------------------------------ #. :ref:`Appointment detail view` #. :ref:`Visitor details` .. _Ref108195491: .. _Ref182302370: Appointment detail view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image391.PNG :width: 389 :figclass: align-center Appointment detail view #. Schedule name #. :ref:`Appointment approval status` #. Schedule thumbnail #. Visitor first name and last name #. Appointment date #. Schedule start and end time #. Session details #. :ref:`Appointment completion status` #. Visit notes #. :ref:`Notify menu` #. :ref:`Appointment status menu` #. Edit appointment Refer :ref:`Add/edit appointment detail` section for more details. #. :ref:`Delete appointment` #. :ref:`Ticket` #. Session details Visit notes """""""""""""""""""" Visit notes are customizable templates that can be used to keep additional details to the appointment. Visit note may have maximum number of notes for each appointment as configured. By default, all scenarios consist of default visit note template “Comments” with unlimited notes for appointments. As per customer requirement, additional visit note template(s) can be introduced for each :ref:`Scenario` as an extension as mentioned in :ref:`Use extension` section Available templates of the scenario which is used to create appointment schedule will be listed for the selected appointment as follows. .. figure:: Images/chapter_control_panel/image393.PNG :width: 548 :figclass: align-center Visit notes #. Visit note templates list All available visit notes template for the scenario are listed here. A visit note template view is showing in :numref:`Ref111477923` . #. Visit note template name. #. Available visit notes for the templates The number of maximum visit notes for a visit note template can be defined if required. #. Add button Add new visit notes. Refer section for more details about edit comments visit note. #. Visit notes list Visit notes for selected visit note templates if available. Visit note view is shown in :numref:`Ref111477951` . #. Visit note name. #. Edit button Edit visit note. Refer section for more details about edit comments visit note. #. Delete button Delete visit note. .. _Ref111477951: .. figure:: Images/chapter_control_panel/image395.PNG :width: 301 :figclass: align-center Visit note view .. _Ref111477923: .. figure:: Images/chapter_control_panel/image397.PNG :width: 174 :figclass: align-center Visit note template view Add/edit comment note '''''''''''''''''''''''''''''' Visit note add/edit view has shown below. .. figure:: Images/chapter_control_panel/image399.PNG :width: 432 :figclass: align-center Add/edit visit note view #. Name of the comments note. #. Notes list view A comment note may have multiple notes as shown in :numref:`Ref119405423` . #. Name of the visit note #. Close button #. Submit button. Notes list view is shown below. .. _Ref119405423: .. figure:: Images/chapter_control_panel/image401.PNG :width: 493 :figclass: align-center Notes view of the Comments visit note #. Add note Add new note dialog will appear as shown in :numref:`Ref119406346` . #. Note view Note view is shown in :numref:`Ref119405609` . Note view is shown below. .. _Ref119405609: .. figure:: Images/chapter_control_panel/image403.PNG :width: 548 :figclass: align-center Note view #. Note description. #. Attachments of the note #. Edit button Edit note dialog will appear to edit the content of the note as shown in :numref:`Ref119406346` . #. Remove button Remove the note from the note list view. Add/edit note dialog for comment view note is shown below. .. _Ref119406346: .. figure:: Images/chapter_control_panel/image405.PNG :width: 479 :figclass: align-center Add/edit note view #. Note description. #. Note attachments Following parameters of the attachment can be configured in the Comments visit note template. #. Maximum number of attachments By default it is allowed to add 5 attachments. #. File types By default allows to attach JPEG, PNG, and PDF files. #. Cancel button. #. Add note button Add note to the comments. .. _Ref108458944: .. _tooltip_control_panel_appointments_notify_menu_title: Notify menu """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_control_panel_appointments_notify_menu_desc: The notify menu allows to send notifications such as appointment summery, welcome note and reminders for the selected appointment. The notification can be configured to the schedule as mentioned in the Appointment reminders section. From the notify menu the following notifications can be sent to the visitors. #. Appointment summery Send appointment summery for the visitor. Once select appointment summery, it will show the :ref:`Notifications` to send notification. #. Welcome note Send welcome note for the visitor. Once select a welcome note, it will show the Notification to send notification. #. Reminder Set reminder notification for visitor about the appointment start. Once select reminder, it will show the Notification to send notification. .. note:: To send notification, either email or SMS notification must be configured as mentioned in Notification section .. _Ref108453599: Appointment status menu """"""""""""""""""""""""""""""""""""""""""""""""""""" The appointment status menu has the following status types. #. :ref:`Appointment approval status` #. :ref:`Appointment completion status` .. _Ref108453609: .. _Ref108459218: Appointment approval status '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' Appointment approval has the following statuses. #. Approve Approve appointment if the appointment status is rejected or pending (If the :ref:`Automatic approval of visit requests` has disabled). #. Reject Reject the approval that the appointment cannot be used, .. _Ref108453616: .. _Ref108459210: Appointment completion status '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' Appointment completion has the following statuses. #. Set complete Complete appointment once the visitor completed the appointment. #. Set cancel Cancel appointment if the appointment is not in use. #. Set original state Set appointment to original state if the appointment is in use. .. _Ref108195517: Delete appointment """""""""""""""""""""""""""""""""""""""""""""""" The appointment will be deleted once select OK button from Delete appointment confirmation message. .. figure:: Images/chapter_control_panel/image407.PNG :width: 490 :figclass: align-center Confirmation dialog for delete appointment .. _Ref108195522: Ticket """""""""""""""""""""""""""""""""""" Once the appointment is created, the visitor pass(ticket). This can be used to identify visitors if the visitor biometric data is not available. Refer :ref:`Manage passes` section for more details about visitor pass. Session details """""""""""""""""""""""" If the selected appointment belongs to a session, created from the session schedule, all appointments belong to the session schedule are shown under the session details. The session details are shown below. .. figure:: Images/chapter_control_panel/image409.PNG :width: 587 :figclass: align-center Session details view #. New appointment button Create new appointments for the session in the same session schedule. #. Status button Following options are available. #. Set :ref:`Appointment approval status` for all appointments in the session. #. Set :ref:`Appointment completion status` for appointments in the session. #. :ref:`Session appointments table` .. _Ref135995536: Session appointments table '''''''''''''''''''''''''''''''''''''''''''''''''''''''' .. figure:: Images/chapter_control_panel/image411.PNG :width: 537 :figclass: align-center Session detail tables #. Appointment starts #. Appointment end #. Appointment status Appointment status as mentioned in :ref:`Appointment completion status` section. #. Request status Request status as mentioned in :ref:`Appointment approval status` section. #. Options Following option are available. #. Edit #. Delete #. Set :ref:`Appointment approval status` #. Set :ref:`Appointment completion status` #. :ref:`Table menu` #. :ref:`Table paging options` .. _Ref108195498: Visitor details +++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image413.PNG :width: 495 :figclass: align-center Visitor detail view #. First and last name of the visitor #. Visitor code A unique identification for the visitor #. Visitor profile image #. Email #. Phone #. Edit visitor Refer add/edit visitor section for more details. .. _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 web control panel allows to manage all employee leaves and holidays. The Leaves and holiday management view as follows. .. figure:: Images/chapter_control_panel/image415.PNG :width: 668 :figclass: align-center #. Leave and holiday tab Switch between leave management view and holiday management view. #. Selected tab content view Leave management view ---------------------------------------- Leave management view allows to manage employee leaves. Leave management view is shown below. .. figure:: Images/chapter_control_panel/image416.PNG :width: 668 :figclass: align-center Leave management view for larger screens .. figure:: Images/chapter_control_panel/image418.PNG :width: 453 :figclass: align-center Leave management view for small screens #. Leave filters view In smaller screen, click on more filer buttons to expand the leave filter view. Refer :ref:`Leave filter view` section for more details. #. Leave calendar view Refer :ref:`Leave calendar view` section for more details. #. List of leaves for the selected date from the calendar A :ref:`Data table` which shows list of leaves. Refer :ref:`Leave table` section for more details. #. Add leave button Refer :ref:`Add leave` section for more information. #. Actions menu Actions menu is showing following options. #. :ref:`Configure leave type` #. :ref:`Import leave data` #. :ref:`Export leave data` .. _Ref179921865: Leave filter view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Leave filter view shown below. .. figure:: Images/chapter_control_panel/image420.PNG :width: 422 :figclass: align-center Leave filter view #. Refresh view #. Employee search field Search employee by employee code or name. #. Employee group menu Select employee group(s). #. Only rejected leaves checkbox Check this option to retrieve only the rejected leaves. .. _Ref179921890: Leave calendar view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Leave calendar view is used to select the date to show the employee leaves. There are two calendar views in smaller screens(mobile) and larger screens. The detailed calendar view is available for larger screens as mentioned in :ref:`Calendar view` section. For smaller screens, the calendar popup view is showing. Detailed calendar view shown below. .. figure:: Images/chapter_control_panel/image422.PNG :width: 298 :figclass: align-center Detailed calendar view Each date of the calendar shows the number of leaves (Approved and requested leaves only). .. _Ref179921993: Leave table +++++++++++++++++++++++++++++++++++++++++++++++++++ A :ref:`Data table` represent list of employee leaves. All available leaves for the selected date are shown in the leave table as below. Please refer :ref:`Add leave` section for more details about leave table column. .. figure:: Images/chapter_control_panel/image424.PNG :width: 631 :figclass: align-center Leave table view In the location table, :ref:`Quick access menu` of each location are showing following options. #. Edit Edit location. Refer :ref:`Edit leave` section for more information #. Delete Delete location from the system. .. _Ref179960592: Leave approval status +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Once leave is added to a system, the leave approval status can be shown as below. #. Requested If the leave is in requested, it is considered as leave request. Requested leaves are not taken as leaves until it is approved by an admin. #. Rejected If a leave is rejected the status can be set as rejected. Rejected leaves cannot be taken by employees. #. Approved If the leave status is approved, the system is considering the leave as valid leave. .. note:: Employees are allowed to request leave. Once an employee requests a leave, any person who has an administrator role can approve or reject the leave. If an administrative add a leave, the leave type will be approved by default. .. _Ref179921825: Add leave +++++++++++++++++++++++++++++++++++++++++++++++++ Add/edit leave dialog is shown below. .. figure:: Images/chapter_control_panel/image426.PNG :width: 369 :figclass: align-center Add/edit leave dialog #. Leave type selection The default leave types are Casual, Medical and Annual. Administrator allows to add custom leave types as mentioned in 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 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, employee 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/edit button #. Close button .. _Ref179960654: Edit leave ++++++++++++++++++++++++++++++++++++++++++++++++++ The edit leave dialog is shown below. .. figure:: Images/chapter_control_panel/image428.PNG :width: 480 :figclass: align-center Edit leave dialog #. Name The name of the employee the leave has applied for. This field is not editable. #. Requested The leave requested period. These fields are not editable. #. Approved The approved period. #. Leave types The 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, employee will not be able to check-in or check-out while on leave. #. Request reason #. Approve/reject reason Reason for leave approval and rejection by the administrator. #. Approval status Leave approval status as Requested, rejected or approved. Refer :ref:`Leave approval status` section for more information about leave types. .. _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/chapter_control_panel/image430.PNG :width: 558 :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/chapter_control_panel/image432.PNG :width: 350 :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/chapter_control_panel/image434.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 leave data ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ This option allows to import leaves and holidays as mentioned in :ref:`Import and Export information` section. Tio import data, .. figure:: Images/chapter_control_panel/image436.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 leave data ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ This option allows export all leaves and holidays as password protected zip file as follows .. figure:: Images/chapter_control_panel/image438.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 Holiday management view ------------------------------------------ Holiday management view allows to manage holidays of the organization. Holiday management view is shown below. .. figure:: Images/chapter_control_panel/image440.PNG :width: 590 :figclass: align-center Holiday management view for larger screens .. figure:: Images/chapter_control_panel/image442.PNG :width: 463 :figclass: align-center Add holiday view for smaller screens #. :ref:`Holidays calendar view` #. List of holidays for selected date Refer :ref:`Holiday table` section for more details. #. Add holiday button Add new holiday. Refer :ref:`Add/edit holiday` section for more information. #. Actions menu .. _Ref179924171: Holidays calendar view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Holiday calendar view is used to select the date to retrieve available dates. There are two calendar views in smaller screens(mobile) and larger screens. The detailed calendar view is available for larger screens as mentioned in :ref:`Calendar view` section. For smaller screens, the calendar popup view is showing. Detailed calendar view shown below. .. figure:: Images/chapter_control_panel/image444.PNG :width: 335 :figclass: align-center Holiday calendar view Each date of the calendar shows available leaves. .. _Ref179924256: Holiday table +++++++++++++++++++++++++++++++++++++++++++++++++++++ A :ref:`Data table` represent list of holidays. All available holidays for the selected date are shown in leave table as below .. figure:: Images/chapter_control_panel/image446.PNG :width: 548 :figclass: align-center Leave table view In the holiday table, :ref:`Quick access menu` of each holiday are showing following options. #. Edit Edit holiday. Refer section for more information #. Delete Delete holiday from the system. .. _Ref179924202: Add/edit holiday ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ This allows to add a holiday for the selected date. Add/edit holiday dialog is shown below .. figure:: Images/chapter_control_panel/image448.PNG :width: 409 :figclass: align-center Add/edit holiday dialog #. Holiday type #. Normal holiday type #. Recurring holiday type #. Content of the selected holiday type #. Add button #. Close button Normal holiday type """""""""""""""""""""""""""" The normal holiday type is as follows. .. figure:: Images/chapter_control_panel/image450.PNG :width: 310 :figclass: align-center Add normal holiday view #. Date Holiday date #. Description Recurring holiday type """"""""""""""""""""""""""""""" The recurring holiday can be added as follows. .. figure:: Images/chapter_control_panel/image452.PNG :width: 318 :figclass: align-center Add recurring holiday view #. 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 appear 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 specifies the end date if required. #. Description .. _Ref38783246: .. _tooltip_control_panel_manage_devices _title: Manage devices ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _tooltip_control_panel_manage_devices _desc: Device management page allows managing all NCheck client devices and API registered with the NCheck NCheck server. The device management view is shown below. .. figure:: Images/chapter_control_panel/image454.PNG :width: 633 :figclass: align-center Device management view #. Device table A :ref:`Data table` represent list of devices and APIs. Selected device information can be seen in device view. The selected device information from the table is shown in device view. The employee group :ref:`Quick access menu` is showing following options #. Edit Refer :ref:`Edit device` / :ref:`Edit API` section for more information. #. Re-register Re-register client device. Re-register client option can be used to register the client application for the previously registered device in the server in case of application get deleted. For reregistration, registration token can be generated as mentioned in :ref:`Register device` section. #. Block/unblock Block/unblock device or API. Once blocked the client/API cannot be used with the system until it unblocked. #. Unregister Unregister client/API from the system. Once unregistered, the device/API no longer use with the server. #. Device search field Search device by device name #. Register device button Register device as mentioned in :ref:`Register device` section. #. API access button Refer :ref:`API Access` section form more details. .. _Ref180005241: Register device ------------------------------------------------------- NCheck clients should be registered with NCheck server to use for attendance recording. The client application can be installed in Android, Windows and IOS (Attend client only) devices in the following modes #. Register for employee Employees can install the client application in their personal device and register to record the personal attendance, check reports etc. #. Register for groups Register client application for employee groups. Once client application is registered to a group, any employee in the group can record their attendances using the device. #. Register for location Once client application registered for a location, any visitor who has appointments in the device location can be used the device to record their attendance. #. Register for group and location This is combination of register for groups and locations. #. Register for registration kiosk or overhead display Use the device either registration kiosk to create appointments for visitors or overhead display as mentioned in section. Employees or visitors are not allowed to record attendances in these devices. The register device dialog is shown below. .. figure:: Images/chapter_control_panel/image456.PNG :width: 402 :figclass: align-center Register device dialog Device registration has two steps to register device. #. :ref:`Registration type view` #. :ref:`Registration token view` .. _Ref179990284: .. _Ref182995180: Registration type view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image458.PNG :width: 526 :figclass: align-center Registration type view #. Registration type #. :ref:`Attendance device` #. :ref:`Registration kiosk` #. Selected registration type view This is where the view for selected registration type appears. .. _Ref182995208: Attendance device """"""""""""""""""""""""""""""""""""""""""""""" Generate registration token to record employee, visitor or both attendances. The attendance device registration view is shown below. .. figure:: Images/chapter_control_panel/image460.PNG :width: 348 :figclass: align-center Attendance device registration view #. Employee selection Select employees by name #. Employee group selection Select employee group by group name #. Location selection Select location by location name #. New location button Add new location and use the location to generate token. Refer :ref:`Add/edit location` section for more details about adding new location. .. _Ref179990494: .. _Ref182995215: Registration kiosk """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Generate registration token to register device for registration kiosk to create appointments for visitor or overhead display. The kiosk registration view is shown below. .. figure:: Images/chapter_control_panel/image462.PNG :width: 331 :figclass: align-center Kiosk registration view #. Kiosk page type #. :ref:`Internal page` #. :ref:`External page` #. Selected kiosk type view This is where the view of selected kiosk type is showing .. _Ref179989776: .. _Ref182995264: Internal page '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' The pages available for attendance management and visitor management to use as either a registration kiosk or overhead display. Any page can be added to the system depending on the use case. Refer section for more details about adding pages to the system. If configuration requires, the configure button is available next to the page selection control. .. figure:: Images/chapter_control_panel/image464.PNG :width: 478 :figclass: align-center internal page view #. Page The default pages are #. Default employee overhead display The overhead display for employees with attendance details. #. Common booking page Users can select schedule from the available and create appointments. #. Login page This shows NCheck login page so employees can login to the system using their credentials and use web control panel. #. Schedule booking page Open specific schedule from available so that the user can create appointment. Use the configure button to select the schedule that needs to be open with this page in the device. #. Overhead display for schedule Open specific schedule which showing the current in progress appointment number. Use the configure button to select the schedule to be displayed. #. Overhead display for multiple schedule Show all schedules with the current appointment details in progress. .. _Ref179989796: External page '''''''''''''''''''''''''''''''''''''''''''' The external page options can be used to show any third-party URL. .. figure:: Images/chapter_control_panel/image466.PNG :width: 299 :figclass: align-center External page view #. URL The URL to the page need to be displayed .. _Ref179990565: Registration token view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Refer :ref:`Client registering view` section for more details about registration token view. .. _Ref180005378: .. _tooltip_control_panel_device_settings_generate_api_access_title: API Access ------------------------------------------------------------------------------------------------------------------------ .. _tooltip_control_panel_device_settings_generate_api_access_desc: NCheck server has given API access to access user, biometric, event data across given user group to use in third party applications. .. figure:: Images/chapter_control_panel/image468.PNG :width: 376 :figclass: align-center API credentials dialog #. 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 creating API, username and password which is required for API access will appear as shown in :numref:`Ref179992817` . For more details refer to the API Documentation section. #. Close button Once created an API access credential view will appear in the API credentials dialog. .. _Ref179992817: .. figure:: Images/chapter_control_panel/image470.PNG :width: 367 :figclass: align-center API access credential view #. Username Username for API access. #. Password Password for API access #. Email field Email API access credentials. .. _Ref180003386: .. _tooltip_control_panel_device_settings_edit_device_title: Edit device ----------------------------------------------------------------------------------------------------------------- .. _tooltip_control_panel_device_settings_edit_device_desc: This view allows the editing of the device details. .. figure:: Images/chapter_control_panel/image472.PNG :width: 453 :figclass: align-center Edit device dialog #. 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. .. _Ref179995805: Device configuration ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Device configuration view as follows. .. figure:: Images/chapter_control_panel/image474.PNG :width: 425 :figclass: align-center Edit device configuration view #. :ref:`Authentication mode` #. :ref:`Verification order` #. :ref:`External executables` #. Events Event type as check-in, check-out, and any events. #. Reset configuration. .. _Ref179995821: .. _tooltip_control_panel_device_authentication_mode_title: Authentication mode """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_control_panel_device_authentication_mode_desc: Authentication mode can be applied to authenticate users to identify or verify user. Available authentication modes are, #. Biometric 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. #. Pass User id data such as QR code, RFID or Number plates are comparing against the database and giving the matching users. #. Biometric and pass The verification mode can be applied with a 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` . #. Biometric or pass Users allows to record attendance using either biometric or pass. .. _Ref179995828: .. _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(barcode, RFID) first or the “Biometric first” to capture the biometric first. .. _Ref179995833: .. _tooltip_control_panel_device_external_executables_title: External executables """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_control_panel_device_external_executables_desc: System can be configured to run external scanners, printers and IOT devices during user identification. For example, an automatic door opening program can be executed upon successful user identification. The connection between NCheck Admin client and external devices is obtaining using following technologies. #. REST API #. Bluetooth Bluetooth scanners and printers connected with the device. #. MQTT Parse data to the MQTT compatible IOT devices such as doors, gates. #. Intent Intents are using to parse data to the applications using `app links `_. This view allows us to add new external executables or edit existing external executables. .. figure:: Images/chapter_control_panel/image476.PNG :width: 412 :figclass: align-center Device management add/edit external executable #. Name Unique name for the external executable. #. Executable path Refer :ref:`External executable path` section for more details about external executables path. #. Trigger on Trigger the external executable on, #. Check-ins #. Check-outs #. Any events #. Unidentified events #. Parameters Primitive or custom parameters. Primitive parameters are parameters which have value Strings. Custom parameters are parameters which have value in Json format. Parameters can be introduced depending on the requirements. The default parameters available with the system are shown below. #. 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 Admin 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. .. _Ref182939328: External executable path '''''''''''''''''''''''''''''''''''''''''''''''''''''' The external executable can be configured to trigger following type of executables #. Execute rest APIs The primitive type parameters will pass as URL parameters. Custom type parameters will be added to the request body. To add custom type parameters, the Rest API should be POST API. #. Windows executable This can be used only for Windows Admin clients only. Absolute path to the .exe file in the client device. #. Bluetooth device/printer The Bluetooth device/print connected with the client device can be triggered using Json array as external executable path as follows. The Json array can be used to parse data to multiple Bluetooth scanners. Each Json object has following properties .. figure:: Images/chapter_control_panel/image478.PNG :width: 584 :figclass: align-center #. url The url to the Bluetooth device/printer. The format should be “htspp://{UUID}&{Bluetoothe device address}” #. data The data parsing to the Bluetooth device. This is a Json array that contains constant and variable data. The constant type of data object is a text. The variable type objects contain key and value to the primitive parameters selected from the external executable parameter list. The Bluetooth device receives text concatenating all the constants and parameter values in the sequence in the data array. #. Delay This is not a required. This can be used to set the number of seconds to delay Bluetooth scanner trigger. #. Trigger MQTT device Trigger any MQTT compatible IOT devices. This can be done using Json array as external executable path as shown below The Json array is used to trigger multiple IOT devices connected to broker topics. Json objects contain following properties .. figure:: Images/chapter_control_panel/image479.PNG :width: 594 :figclass: align-center #. url The url of the MQTT topic that the IOT device connected. The format should be “mqtt://{MQTT broker URL}/{topic}”. Admin client has a default MQTT broker. In that case use localhost as the MQTT broker URL. Otherwise, the URL of the MQTT broker service. #. Username, password The username and password to connect with the MQTT broker. #. data The data publishing to the MQTT IOT device. This is a Json array that contains constant and variable data. The constant type of data object is a text. The variable type objects contain key and value to the primitive parameters selected from the external executable parameter list. The IOT device receives text concatenating all the constants and parameter values in the sequence in the data array. #. Delay This is not a required. This can be used to set the number of seconds to delay Bluetooth scanner trigger. #. Intent This type is using for Android clients only. Intents are used to parse data between android applications in Android. In NCheck , intent can be used to trigger application installed in android device where the Admin client is install using `app links `_. The external executable URL is {scheme}://{host}. The primitive type parameters are parsed as URL parameters of the app link. The object type parameters are parsed as intent extras (String). .. _Ref180003268: .. _tooltip_control_panel_device_settings_edit_api_title: Edit API ----------------------------------------------------------------------------------------------------------- .. _tooltip_control_panel_device_settings_edit_api_desc: This view allows editing of the API details. .. figure:: Images/chapter_control_panel/image480.PNG :width: 493 :figclass: align-center Edit API dialog #. Username Username is not editable #. Description #. Password #. API access permission This is not editable #. Save button Save button will be disabled if the mandatory fields are empty or :ref:`Validation errors` exists. #. Close button .. _Ref182260844: Device view --------------------------------------------------- Selected device information from the device table can be seen in the device view. Device view is shown below. .. figure:: Images/chapter_control_panel/image482.PNG :width: 439 :figclass: align-center Device view #. Tab view #. :ref:`Device detail view` #. :ref:`Peripheral view` #. Selected tab content view .. _Ref180004835: Device detail view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Device detail view shows information for the selected device or API from the device table. Device detail view is shown below. .. figure:: Images/chapter_control_panel/image484.PNG :width: 409 :figclass: align-center Device detail view #. Name Name of the device #. Operation system #. OS version #. Device configuration :ref:`Authentication mode` and allowed events as mentioned in :ref:`Device configuration` section. #. Device settings Kiosk mode and client mode settings values are shown here. #. Edit button Open Edit device dialog as mentioned in :ref:`Edit device` section. #. Re-register button #. Additional settings menu #. Block Block/unblock device. Once the device is blocked, it cannot be used for attendance recording until it unblocked. #. Unregister Unregister device from the system. Once the device is unregistered, it’s no longer can be used with server. #. Settings API detail view is shown below .. figure:: Images/chapter_control_panel/image486.PNG :width: 403 :figclass: align-center Edit API view #. API access permissions 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 #. Username #. Password Select “change” link open Edit API dialog as mentioned in :ref:`Edit API` section. #. Edit button Open Edit API dialog as mentioned in :ref:`Edit API` section. #. Additional settings menu #. Block/unblock Block/unblock API access. Once API blocks, it cannot be used until unblock. #. Unregister Unregister API from the system. Once API unregistered from the system, it cannot be used to access server API. .. _Ref181950921: Device settings """"""""""""""""""""""""""""""""""""""""""""" The service settings section has following setting types #. Client settings Client settings """""""""""""""""""""""" .. list-table:: :widths: 4500 2340 2001 * - Client setting - Attend client - Admin client * - :ref:`Result dialogue timeout` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Self-enroll templates` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Enable licensing` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Show work time on clients` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Allow automatic peripheral enabling of new clients` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Offline operation mode` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Manual capture start` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Automatically synchronize offline data` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Offline data synchronize interval` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Reset offline client password` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Allow predefined location` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Safety helmet detection` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Safety helmet detection threshold` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Hide user list` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`KIOSK mode operation` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Client mode` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Use in-built biometric verification on personal clients` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Mask detection` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Mask detection threshold` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Cancel event button in the feedback view` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center Biometric settings """"""""""""""""""""""""""" .. list-table:: :widths: 4500 2340 2001 * - Client setting - Attend client - Admin client * - :ref:`Face liveness mode` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Face liveness threshold` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Face quality` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Mask detection` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Server-side face liveness setting` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Server face liveness confidence threshold` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center Biometric settings """"""""""""""""""""""""""" .. _Ref180004840: Peripheral view +++++++++++++++++++++++++++++++++++++++++++++++++++++++ Information of all available peripherals with the registered device can be seen in the peripheral view. The peripheral view is shown below. .. figure:: Images/chapter_control_panel/image488.PNG :width: 479 :figclass: align-center Peripheral view #. Peripheral table A :ref:`Data table` represent list of available peripherals. The peripheral table shows the following information. #. Name Peripheral name #. Type #. Face #. Fingerprint #. Iris #. 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 #. Edit button Edit peripheral as mentioned in :ref:`Edit peripheral` section. #. Enable/disable button Once disable peripheral, it cannot be used for attendance recording until enable it. .. _Ref180004787: Edit peripheral """"""""""""""""""""""""""""""""""""""""""""" Edit peripheral dialog is shown below. .. figure:: Images/chapter_control_panel/image490.PNG :width: 396 :figclass: align-center Edit peripheral dialog #. Peripheral code This is unique ID generated by the system and cannot be changed. #. Name Name for the peripheral. #. Peripheral type If ID peripheral type can be either barcode or RFID. If biometric, type can be face, finger or iris. .. _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 are shown below. .. list-table:: Client settings for selected device :widths: 4500 2340 2001 * - Client setting - Attend client - Admin client * - :ref:`Result dialogue timeout` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Enable licensing` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Show work time on clients` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Allow automatic peripheral enabling of new clients` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Offline operation mode` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Manual capture start` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Automatically synchronize offline data` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Offline data synchronize interval` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Reset offline client password` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Allow predefined location` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Self-enroll templates` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Safety helmet detection` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Safety helmet detection threshold` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Use in-built biometric verification on personal clients` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Mask detection` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Mask detection threshold` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Cancel event button in the feedback view` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`KIOSK mode operation` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`KIOSK mode exit code` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center .. _Ref33697786: .. _Ref30079146: Biometric settings """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Biometric settings for the selected device are shown below .. list-table:: Biometric settings for Attend /Admin client :widths: 4500 2340 2001 * - Client setting - Attend client - Admin client * - :ref:`Face liveness mode` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Face liveness threshold` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Face quality` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Mask detection` - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Server-side face liveness setting` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - :ref:`Server face liveness confidence threshold` - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center .. _Ref38719008: .. _tooltip_control_panel_events_title: Manage Event logs ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _tooltip_control_panel_events_desc: Employee and visitor event logs can be managed in the event logs section. Event log view is showing event logs for employees and visitors. The view can be switched to either employee or visitor as mentioned in :ref:`Bio attendance and visitor mode selection` Event logs management view is shown below. .. figure:: Images/chapter_control_panel/image492.PNG :width: 668 :figclass: align-center Event logs management view #. Event logs tabs #. Events #. Maps #. Overtime #. Event images #. Event logs filter view #. Event log tab content view #. Add new menu #. Add new event #. :ref:`Add/edit employee event` #. :ref:`Add/edit visitor event` #. :ref:`Add event from unidentified` #. Actions menu Following action menu options are available. #. Refresh data #. Re-evaluate Refer :ref:`Re-evaluate data` section for more details about re-evaluate #. :ref:`Import event logs` #. :ref:`Export event logs` #. :ref:`Restore events` .. _Ref180692116: Add/edit employee event --------------------------------------------------------------- There are two ways to record employee events. #. Record event from attendance device #. Add event by admin Add/edit employee event dialog is shown below. .. figure:: Images/chapter_control_panel/image494.PNG :width: 318 :figclass: align-center Add/edit employee event dialog #. Event image Event image of the editing event. This can be either face, finger or iris image if the event is recorded using biometric. #. Event source The event source how the event is recorded. This could be either by admin or attendance device. #. Event type Event type as check-in, check-out or access #. Employee name Select employee name. Once an event is added, employee name cannot be changed. #. Select date Select event date #. Event time and time zone #. Shift #. Shift date When an employee Check-in or Check-out is not in the same date, (E.g. Working overtime or Shift spans for two days) shift date should be specified. Otherwise, the event will belong to the current day’s shift #. Location Location coordinate where the event recorded. Once the location coordinate added, the location can be seen in the map as configured from :ref:`Location map provider` setting. #. Description #. Device The device name if the attendance recorded form attendance device. #. Authentication :ref:`Authentication mode` and peripheral used to record attendance., #. Add/Save changes button #. Close button .. _Ref180692123: Add/edit visitor event -------------------------------------------------------------- There are two ways to record visitor events. #. Record event from attendance device #. Add event by admin Add/edit viitor event dialog is shown below. .. figure:: Images/chapter_control_panel/image496.PNG :width: 358 :figclass: align-center Add/edit visitor dialog #. Event image Event image of the editing event. This can be either face, finger or iris image if the event is recorded using biometric. #. Event source The event source how the event is recorded. This could be either by admin or attendance device. #. Event type Event type as check-in, check-out or access #. Visitor name Select visitor name. Once an event is added, the visitor’s name cannot be changed. #. Select date Select event date #. Appointment Select the visitor appointment to add the event. #. Event time and time zone #. Location The location coordinate where the event recorded. Once the location coordinate added, the location can be seen in the map as configured from :ref:`Location map provider` setting. #. Description #. Device The device name if the attendance recorded form attendance device. #. Authentication :ref:`Authentication mode` and peripheral used to record attendance., #. Add/Save changes button #. Close button .. _Ref180692137: Add event from unidentified ------------------------------------------------------------------- When recording events from NCheck client devices events may be recorded as unidentified event due to the following reasons #. Biometric is not enrolled for the employee or visitor. #. The biometric image is not clear enough to identify. The unidentified event images can be added as employee or visitor. Add an event from unidentified dialog is shown below. .. figure:: Images/chapter_control_panel/image498.PNG :width: 576 :figclass: align-center Add event from unidentified dialog #. :ref:`Unidentified event filter view` #. :ref:`Unidentified event list view` #. Add button #. Close button .. _Ref180692066: Unidentified event filter view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image500.PNG :width: 612 :figclass: align-center Unidentified event filter view #. From Unidentified event filtering start date #. To Unidentified event filtering end date #. Biometric type Filter unidentified events from the biometric image type #. Filter by user group Filter by the employee group that the client device where the unidentified event recorded registered to #. Refresh button .. _Ref180692074: Unidentified event list view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image502.PNG :width: 668 :figclass: align-center #. :ref:`Unidentified event view` #. Unidentified events paging view .. _Ref180692015: Unidentified event view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Biometric thumbnail image with the event timestamp is showing as follows. .. figure:: Images/chapter_control_panel/image503.PNG :width: 258 :figclass: align-center Unidentified event view #. Modality thumbnail #. Delete unidentified event button #. Unidentified event details button Refer :ref:`Unidentified event detail view` section for more details. #. Event date and time .. _Ref180691993: Unidentified event detail view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ A detail view of the unidentified events. .. figure:: Images/chapter_control_panel/image505.PNG :width: 501 :figclass: align-center Unidentified event detail view #. The date and time of the event #. Modality thumbnail #. Unidentified event details #. Modality type #. Face #. Fingerprint #. Iris #. Event time #. Location coordinates #. Event address #. Event date and time #. Close button .. _Ref180697531: Re-evaluate data ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Check-in and check-out recorded by the same employee or visitor are paired to count the system hours. But due to the following reasons the check-in check-outs might not be paired when added to the system. #. Check-out event is synchronized with the server before the check-in event is recorded from another device. #. Check-in or check-out event get deleted. When the events are not paired correctly, re-evaluate option can be used to pair those events. Re-evaluate event logs dialog is shown below. .. figure:: Images/chapter_control_panel/image507.PNG :width: 482 :figclass: align-center Re-evaluate event logs dialog #. Strategy #. Re-order check=in and check-out pairs Order all check-in and check-out event pairs. #. First check-in and last check-out Paie first check-in and last check-out. All other events in between will change as access events. #. Re-evaluate button #. Close button .. _Ref180697552: Import event logs +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image509.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. .. _Ref180697559: Export event logs +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image511.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. .. _Ref180697590: Restore events ++++++++++++++++++++++++++++++++++++++++++++++++++++++ Restore previously deleted events. Retore event dialog is shown below. .. figure:: Images/chapter_control_panel/image513.PNG :width: 576 :figclass: align-center Restore events dialog #. Events data filter Select filter starting and end date #. Refresh button #. Deleted event list A :ref:`Data table` represent a list of employee or visitor deleted events. #. Restore button #. Close button To restore a deleted event, Select the deleted event from the list and select the restore button. .. _Ref180736199: Event log calendar view --------------------------------------------------------------- Eventlog calendar view shows an overview of valid and error event logs over the month. A day which has paired eventlogs in order is considered as valid event date. A day which has unpaired event logs considered as error event date. Event log calendar view is shown below. .. figure:: Images/chapter_control_panel/image515.PNG :width: 415 :figclass: align-center Event log calendar view #. Calendar month and year navigation controllers. Refer :ref:`Calendar view` for more details. #. Date with error events #. Date with valid events #. Date with no events #. Selected date #. Current date #. Legend Event log tabs --------------------------------- Event logs tab represents event logs data in 4 different ways as follows. #. :ref:`Events view for employee/visitor event logs` #. :ref:`Events map view for employee/visitor event logs` #. :ref:`Overtime view for employee events logs` #. :ref:`Event image view for employee/visitor event logs ` .. _Ref180746483: .. _Ref182924961: Events view for employee/visitor event logs ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The employee/visitor events view is shown below. .. figure:: Images/chapter_control_panel/image517.PNG :width: 668 :figclass: align-center #. :ref:`Event log calendar view` #. Events table A :ref:`Data table` represent list of event logs. The employee/visitor event log :ref:`Quick access menu` is showing following options #. Edit Edit selected event log. Refer :ref:`Add/edit employee event` section for more details about editing employee event log. Refer :ref:`Add/edit visitor event` section for more details about editing visitor event log. #. Delete Delete selected employee/visitor event log. The following table shows event logs data showing in the event table. The columns can be visible/hide from the table as mentioned in :ref:`Table menu` section. .. list-table:: :widths: 2254 3591 1710 1461 * - Column name - Description - Available for employee events view - Available for visitor events view * - Name - Name of the employee/visitor - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Employee/visitor code - - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Scenario - Scenario used to create a visitor schedule that the appointment has created - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Schedule name - The name of the schedule - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Appointment location - The location of the schedule that the appointment created - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Shift name - Name of the shift that the event log created for - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center * - Shift start - Start time of the shift - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center * - Schedule start - Start time of the schedule - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Direction and status - Event types such as check-in, check-out or access - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Sensor data - The sensors (ex: temperature sensors) available with the attendance device can be configured to get the data when recording attendance. This data will be shown here - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Index number - Appointment number - .. figure:: Images/chapter_control_panel/image49.PNG :width: 17 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Time (GMT) - Event time in GMT - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Time - Local event time - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Event location - The location where the attendance recorded - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Address - - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Device code - A unique identification for the device that the client application is installed. System assigns unique ID when register the device - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Device description - - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Device OS - - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Client app name - The client application name as, Admin or Attend - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Created time - Th - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Modified time - - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Modified by - - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Description - - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Restriction group name - - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center * - Edited by - The role of the person who edited the event. - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center - .. figure:: Images/chapter_control_panel/image48.PNG :width: 14 :figclass: align-center .. _Ref180746489: Events map view for employee/visitor event logs +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Events map shows employee/visitor recent events in a map for the given location coordinates. The map provide can be either google or Baidu configured from :ref:`Event log location map provider` setting, The events map view is shown below. .. figure:: Images/chapter_control_panel/image518.PNG :width: 668 :figclass: align-center #. :ref:`Event log calendar view` #. Events map view. Event location is showing in below colors codes. .. list-table:: :widths: 666 2209 * - .. figure:: Images/chapter_control_panel/image519.PNG :width: 33 :figclass: align-center - Check-in events are showing in green color * - .. figure:: Images/chapter_control_panel/image520.PNG :width: 33 :figclass: align-center - Checkout events are showing in red color * - .. figure:: Images/chapter_control_panel/image521.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. .. _Ref183010017: 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 must 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/chapter_control_panel/image522.PNG :width: 577 :figclass: align-center Eventlog map view for invalid google map API key .. _Ref183010028: Baidu map """"""""""""""""""""""""""""""""""""""" To configure Baidu map, obtain API key as follows, #. Create an account at `https://passport.baidu.com/v2/?login `_ #. Set up a 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 .. _Ref180746495: Overtime view for employee events logs ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. note:: Overtime view is not available for visitors. Overtime is showing employee overtime work hours details. The overtime view is shown below. .. figure:: Images/chapter_control_panel/image524.PNG :width: 672 :figclass: align-center Overttime view #. :ref:`Overtime calendar view` #. Overtime table A :ref:`Data table` represent list of overtime logs from employee for selected date. The employee/visitor event log :ref:`Quick access menu` is showing following options #. Edit Edit overtime hours as mentioned in :ref:`Edit overtime hours` section. The overtime table is showing following columns. #. Name #. Id #. :ref:`First check-in` #. :ref:`Last check-out` #. Max OT status Admin can change the overtime status. Max OT status as #. None Once user completed the events for the day, approval status will be none. #. Approved Approved overtime logs will be considered to calculate employee workhours. #. Rejected Rejected overtime logs will not be considered to calculate employee work hours. #. :ref:`Overtime hours` #. :ref:`Max overtime hours (OTMAX)` .. _Ref180745301: Overtime calendar view """""""""""""""""""""""""""""""""""""""""""""""""""" Overtime calendar view is shown below .. figure:: Images/chapter_control_panel/image526.PNG :width: 445 :figclass: align-center Overtime calendar view #. Calendar month and year navigation controllers. Refer :ref:`Calendar view` for more details #. The date which has overtime logs. The number of logs is also shown #. The date which doesn’t have overtime logs. #. Legend .. _Ref180745323: Edit overtime hours """"""""""""""""""""""""""""""""""""""""""""""""" Admin allows employees to edit overtime logs and set the overtime status as approved or rejected. The edit overtime dialog is shown below. .. figure:: Images/chapter_control_panel/image528.PNG :width: 428 :figclass: align-center Edit overtime dialog #. 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. #. Max OT status Max OT status as #. None Once user completed the events for the day, approval status will be none. #. Approved The approved overtime logs will be considered to calculate employee workhours. #. Rejected The rejected overtime logs will not be considered to calculate employee work hours #. Shift The Shift cannot be updated #. Save changes button #. Cancel button .. _Ref66719055: .. _Ref180746524: .. _Ref30164386: Event image view for employee/visitor event logs ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Event image view shows all employee/visitor event logs for the selected date as event image list as shown below. .. figure:: Images/chapter_control_panel/image530.PNG :width: 618 :figclass: align-center Event image view #. :ref:`Event log calendar view` #. Event image list view Event image list view """""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image532.PNG :width: 626 :figclass: align-center Event image list view #. Event image view Event image view is showing event image (face, iris or finger) with employee name, event type (check-in, check-out or access) and event time. To edit an employee or visitor event, click on the event image view. For more details about edit employee/visitor events, #. :ref:`Add/edit employee event` #. :ref:`Add/edit visitor event` #. Event image list paging .. _Ref31022864: .. _tooltip_control_panel_reports_title: Reports ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _tooltip_control_panel_reports_desc: The reports section includes a set of reports for employees and visitors. The report view can be switched to either employee reports or visitor reports as mentioned in :ref:`Bio attendance and visitor mode selection` section Employee reports ----------------------------------- The employee report selection view is shown below. .. figure:: Images/chapter_control_panel/image534.PNG :width: 668 :figclass: align-center Employee report selection view Once select a report, selected report will be shown in employee report view as shown below .. figure:: Images/chapter_control_panel/image536.PNG :width: 668 :figclass: align-center Employee report view #. Report name Name of the selected report. #. Report parameter’s view Refer :ref:`Report parameters` section for more details. #. Report filter view Refer :ref:`Report filters` section for more details. #. Report table A :ref:`Data table` which showing report data. #. Export menu Refer :ref:`Export report data` section for more details. #. More actions menu #. :ref:`Schedule reports` #. :ref:`View schedules` The following employee reports are available. #. :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` #. :ref:`Devices report` .. _Ref183010094: Total work hour report ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The Total work hours report provides work hours details for a selected date range. Those details can be calculated on a daily, weekly, and monthly basis. The important parameters are #. Employee code #. First name #. Last name #. From Date range start #. To Date range end #. :ref:`Productive work hours (HPS)` #. :ref:`Overtime hours` #. :ref:`Deleted employee` #. Email #. Phone #. Address line 1 #. Address line 2 #. City #. County #. State #. Zip/postal code #. :ref:`Employee status` #. :ref:`Terminated date` #. Total shift hours Total :ref:`Shift hours` #. Total shift work hours Total :ref:`Shift work hours (HS)` #. Total work hours Total :ref:`Work hours` employee has covered. #. :ref:`In-out hours` #. :ref:`Productive hours (HP)` #. :ref:`Early arrival` #. :ref:`Late arrival` #. :ref:`Early departure` #. :ref:`Late departure` #. :ref:`Unproductive hours` #. :ref:`Actual break hours` #. :ref:`Break hours` #. :ref:`First check-in` #. :ref:`Last check-out` #. Holiday :ref:`Number of holidays` #. Leave :ref:`Number of Leaves` #. Attendance :ref:`Number of attendances` .. _Ref30171201: Work hour summary report +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ This report provides the details as follows for users/employees. #. Employee code #. Name #. Employee status #. Terminated date #. Address line 1 #. Address line 2 #. City #. County Zip/postal code #. Phone #. :ref:`Work hours` #. :ref:`Overtime hours` #. :ref:`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. #. Employee code #. First name #. Last name #. From Date range start #. To Date range end #. :ref:`Productive work hours (HPS)` #. :ref:`Overtime hours` #. :ref:`Deleted employee` #. Email #. Email #. Phone #. Address line 1 #. Address line 2 #. City #. County #. State #. Zip/postal code #. :ref:`Employee status` #. :ref:`Terminated date` #. Total shift hours Total :ref:`Shift hours` #. Total shift work hours Total :ref:`Shift work hours (HS)` #. :ref:`In-out hours` #. Total work hours Total :ref:`Work hours` employee has covered. #. :ref:`Productive hours (HP)` #. :ref:`Early arrival` #. :ref:`Late arrival` #. :ref:`Early departure` #. :ref:`Late departure` #. :ref:`First check-in` #. :ref:`Last check-out` #. :ref:`Work hours` #. :ref:`Late arrival` #. :ref:`Late departure` #. :ref:`Early arrival` #. :ref:`Early departure` #. :ref:`Unproductive hours` #. :ref:`Actual break hours` #. :ref:`Break hours` #. :ref:`First check-in` #. :ref:`Last check-out` .. _Ref30171224: User detail report +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The user details report provides a list of employee information. The available details are #. Employee code #. First name #. Last name #. Deleted person Whether the user has deleted or not #. Email #. Phone #. Address line 1 #. Address line 2 #. City #. County #. State #. Zip/postal code #. :ref:`Employee status` #. :ref:`Terminated date` #. Created at #. Group memberships Number of the employee groups the employee has bee added. .. _Ref30171234: Event details ++++++++++++++++++++++++++++++++++++++++++++++++++++ Event details represent all users/employees event details information as follows. #. Employee code #. First name #. Last name #. Shift name #. Event type Event type as check-in, check-out or access #. Event log status #. Date Event date #. Time Event time #. Time zone #. Longitude #. Latitude #. Description #. :ref:`Deleted employee` #. Email #. Phone #. Address line 1 #. Address line 2 #. City #. County #. State #. Zip/postal code #. Employee status #. Terminated date #. Device description #. Device group name #. Device group description #. Device address #. Sensor data Admin clients can be configured to capture data from the sensor available with the devices. For example, the devices have sensors that can capture a nearby person and can be used to capture the employee temperature with the event. Such data is available with this column. .. _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) #. Employee code #. First name #. Last name #. Date #. Availability Preset or absent #. Shift name #. Shift start Start time of the shift as mentioned in :ref:`Add/edit shift` section #. Shift end End time of the shift as mentioned in :ref:`Add/edit shift` section #. Shift description #. :ref:`First check-in` #. :ref:`Early arrival` #. :ref:`Late arrival` #. Last checked-out Last checked-out time #. :ref:`Early departure` #. :ref:`Late departure` #. :ref:`Event logs count` #. :ref:`Deleted employee` #. Email #. Phone #. Address line 1 #. Address line 2 #. City #. County #. State #. Zip/postal code #. :ref:`Employee status` #. :ref:`Terminated date` #. First check-in time zone #. Last check-out time zone. .. _Ref181283779: .. _Ref30171048: .. _Ref30171013: Devices report ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Device report provides information about the client devices register to the server. Device report contain, #. Description #. Device code #. Hardware ID #. Operating system Operating system as Windows, IOS or Android. #. OS version #. Network ID #. App version Version number of the client application installed in the device. #. Application Application type as Admin or attendance. #. User group Name of the employee group, if the client application is registered with a group. #. Employee Name of the employee if the client application is registered for an employee #. Location Name of the location if the client application is registered to a location. #. Last access #. Last updated #. Client to server Last client to server data synchronization date and time if the client is Admin application and offline enabled. #. Server to client Last server to client data synchronization date and time if the client is Admin application and offline enabled. .. _Ref181293485: Report parameters +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image538.PNG :width: 636 :figclass: align-center Report parameters .. figure:: Images/chapter_control_panel/image540.PNG :width: 668 :figclass: align-center Report parameters #. 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. #. Time format Time format as hours only, hours and minutes only or hours minutes seconds only. #. Events #. Show first and last events Show first check-in and last check-out event time. #. Show all events Show all records for each check-in and check-out pairs. #. Don’t show events Don’t show any event details. #. Group by devices Show events for each device. #. Work hours This setting allows to add the 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)` .. _Ref32391257: Report filters +++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image542.PNG :width: 522 :figclass: align-center Report filters view #. Search field Search employee by name #. Shifts filter Filter report by shift. #. User groups filter Filter report by user group. #. User type filter User type as either employee or visitor. Visitor reports ---------------------------------- Visitor reports selection view is shown below. .. figure:: Images/chapter_control_panel/image544.PNG :width: 668 :figclass: align-center Visitor report selection view Once a visitor report is selected from the selection view, the report data will be shown in the visitor report view as shown below. .. figure:: Images/chapter_control_panel/image546.PNG :width: 667 :figclass: align-center Visitor reports view #. Name of the visitor report #. :ref:`Parameter view of the visitor report` #. :ref:`Report filter view of the visitor report` #. Report data A :ref:`Data table` which showing report data. #. Export menu Refer :ref:`Export report data` section for more details. #. More actions #. :ref:`Schedule reports` #. :ref:`View schedules` Available visitor reports are, #. :ref:`Incoming visitors report` #. :ref:`Checked-in visitors` #. :ref:`Checked-out visitors` #. :ref:`Current visitor list` #. :ref:`Visitor summery report` .. _Ref109128558: Incoming visitors report ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Incoming visitor report shows visitors who have appointments for the selected date. The available details are #. Visitor code #. Visitor first name #. Visitor last name #. Scenario name #. Schedule name #. Schedule location #. Appointment starts #. Appointment end #. Appointment time zone #. :ref:`Appointment status` #. Time spent #. Email #. Phone #. Address line 1 #. Address line 2 #. City #. Country #. State #. Zip/postal code .. _Ref181299266: Checked-in visitors +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Checked-in visitors report is showing visitors who recorded their event in the NCheck client devices as check-in event. Following details available in the report #. Visitor code #. Visitor first name #. Visitor last name #. Scenario name #. Schedule name #. Schedule location #. Appointment starts #. Appointment end #. Appointment time zone #. :ref:`Appointment status` #. First checked-in #. First checked- in time zone #. First checked in device #. First checked- in location #. Email #. Phone #. Address line 1 #. Address line 2 #. City #. Country #. State #. Zip/postal code .. _Ref181299276: .. _Ref181296421: Checked-out visitors +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Checked-out visitor report is showing visitors who recorded their event in the NCheck client devices as check-out device. Following details available in the report #. Visitor code #. Visitor first name #. Visitor last name #. Scenario name #. Schedule name #. Schedule location #. Appointment starts #. Appointment end #. Appointment time zone #. :ref:`Appointment status` #. Last checked-out #. Last checked-out time zone #. Last checked out device #. Last checked- out location #. :ref:`Time spent` #. Email #. Phone #. Address line 1 #. Address line 2 #. City #. Country #. State #. Zip/postal code .. _Ref181299314: Current visitor list ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The current visitor list report shows visitors who have arrived to the appointment. This report shows the following details, #. Visitor code #. Visitor first name #. Visitor last name #. Scenario name #. Schedule name #. Schedule location #. Appointment starts #. Appointment end #. Appointment time zone #. :ref:`Appointment status` #. First checked-in #. First checked- in time zone #. First checked in device #. First checked- in location #. Last checked out #. Last checked-out time zone #. Last checked out device #. Last checked- out location #. :ref:`Time spent` #. Email #. Phone #. Address line 1 #. Address line 2 #. City #. Country #. State .. _Ref181299320: Visitor summery report ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The visitor summery report shows an overview of visitor engagement with each schedule for given time period. The visitor summery report contains the following details. #. From #. To #. Schedule name #. Schedule description #. Appointments #. :ref:`Present` #. :ref:`Access visitors` #. :ref:`Attendance visitors` Parameter view of the visitor report +++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image548.PNG :width: 507 :figclass: align-center Parameter view of the visitor report .. figure:: Images/chapter_control_panel/image550.PNG :width: 372 :figclass: align-center Parameter view of the visitor report #. Date selection #. Time selection #. Time format as hours only, hours and minutes only or hours minutes seconds only #. Report calculation strategy Change the calculation based on Daily, Weekly and Monthly basis. #. Date range selection .. _Ref181296428: Report filter view of the visitor report ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image552.PNG :width: 506 :figclass: align-center Report filter view of the visitor report view #. Seach schedule field Search schedule from available schedules. #. Search visitor field Search visitors from available visitors. .. _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 selecting PDF format, it will ask the font size of the pdf as follows. .. figure:: Images/chapter_control_panel/image554.PNG :width: 434 :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 shown below. .. figure:: Images/chapter_control_panel/image556.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 Time to send the report. Time zone should be specified. Preferred time can be selected, or else the following options can be selected. #. Day start :ref:`Day start time` as configured in :ref:`General settings view` . #. Shift start Start time of the shift. #. Shift end End time of the shift. #. 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 allows 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 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ The 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/chapter_control_panel/image558.PNG :width: 402 :figclass: align-center Email configuration of the schedule report view #. Enter recipients’ email(s) separated by commas #. Find recipients from employees using the name #. Find recipients using the user group .. _Ref48738862: FTP configuration """""""""""""""""""""""""""""""""""""""""""""" The report will be saved in the FTP location. .. figure:: Images/chapter_control_panel/image560.PNG :width: 403 :figclass: align-center FTP configuration of the schedule report view #. FTP URL #. Check this if the FTP access credentials are 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/chapter_control_panel/image562.PNG :width: 478 :figclass: align-center View report schedules #. List of reports scheduled A :ref:`Data table` represent scheduled reports. The following information is shown in each report. #. 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 #. Local folder #. Send time base #. FTP export #. Created time Created time of the report schedule #. Edit button Edit report schedules as mentioned in :ref:`Schedule reports` section #. Delete selected report schedule #. Close button .. _Ref31022882: .. _Ref33777278: .. _Ref38783312: .. _tooltip_control_panel_settings_title: Settings ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _tooltip_control_panel_settings_desc: NCheck server control panel settings view is shown below. .. figure:: Images/chapter_control_panel/image564.PNG :width: 587 :figclass: align-center Customer settings view #. Customer settings tabs All settings groups are shown in this tab. All customer Settings are grouped for convenience. Current group are, #. :ref:`General settings view` #. :ref:`Client settings view` #. :ref:`Biometric settings view` #. :ref:`Passes` #. :ref:`Web interface settings view` #. :ref:`Notifications` #. :ref:`License` #. :ref:`Miscellaneous` #. Customer settings area #. Reset to default button Reset all settings in the currently selected setting group. .. _Ref38044738: General settings view ------------------------------------------------------------ .. figure:: Images/chapter_control_panel/image566.PNG :width: 601 :figclass: align-center General settings view of Settings #. :ref:`Day start time` #. :ref:`Week start date` #. :ref:`Month start date` #. :ref:`Year start month` #. :ref:`Date format` #. :ref:`Time format` #. :ref:`Default shift selection behavior` #. :ref:`Auto checkout at the end of the shift` #. :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:`Event log images retention period` #. :ref:`External resource URL` .. _Ref38044749: Client settings view ----------------------------------------------------------- .. figure:: Images/chapter_control_panel/image568.PNG :width: 516 :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:`Allow predefined location` #. :ref:`Self-enroll templates` #. :ref:`Guard application support` #. :ref:`Hide user list on windows client` #. :ref:`Multi face mode` #. :ref:`Cancel event button in the feedback view` .. _Ref136446955: Biometric settings view --------------------------------------------------------------- .. figure:: Images/chapter_control_panel/image570.PNG :width: 530 :figclass: align-center Biometric settings of settings #. :ref:`Manual face selection` #. :ref:`Use in-built biometric verification on personal clients` #. :ref:`Server-side face liveness setting` #. :ref:`Server face liveness confidence threshold` #. :ref:`Face liveness mode for client application` #. :ref:`Face liveness threshold for client application` #. :ref:`Mask detection` #. :ref:`Mask detection threshold` #. :ref:`Safety helmet detection` #. :ref:`Safety helmet detection threshold` #. :ref:`Recognition threshold` #. :ref:`Verification threshold` #. :ref:`Enrollment threshold` #. :ref:`Face confidence` #. :ref:`Face quality` #. :ref:`Maximum face yaw` #. :ref:`Fingerprint quality` #. Iris quality #. Enrollment .. figure:: Images/chapter_control_panel/image572.PNG :width: 511 :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` .. _Ref178853877: .. _Ref38044784: .. _Ref65499755: Passes ---------------------------------------------------------------------------------- Pass is used to identify employees and visitors when biometric data is not required. Pass can be generated from either NCheck or imported from any 3rd part system. Once a pass is assigned for a employee/visitor, that can be used to record their attendance from the allowed period (If defined) or else forever. Passes can be assigned to an employee/visitor in the following ways. #. Assign a new pass to the employee/visitor Generated pass either from NCheck or any 3rd party system. #. Reuse existing pass Once pass unassigned from employee/visitor, it is available for assign Refer :ref:`pass types` section for more information about pass types NCheck support. Passes in the setting section allows to manage all passes using the pass management view. The Pass management view is shown below. .. figure:: Images/chapter_control_panel/image574.PNG :width: 591 :figclass: align-center Refer :ref:`existing pass management view` section for more details about pass management. .. _Ref179876698: Web interface settings view ------------------------------------------------------------------- .. figure:: Images/chapter_control_panel/image575.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:`Location map provider` #. :ref:`Map API key` .. _Ref65499783: Notifications ---------------------------------------------------- .. figure:: Images/chapter_control_panel/image577.PNG :width: 362 :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 On-premises server to receive notifications such as change login details, share device registration token, schedule reports. .. figure:: Images/chapter_control_panel/image579.PNG :width: 421 :figclass: align-center Email notification setting view #. Mail service provider Following mail server providers can be configured to send email notifications. #. :ref:`Gmail` #. :ref:`Outlook Mail` #. :ref:`Yahoo mail` #. :ref:`Brevo` #. :ref:`Custom SMTP server` #. Mail server provider configuration view .. _Ref205310620: Gmail """"""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image581.PNG :width: 595 :figclass: align-center Gmail configuration view #. Host, port and encryption for Gmail #. Gmail username #. Gmail password #. If 2-step verification has enabled for the Gmail account, you must generate `app password for Gmail `_ and use it as the password. .. _Ref205307656: Outlook Mail """""""""""""""""""""""""""""""""""""""""" To configure outlook online as the email server on NCheck, first register NCheck application to get application credentials to send email using outlook email. #. Sign in to the `Microsoft Entra admin center `_ as your company global admin. #. Navigate to Microsoft Entra Id > App registration > New Registration. #. Provide "NCheck" for the application name and configure "Accounts in this organizational directory only" account type. .. figure:: Images/chapter_control_panel/image583.PNG :width: 544 :figclass: align-center Register an application #. Register the application. #. Navigate to Add permission > Microsoft Graph > Application permission > Mail > Mail Send and "Add permission". .. figure:: Images/chapter_control_panel/image585.PNG :width: 547 :figclass: align-center Add permission #. Grant admin consent for the user. .. figure:: Images/chapter_control_panel/image587.PNG :width: 533 :figclass: align-center Grant admin consent for the user #. Navigate to Certificates & secrets > Client secrets > New secret, provide "NCheck secret" for description, select the secret validity period and create the secret. .. figure:: Images/chapter_control_panel/image589.PNG :width: 544 :figclass: align-center Add client secret #. Collect NCheck secret and navigate to "Overview" and collect NCheck application (client) id, your company Directory (tenant) ID. .. figure:: Images/chapter_control_panel/image591.PNG :width: 583 :figclass: align-center Outlook registration overview Once Outlook registration is completed, configure outlook email server in NCheck as follows. .. figure:: Images/chapter_control_panel/image593.PNG :width: 625 :figclass: align-center Outlook configuration view #. Sender email address #. Sender name. By default, this is “NCheck Admin” #. Outlook client ID #. Outlook client secret #. Outlook tenant id .. _Ref205307678: Yahoo mail """""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image595.PNG :width: 589 :figclass: align-center Yahoo mail configuration view #. Host, port and encryption for Yahoo #. Gmail username #. Gmail password #. If 2-step verification has enabled for the Yahoo account, you must generate `app password for Yahoo mail `_ and use as the password. .. _Ref205307684: Brevo """"""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image597.PNG :width: 549 :figclass: align-center Brevo configuration view #. Sender email address #. Sender name. By default, this is “NCheck Admin” #. Brevo API key. Refer `this document `_ to generate Brevo API key. .. _Ref205307690: Custom SMTP server """""""""""""""""""""""""""""""""""""""""""""""" The custom SMTP server configuration view is shown below. .. figure:: Images/chapter_control_panel/image599.PNG :width: 648 :figclass: align-center Custom CMTP server configuration view #. Host name SMTP server to manage emails. For custom SMTP servers, a host name should be provided. #. Port SMTP Server port for custom SMTP servers. The default port is 587. #. Sender email address #. Sender name. By default, this is “NCheck Admin” #. Encryption Enable SSL2 or TLS configuration for custom SMTP servers to ensure the safety and security of the emails. #. Authentication Enable disable authentication for custom SMTP servers. #. Username The Username of the host. This is also the sending email address for all email notifications. #. Password The password of the host server. .. _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 allow to add SMS gateway to receive SMS notification send registration token, leave and holiday notifications. .. figure:: Images/chapter_control_panel/image601.PNG :width: 475 :figclass: align-center SMS notification settings #. Host name Host name of the SMS gateway #. Username #. Password #. Port .. _Ref205309169: License ----------------------------------------------- NCheck clients can be activated from on-premises server license. This section explains on-premises server license management for clients. .. figure:: Images/chapter_control_panel/image603.PNG :width: 616 :figclass: align-center License view #. :ref:`License table` #. New license button Refer :ref:`Add/edit license.` Section for more details. .. _Ref108561519: License table +++++++++++++++++++++++++++++++++++++++++++++++++++++ A :ref:`Data table` . Showing all available licenses below. .. figure:: Images/chapter_control_panel/image605.PNG :width: 566 :figclass: align-center License table view #. License description #. Enabled Whether the license is enabled or not. #. Current activations Number of clients using the license. #. Max activations Number of clients activate from the license. #. Expired on License expiry date. #. Options Following options are available. #. Show devices button Refer :ref:`Assigned devices` section for more details about managing client devices activates to a license. #. Edit button Refer :ref:`Add/edit license.` Section for more details. #. Delete button Delete currently used license. #. :ref:`Table menu` .. _Ref108561482: Assigned devices """""""""""""""""""""""""""""""""""""""""""""" This shows the devices activated using the selected license file as shown below. .. figure:: Images/chapter_control_panel/image607.PNG :width: 591 :figclass: align-center Assigned devices view #. :ref:`Assigned device table` #. Close button .. _Ref108561419: Assigned device table ''''''''''''''''''''''''''''''''''''''''''''''''''' .. figure:: Images/chapter_control_panel/image609.PNG :width: 573 :figclass: align-center Assigned device table view for the license #. Device description #. Application type #. Assigned to Device location. #. Last updated time #. Options #. Unregister button Unregister device, so that the license will be released from the device. .. note:: We strongly recommend deactivating serial license from the client device before unregistering from the server to make sure that the license is available for another client to activate. .. _Ref108559801: Add/edit license. """"""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image611.PNG :width: 465 :figclass: align-center Add/edit license dialog #. License file Browse the license file located in the device. License files cannot be changed when editing license. #. Description #. Expiry date Expiry date of the license. #. Max activation count Number of maximum activations. #. Add/update button. #. Cancel button. .. _Ref108547885: Miscellaneous ----------------------------------------------------- Miscellaneous contains the following sections. #. :ref:`Designation` .. _Ref108562932: Designation +++++++++++++++++++++++++++++++++++++++++++++++++++ This allows employees to manage designations when add/edit employee as mentioned in section. Designation view is shown below. .. figure:: Images/chapter_control_panel/image613.PNG :width: 613 :figclass: align-center Designation view #. :ref:`Designation table` #. Add new button Add new designation as mentioned in :ref:`Add/edit designation` section. .. _Ref108562788: Designation table """"""""""""""""""""""""""""""""""""""""""""""" All designations showing in a :ref:`Data table` .as below. .. figure:: Images/chapter_control_panel/image615.PNG :width: 584 :figclass: align-center Designation table view #. Designation name #. Designation description #. Options #. Edit button Refer :ref:`Add/edit designation` section for more details about edit designation. #. Delete button Delete designation. Select OK button from the Delete designation confirmation dialog as shown in :numref:`Ref174353168` . #. :ref:`Table menu` #. :ref:`Table paging options` .. _Ref174353168: .. figure:: Images/chapter_control_panel/image617.PNG :width: 496 :figclass: align-center Delete designation confirmation dialog .. _Ref108562795: Add/edit designation """""""""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image619.PNG :width: 554 :figclass: align-center Add/edit designation dialog #. Name Name of the designation. This is a unique identification of the designation. Cannot be duplicated. #. Description #. Add/update button. #. Cancel button. .. _Ref38783274: .. _tooltip_control_panel_admin_tasks_title: Admin Tasks ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _tooltip_control_panel_admin_tasks_desc: NCheck admin tasks view as follows, .. figure:: Images/chapter_control_panel/image621.PNG :width: 668 :figclass: align-center Admin tasks view #. Admin tasks tabs view All operations are showing in this tab view. Available operations are #. :ref:`Data management` #. :ref:`Delete personal data` #. :ref:`Manage old event logs` #. :ref:`Admin operation logs` #. :ref:`Biometric operation` #. :ref:`Integrations` #. Tab content view This is where the selected tab content is showing. .. _Ref182943590: Data management ------------------------------------------------------- The data management view is shown below. .. figure:: Images/chapter_control_panel/image623.PNG :width: 637 :figclass: align-center Data management view The data management view contains the following operations. #. :ref:`Backup data` #. :ref:`Restore server databases` #. :ref:`Export data` #. :ref:`Import data` .. _Ref181178993: .. _tooltip_server_control_panel_admin_tasks_database_backup_title: Backup data ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_server_control_panel_admin_tasks_database_backup_desc: NCheck server allows the administrator to backup/schedule backup all data in the specified location securely in JSON format. The backup file must contain following details .. list-table:: :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:`Device 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:`Peripheral view` section * - PeripheralConfiguration.json - Peripheral configurations details * - Person.json - User details * - Roster.json - All roster details as mentioned in :ref:`Schedule management` section. * - RosterItem.json - All roster item details as mentioned in :ref:`Schedule items view` section. * - Task.json - All shift details as mentioned in :ref:`Shift management` 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:`Employees` section of :ref:`Manage Employee Groups` . .. note:: It is strongly recommended to not alter backup files to restore data successfully. The backup view is shown below. .. figure:: Images/chapter_control_panel/image625.PNG :width: 400 :figclass: align-center Data backup view #. Start backup button This will open backup database dialog as mentioned in :ref:`Backup configuration` section. #. Schedule backup button This opens schedule backup dialog as mentioned in :ref:`Schedule backup` section. #. View schedules button This opens list of scheduled backups as mentioned in :ref:`View schedules` section. .. _Ref182944666: Backup configuration """""""""""""""""""""""""""""""""""""""""""""""""" Backup configuration allows configuring backup parameters. Backup database dialog is shown below. .. figure:: Images/chapter_control_panel/image627.PNG :width: 649 :figclass: align-center Backup database dialog #. 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 #. Export profile image Check this option to backup profile images of the employees. This may increase the backup size. #. Backup event logs Check this option to backup all event logs. The following settings are available to configure event logs backup. #. Backup event logs from If the Backup event log option is checked, select the date from which date event logs must be included. #. Include event images Check this option to back up images of the event logs. This may increase the backup size. #. 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 occur. #. 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 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. .. figure:: Images/chapter_control_panel/image629.PNG :width: 552 :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 #. Export profile images Check this option to backup profile images of the employees. This may increase the backup size. #. Backup event log Check this option to backup all event logs. The following settings are available to configure event logs backup. #. Backup event log from If the Backup event log option is checked, select the date from which date event logs must be included. #. Include event images Check this option to back up images of the event logs. This may increase the backup size. #. 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 that could have 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 Backup progress view """"""""""""""""""""""""""""" Database backup time depends on the amount of data to be backup. Once the backup starts, backup progress view will be shown below. .. figure:: Images/chapter_control_panel/image631.PNG :width: 504 :figclass: align-center Backup progress view #. Backup progress view #. Backup progress status. The available status is #. In-progress #. Fail #. Completed #. Refresh button Refresh the backup progress view. Select refresh button if the progress is not updated #. Done button Close the backup progress view .. _Ref37620429: View schdules """""""""""""""""""""""""""""""""""""""""" This view shows the existing email schedules and operations as follows. .. figure:: Images/chapter_control_panel/image633.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/chapter_control_panel/image635.PNG :width: 447 :figclass: align-center Local folder configuration view #. File path File path to the local folder .. _Ref32398352: FTP folder configuration """"""""""""""""""""""""""""""""""""""""""""""""""""" The following details are required to enable FTP configuration. .. figure:: Images/chapter_control_panel/image637.PNG :width: 480 :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 are required #. FTP Username #. FTP password .. _Ref182944413: Restore server databases ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Refer :ref:`Restore database` section for more details. .. _Ref144920615: Export data +++++++++++++++++++++++++++++++++++++++++++++++++++ You are allowed to export following information as CSV files in a 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 Run exporter button #. From Select data to export dialog, select type of data to export #. Select the Start export button to select export location as mentioned in :ref:`Select export location` section .. _Ref144920621: Import data +++++++++++++++++++++++++++++++++++++++++++++++++++ Following information can be imported as a zip with the file hircahy as mentioned in :ref:`Import and Export information` section. #. :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 Run importer button #. From Select data to import dialog, select type of data to import #. Select Start import button to select import location as mentioned in :ref:`Select import location` section. .. _Ref144973418: Delete personal data ------------------------------------------------------------ Delete a person with all related data from the system. Before deleting, this will allow to export all user data as CSV files in a password protected zip file. This export data can be used to restore deleted person again. Delete personal data view is shown below. .. figure:: Images/chapter_control_panel/image639.PNG :width: 668 :figclass: align-center Delete personal data view #. Employee list A :ref:`Data table` showing available employees. Select employee select checkbox (As mentioned in :ref:`Table content area` ) to select employees to permanently deleted. #. Permanently delete button Delete selected employees permanently. Refer :ref:`Permanently delete user and export` section for more details. #. Number of selected employees from the employee list. Select cancel icon to clear the selections. #. Search field Search employee from the employee list. .. _Ref181180890: Permanently delete user and export ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Permanently deleted user and export data dialog will be shown below if request permanently deleted for selected person. .. figure:: Images/chapter_control_panel/image641.PNG :width: 315 :figclass: align-center Permanently delete user and export data dialog #. Deleting person details #. Check this option to download person details as csv files in password protected zip file. Once the data download is complete, it will ask to confirmation to delete person permanently. If data download is not required, uncheck this option and confirm to delete the person. #. Close button .. _Ref182943610: Manage old event logs ------------------------------------------------------------- NCheck Server keeps daily event logs of each user in the database and causes the database to grow with time. The deleted old event logs feature can be used to manage unwanted event logs details in the database as follows. .. figure:: Images/chapter_control_panel/image643.PNG :width: 446 :figclass: align-center Delete old event logs view Start date The date when the event logs deletion starts. There are two options, From the beginning Delete event logs from the beginning of the events. Start from Specify the date when the event logs deletion start. End date The date when the event deletion stops. Shift Delete the event logs assigned to the specified shift. Delete Image only Delete event images without deleting the event. Event log with image Delete both event and event image. Delete button Delete event logs which satisfies all filters specified. .. _Ref30576640: Admin operation logs ----------------------------------------------------------- Administrator operation logs in the NCheck 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. Admin operation logs are shown below. .. figure:: Images/chapter_control_panel/image645.PNG :width: 668 :figclass: align-center Admin operation logs view #. Date selection Select start and end date to retrieve the admin logs. #. Admin log list A :ref:`Data table` showing list of admin logs. The employee/visitor :ref:`Quick access menu` is showing following options #. Details. Admin logs list showing following information #. 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 .. _Ref182943624: Biometric operation ----------------------------------------------------------- The Biometric operation view is shown below. .. figure:: Images/chapter_control_panel/image647.PNG :width: 668 :figclass: align-center Biometric operation view The following biometric operations are available. #. Re-enroll templates #. De-duplicated templates .. _Ref30576530: .. _tooltip_server_control_panel_admin_tasks_reextrqct_templated_title: Re-enroll template ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_server_control_panel_admin_tasks_reextrqct_templated_desc: Re-extract user’s biometric templates from biometric engine and re-enroll. When installing new version of NCheck server, it may require re-enroll templates to the system. In such case NCheck team will notify to use this feature to re-enrollment. Re-enroll template view is shown below. .. figure:: Images/chapter_control_panel/image649.PNG :width: 350 :figclass: align-center R-extract templates view #. Re-enroll button Refer :ref:`Re-enroll templates` section for more details. #. Previous jobs Show previous enrollment. Refer :ref:`Re-enrollment task list view` section for more details. .. _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/chapter_control_panel/image651.PNG :width: 308 :figclass: align-center Re-extract template confirmation window Once select the OK button from the confirmation dialog, it will show the current progress of the re-enrollment job as below. .. figure:: Images/chapter_control_panel/image653.PNG :width: 431 :figclass: align-center Re-enrollment progress view #. Enrollment progress #. Show details button Show details of the re-enrollment task. Refer :ref:`Re-enrollment job details` section for more information. The following errors can occur when requesting re-enrollment. .. list-table:: Error messages for enrollment templates. :widths: 1334 6221 * - Error code - Error message * - 2002 - License cannot be obtained * - 2048 - Biometric re-extraction has failed on the following images. #. {images list} .. _Ref144918118: Re-enrollment job details """"""""""""""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image655.PNG :width: 562 :figclass: align-center Re-enrollment job details view #. Re-enrollment progress #. Job id Unique identification for re-enrollment job. #. Status Re-enrollment job stats as in-progress, completed, failed, or cancelled. #. Job type #. Refresh #. Cancel jobs/Show report button Cancel job button appears to cancel the job is in-progress. The show report button appears for a job failed, completed, or cancelled. Refer :ref:`Re-enrollment report` section for more details. #. Close button .. _Ref144919526: Re-enrollment report """""""""""""""""""""""""""""""""""""""""""""""""" The re-enrollment report is available for completed re-enrollments jobs. .. figure:: Images/chapter_control_panel/image657.PNG :width: 576 :figclass: align-center Re enrollment report view #. Re-extracted employee list A :ref:`Data table` showing re-extracted employees. This contains the following columns #. Name Employee name #. Total auth data count Total biometric template to re-enroll. #. Succeeded auth data count Biometric templates successfully re-enrolled. #. Close button Previous jobs of re-enrollment """"""""""""""""""""""""""""""""""""""" All previous enrollment jobs can be seen as follows. .. figure:: Images/chapter_control_panel/image659.PNG :width: 616 :figclass: align-center Previous re-enrollment tasks dialog #. :ref:`Filter view` #. :ref:`Re-enrollment task list view` #. Close button .. _Ref144919666: Filter view ''''''''''''''''''''''''''''''''''''''''' .. figure:: Images/chapter_control_panel/image661.PNG :width: 558 :figclass: align-center Filter view of the re-enrollment jobs #. From Start date #. To End date #. Refresh button .. _Ref144919673: Re-enrollment task list view '''''''''''''''''''''''''''''''''''''''''''''''''''''''''' Re-enrollment job lists represent the status of all re-enrollment jobs. Re-enrollment job in the list view is shown below. .. figure:: Images/chapter_control_panel/image663.PNG :width: 363 :figclass: align-center Re-enrollment job view #. Job id Unique identification for the re-enrollment job. #. Started date Start date and time of the re-enrollment job. #. Status Status of the re-enrollment job as in-progress, completed, failed, or cancelled. #. Remark Number of persons to re-enrolled #. Show report button Detail report for re-enrollment job. Refer :ref:`Re-enrollment report` section for more details. .. _Ref144973436: De-duplicate template +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ In large organizations, people may have similar biometric images due to the similar face, finger and iris issues in the enrolling templates such as similar biometrics for twins, lighting issues in face images, blurry images etc. This will be caused to match with the wrong person when recording attendance. This is known as false matching. NCheck is considered a person as identified if identification score for a biometric image and person biometric data is equal or greater than :ref:`Recognition threshold` . If there are multiple people matching, it will show as false matching. When enrolling template, if it is finding a matching, it will report as duplicate matching. Refer :ref:`Update employee/visitor biometrics` for more information. De-duplicate template option can be used to find false matching in case of someone change :ref:`Recognition threshold` setting from :ref:`Biometric setting list` . De-duplicate template view is shown below. .. figure:: Images/chapter_control_panel/image665.PNG :width: 443 :figclass: align-center De-duplicate template view #. De-duplicate button Refer :ref:`De-duplicate` section for more details. #. Previous jobs button Refer :ref:`Previous jobs of de-duplicate template` section for more details. .. _Ref181185600: De-duplicate ++++++++++++++++++++++++++++++++++++++++++++++++++++ De-duplicate 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 ther figure. .. figure:: Images/chapter_control_panel/image667.PNG :width: 420 :figclass: align-center Confirmation message prior to start de-duplicate job Once select the OK button from the confirmation dialog, it will show the current progress of the de-duplicate job as below. .. figure:: Images/chapter_control_panel/image653.PNG :width: 431 :figclass: align-center Re-enrollment progress view #. Enrollment progress De-duplicate job progress Show details button Show details of the re-enrollment task. Refer :ref:`De-duplicate job details` section for more information. .. _Ref144971144: De-duplicate job details """""""""""""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image669.PNG :width: 535 :figclass: align-center De duplicate job detail view #. Re-enrollment progress #. Job id Unique identification for re-enrollment job. #. Status Re-enrollment job stats as in-progress, completed, failed, or cancelled. #. Job type #. Refresh #. Download report button De-duplication report contains following details. #. Person id #. Employee code #. Authentication data ID Unique identification number for the biometric used to match. #. Modality Biometric type (face, finger, iris) of the image to be match #. Matching person id Person ID of the person that the biometric is matched with #. Matching employee code Employee code of the person that the biometric is matched with #. Matching authentication data id Authentication data id of the matching biometric #. Matching modality #. Matching score The score given by the matching algorithm. #. Matching threshold The threshold should be satisfied when matching two biometric images. If the matching score is greater than the matching threshold, it is considered as matched. This threshold can be changed from :ref:`Recognition threshold` setting #. Close button .. _Ref181185618: Previous jobs of de-duplicate template ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ All previous de-duplicate templates jobs can be seen as follows. .. figure:: Images/chapter_control_panel/image671.PNG :width: 543 :figclass: align-center \ Previous de-duplicate jobs dialog #. :ref:`Filter view` #. :ref:`Re-enrollment task list view` #. Close button .. _Ref144970619: Filter view """"""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image673.PNG :width: 563 :figclass: align-center Filter view for de-duplicate jobs #. From Start date #. To End date #. Refresh button .. _Ref144970625: Re-enrollment task list view """""""""""""""""""""""""""""""""""""""""""""""""""""""""" De-duplicate job list view represents status of all de-duplicate jobs. De-duplicate job in the list view is shown below. .. figure:: Images/chapter_control_panel/image675.PNG :width: 291 :figclass: align-center De-duplicate job view #. Job id Unique identification for the re-enrollment job. #. Started date Start date and time of the re-enrollment job. #. Status The status of the re-enrollment job as in-progress, completed, failed, or cancelled. #. Remark Number of persons to re-enrolled #. Download button Download de-duplicate report. Refer :ref:`De-duplicate job details` section for more details about de-duplicate report. .. _Ref213354585: Integrations ---------------------------------------------------- NCheck can be integrated with 3rd party systems such as payroll, ERP to synchronize employee details and attendance details. Because the employee and attendance details play major role when calculating employee workhours to calculate salaries. Currently NCheck can be integrated with Microsoft Dynamics 365 Business Central. But other systems can also be integrated upon customer requests. NCheck uses `Apache Nifi `_ to transform and synchronize employee and attendance data inbetweento 3rd party systems and NCheck. In Micorosft Windows OS, Apache Nifi automatically starts when the NCheck service is started and it will remain open Windows task bar as follows. .. figure:: Images/chapter_control_panel/image677.PNG :width: 549 :figclass: align-center Apache Nifi service opening in Windows task bar #. Apache Nifi service icon showing in Micorosft Windows Task bar .. note:: Do not close Apache Nifi service if you require integration feature. NCheck integration view is shown below. .. figure:: Images/chapter_control_panel/image679.PNG :width: 438 :figclass: align-center Apache Nifi Integration view #. NCheck integration status view This indicates the NCheck and Apache Nifi connectivity status. If the status fails, integration will not successfully be completed. #. Integration search Type to search integration here and select add button to schedule integration to synchronize data. Refer more details about :ref:`Add/edit integration schedules` . #. Integration schedules will be shown here. Integration schedules view +++++++++++++++++++++++++++++++++++++++++++++ Integration schedules view is showing all synchronization schedules added to the integration as below. .. figure:: Images/chapter_control_panel/image681.PNG :width: 363 :figclass: align-center Integration schedules view #. Integration name #. Integration schedule view #. Edit button Refer :ref:`Add/edit integration schedules` section for more details. Integration schedule view """""""""""""""""""""""""""""""""" Integration schedule view is shown below. .. figure:: Images/chapter_control_panel/image683.PNG :width: 444 :figclass: align-center Integration schedule view #. Schedule name #. Last execution time The date and time the schedule was run last. #. Open logs Open synchronization logs of the executed schedules. Refer :ref:`Synchronization schedule logs` section for more details #. Execution start time Date and time of the next schedule runs. #. Sync now Manually runs the synchronization schedule. Refer :ref:`Manual synchronization` section for more details. #. Execution frequency .. _Ref213354522: Synchronization schedule logs ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' Logs of the old/running schedule can be seen in this dialog as shown below. .. figure:: Images/chapter_control_panel/image685.PNG :width: 497 :figclass: align-center Synchronization schedule logs #. Integration and schedule name #. Sync type Select sync type schedule or manual to retrieve the logs accordingly. #. Logs :ref:`Data table` which shows all available logs for the selected sync schedules. Available information is, #. Created at Date and time of the log #. Status The statuses are Started, Failed or completed #. Log message .. _Ref213354540: Manual synchronization '''''''''''''''''''''''''''''''''''''''''''''''''''' Manual synchronization features can be used to synchronize schedules whenever the synchronization is required within 14 days. Manual synchronization dialog is shown below. .. figure:: Images/chapter_control_panel/image687.PNG :width: 387 :figclass: align-center Manual sync schedule view #. Integration and schedule name #. Synchronization date ranges The date range within 14 days #. Sync now button Start the synchronization. Manual synchronization will not start if there is a in-progress synchronization for the same schedule. #. Last manual sync details Last execution time and sync status of the last/running schedule. .. _Ref213351279: Add/edit integration schedules ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Add/edit integration schedules are shown below. .. figure:: Images/chapter_control_panel/image689.PNG :width: 374 :figclass: align-center Add integration schedules dialog #. Integration name #. Connection details of the 3rd party system This fields are configurable based on the systems. #. Synchronization schedules Currently NCheck supports #. Person synchronization Sync all employees from 3rd party system to NCheck. #. Event synchronization Synchronize employee attendance data between 3rd party system and NCheck. #. Schedule parameters #. Execution starts time/next execution time #. Execution frequency The frequency that the schedule should be run at the given time. #. Daily #. Weekly Select weekdays the schedule should be run #. Monthly Select month dates the schedule should be run. #. Add/save button .. _Ref38783345: .. _tooltip_control_panel_subscription_title: Subscription ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. note:: Subscription is not available on NCheck On-premises server. NCheck cloud subscription allows to manage account payments, plan and payment statistics. One a NCheck cloud account created; it will be assigned a free subscription plan automatically. According to the requirements, the plan can be changed to one of available as shown below. .. list-table:: Cloud plan details :widths: 2337 1978 2340 2695 * - - Free - Premium plan - Enterprise plan * - Trial period - First 3 months - First 30 days - First 30 days * - Number of employees - Up to 5 - Unlimited. The price per employee is 1.20 euro. - Unlimited. The price per employee is 1.50 euro. * - Number of appointments - Up to 20 - Unlimited. The price per appointment is 0.10 euro. - Unlimited. The price per appointment is 0.20 euro. The subscription view is shown below. .. figure:: Images/chapter_control_panel/image691.PNG :width: 693 :figclass: align-center Subscription view #. Subscription options tab view Following options are available #. :ref:`Subscription and invoice` #. :ref:`History` #. :ref:`Billing and payment method` #. Subscription option view This is where the content of the selected subscription option is showing. .. _Ref182992262: Subscription and invoice ---------------------------------------------------------------- The subscription and invoice summary are showing the current subscription details and invoices. Subscription and invoice view shown below. .. figure:: Images/chapter_control_panel/image693.PNG :width: 676 :figclass: align-center Subscription and invoice view #. :ref:`Plan details` #. :ref:`Current statistics view` #. :ref:`Last invoice view` #. :ref:`Previous invoices view` .. _Ref181650225: Plan details ++++++++++++++++++++++++++++++++++++++++++++++++++++ This view shows the currently using plan details and allows to change the plan. .. figure:: Images/chapter_control_panel/image695.PNG :width: 459 :figclass: align-center Plan details view #. Billing cycle The period when the payment should be made. This can be either monthly or annually. #. Plan start The date that the plan was selected for the billing #. Next billing date #. Price per employee #. Price per appointment #. Number of employees Number of employees added to the plan #. Number of appointments Number of appointments added to the plan/ #. Change plan Change current plan as mentioned in section. Change plan """""""""""""""""""" Change plan dialog is shown below. .. figure:: Images/chapter_control_panel/image697.PNG :width: 641 :figclass: align-center Change plan dialog #. Number of additional employees and appointments for the selected plan #. Billing cycle Billing cycle as monthly or yearly. Yeary billing cycle is offered 10% of price deduction compared to the monthly billing cycle. #. Available plans All available plans are showing in this view. There are 3 plans available. Refer :ref:`Subscription plans` section for more information about available plans. Refer :ref:`Subscription Plan view` section for more information about plan view. .. _Ref181642339: Subscription Plan view """""""""""""""""""""""""""""""""""""""""""""""""""" Plan view is shown below. .. figure:: Images/chapter_control_panel/image699.PNG :width: 314 :figclass: align-center Subscription plan view #. Plane name #. The duration of the trial period once the plan selected in first time. #. Price per billing cycle #. Price per additional employee #. Price per additional appointment #. Start button Start the plan .. _Ref181642326: Subscription plans """""""""""""""""""""""""""""""""""""""""""""""" There are three plans available. .. list-table:: :widths: 2600 2332 2209 2209 * - Plan - Free - Premium - Enterprise * - Trial period - 3 months - 30 days - 30 days * - Rate for additional employee (Euro) - - - 1.20 - 1,50 * - Rate for additional appointment (Euro) - - - 0.10 - 0.20 .. _Ref181650233: Current statistics view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The current statics view is shown below. .. figure:: Images/chapter_control_panel/image701.PNG :width: 436 :figclass: align-center Current statics view #. Number of employees added to the plan #. Number of appointments added to the plan #. Status Current plan status as #. Active #. Blocked If the outstanding amount is not paid before the bill date, there will be a 7-day grace period to settle the bill. If the bill is not paid before the end of the grace period, the account will be blocked. #. Total outstanding #. Unbilled usage unbilled usage for the current bill cycle. Select details button to check more details as mentioned in :ref:`Current usage` section. #. Total payable #. Pay button Pay the outstanding amount. Refer :ref:`Payment` section for more information about payment. .. _Ref181650350: Current usage """"""""""""""""""""""""""""""""""""""""""" Usage dialog shows current usage before the billing date as shown below. .. figure:: Images/chapter_control_panel/image703.PNG :width: 530 :figclass: align-center Current usage dialog #. Usage graph #. Usage breakdown Number of employee days and appointment days in the unbilled period. #. Charges break down Total amount of employee days and appointment days. .. _Ref181650370: Payment """"""""""""""""""""""""""""""""""""" Payment dialog is shown below. .. figure:: Images/chapter_control_panel/image705.PNG :width: 633 :figclass: align-center Payment dialog #. Payment preferences #. Last bill due Outstanding amount for the last bill date with the tax amount. #. Total due Outstanding amount for the last bill date including the current usage (before the bill date) with the tax. #. Reserve usage (1 year) #. Payment details for the selected payment preference #. Proceed button Select proceed button to open the confirm dialog as mentioned in :ref:`Payment confirmation` section. .. _Ref181650398: Payment confirmation """""""""""""""""""""""""""""""""""""""""""""""""" Confirm your payment dialog is shown below. .. figure:: Images/chapter_control_panel/image707.PNG :width: 496 :figclass: align-center Confirm your payment dialog #. Company name #. Amount #. Email of the administrator #. Payment method #. Confirm button Redirect to the payment gateway to complete the payment. It will redirect to the subscription page from the payment gateway once the payment is completed. .. note:: Do not close the browser session after the payment completion. It will redirect back to the subscription page from the payment gateway once the payment is completed. .. _Ref181650241: Last invoice view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The last invoice view shows the details of the recent invoice to be paid/paid as shown below. .. figure:: Images/chapter_control_panel/image709.PNG :width: 663 :figclass: align-center Last invoice details view #. Invoice ID Unique identification for the invoice #. From Start date of the billing period #. To End date of the billing period #. Usage #. Payment #. Previous invoice due #. Total payable #. Options View/download invoice. .. _Ref181650247: Previous invoices view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Previous invoices show all paid previous invoices. .. figure:: Images/chapter_control_panel/image709.PNG :width: 693 :figclass: align-center Previous invoice view #. Invoice ID Unique identification for the invoice #. From Start date of the billing period #. To End date of the billing period #. Usage #. Payment #. Previous invoice due #. Total payable #. Options View/download invoice .. _Ref182992281: History ----------------------------------------------- .. _Ref182992288: Billing and payment method ------------------------------------------------------------------ The billing and payment method view is shown below. #. Payment method view #. :ref:`Billing detail view` .. _Ref181655712: Billing detail view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Billing information is shown in this view as shown below. .. figure:: Images/chapter_control_panel/image711.PNG :width: 486 :figclass: align-center Billing details view #. Billing details #. Update button Update billing details as mentioned in :ref:`My Account` sections. Users Service portal ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ NCheck Cloud/On-premises server control panel for users allows reviewing user specific data for each user. The 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/chapter_control_panel/image713.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:`Switch profile by role` #. Sign out .. _Ref30599368: Manage user details ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image715.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 that 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. .. _tooltip_user_control_panel_time_sheet_title: User time sheet -------------------------------------------------------------------------------------- .. _tooltip_user_control_panel_time_sheet_desc: The user time sheet view shows the work plan of the user for a period. The User time sheet view is shown below. .. figure:: Images/chapter_control_panel/image717.PNG :width: 636 :figclass: align-center User time sheet view #. :ref:`User quick view` #. :ref:`Work hour quick view` #. :ref:`Leaves quick view` #. :ref:`Calendar view` #. :ref:`User time sheet view` .. _Ref136932728: User quick view +++++++++++++++++++++++++++++++++++++++++++++++++++++++ User quick view shows user details as shown below. .. figure:: Images/chapter_control_panel/image719.PNG :width: 326 :figclass: align-center User quick view #. User images #. First name and last name #. User role #. Username. .. _Ref136932736: Work hour quick view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The work hour quick view shows a summary of the user worked hours for the selected time range as below. .. figure:: Images/chapter_control_panel/image721.PNG :width: 421 :figclass: align-center Work hour quick view #. Today Total work hours for the current date #. This week Total work hours for the current week. #. This month Total work hours for the current month. .. _Ref136932743: Leaves quick view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Leaves quick view shows a summary of the user leaves. .. figure:: Images/chapter_control_panel/image723.PNG :width: 362 :figclass: align-center Leaves quick view #. Leaves taken by the user #. Total available leaves #. Details button Refer :ref:`Users leave summery` section for more details. .. _Ref136525666: Users leave summery """"""""""""""""""""""""""""""""""""""""""""""""" The user leave summery view shows a remaining and taken leaves from each leave type. .. figure:: Images/chapter_control_panel/image725.PNG :width: 536 :figclass: align-center Leave summery view #. Leave summery view Leave summery view for specific leave type. #. Close button .. _Ref136932753: Calendar view +++++++++++++++++++++++++++++++++++++++++++++++++++++ Calendar view is used to select the week/month to retrieve time sheet data. .. figure:: Images/chapter_control_panel/image727.PNG :width: 323 :figclass: align-center Calendar view of the user work sheet view #. Time period The day period the data should be shown in the :ref:`User time sheet view` . #. This week #. Bi week Two weeks #. Monthly #. Previous button Change to the previous week/bi-week/month. #. Next button Change to the next week/bi-week/month. #. Selected period .. _Ref136932761: User time sheet view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The user time sheet view shows a summary of user work hours for the selected day period. .. figure:: Images/chapter_control_panel/image730.PNG :width: 593 :figclass: align-center User time sheet view #. Date :ref:`Date view` for the selected day period in the :ref:`Calendar view` . #. Shift Shift name #. Start Shift start time. #. End Shift end time #. :ref:`Work hours (HW)` #. Total hours #. Additional details .. _Ref143765394: Date view """"""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image732.PNG :width: 317 :figclass: align-center Date view of the user time sheet view #. Date #. Day status Day status indicates following details. #. Today Current date #. Leave Leave with the leave type. The leave type, request note, and approval note will be displayed instead of the shist, start, end, worked hours and total columns. #. Holiday Holiday with holiday name. User work hours detail view """""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image734.PNG :width: 473 :figclass: align-center User work hours detail view #. Date #. Work hour details #. Work hours details Following details are showing, #. Shift starts and ends. #. First check-in date time #. Last check-out date #. Shift work hours #. Holiday details Name of the holiday #. Leave details Leave type, request note and approval notes. #. Close button .. _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 follows. .. figure:: Images/chapter_control_panel/image736.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/chapter_control_panel/image738.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 ++++++++++++++++++++++++++++++++++++++++++++++++++++ The calendar view shows the following details. .. figure:: Images/chapter_control_panel/image740.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/chapter_control_panel/image742.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/chapter_control_panel/image744.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/chapter_control_panel/image746.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 presents user event log detail view as follows. .. figure:: Images/chapter_control_panel/image748.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 can monitor the details below in the rosters and schedules. .. figure:: Images/chapter_control_panel/image750.PNG :width: 668 :figclass: align-center Shift and roster management view of user web control panel #. :ref:`Shifts view` #. :ref:`Rosters view` #. :ref:`Roster item management view` .. _Ref30662264: Shifts view ++++++++++++++++++++++++++++++++++++++++++++++++++ Shift view shows available shifts for users. .. figure:: Images/chapter_control_panel/image752.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 shown in this view as follows. .. figure:: Images/chapter_control_panel/image754.PNG :width: 470 :figclass: align-center User rosters view #. Roster name #. Roster duration #. End date #. Status .. _Ref30662277: .. _Ref136461456: Roster item management view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image756.PNG :width: 668 :figclass: align-center User roster items view #. Current month #. Weeks view Filter roster items by shift #. Week view #. :ref:`Roster items view of user service portal` .. _Ref38092760: Roster items view of user service portal """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image758.PNG :width: 642 :figclass: align-center Roster items view of user service portal #. :ref:`Date view of user service portal` #. :ref:`Roster item view of user service portal` .. _Ref136461389: Date view of user service portal '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' .. figure:: Images/chapter_control_panel/image760.PNG :width: 293 :figclass: align-center Date view of user service portal #. Date #. Holiday view If a date has a holiday, the view background will be appeared with image. .. _Ref136461396: Roster item view of user service portal ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' The roster item’s view shows the following details. .. figure:: Images/chapter_control_panel/image762.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 user to view leaves, holidays and apply leaves. .. figure:: Images/chapter_control_panel/image764.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 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ Users are allowed to apply for leave as below. .. figure:: Images/chapter_control_panel/image766.PNG :width: 369 :figclass: align-center Request a leave dialogue view #. Start date Leave starts 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, the user will be get notified as shown in :numref:`Ref136461694` . #. Cancel button Cancel the Request a leave dialogue. .. _Ref136461694: .. figure:: Images/chapter_control_panel/image768.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/chapter_control_panel/image770.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 menu` .. _Ref46238980: Holiday table view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Holiday table show holidays available for the selected date in the :ref:`Calendar view` . .. figure:: Images/chapter_control_panel/image772.PNG :width: 298 :figclass: align-center Holiday table view of user service portal #. Date #. Description #. :ref:`Table menu` .. _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/chapter_control_panel/image774.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 would appear 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/chapter_control_panel/image776.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/chapter_control_panel/image778.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 ++++++++++++++++++++++++++++++++++++++++++++++++++++ The calendar view shows leave and holidays for the user as below. .. figure:: Images/chapter_control_panel/image780.PNG :width: 271 :figclass: align-center Calendar view #. Selected month #. Navigate button to last month. #. Navigate button to next month. #. User leave #. Holiday #. Current date #. Selected date .. _Ref31027395: .. _tooltip_user_control_panel_reports_title: User reports -------------------------------------------------------------------------------------------------- .. figure:: Images/chapter_control_panel/image782.PNG :width: 589 :figclass: align-center #. :ref:`Report types of user service portal` #. :ref:`Export user reports` #. Report view .. _Ref136509144: .. _Ref30663396: Report types of user service portal +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ #. :ref:`Total work hour report of user service portal` #. :ref:`Work hour summery 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. Those details can be calculated on a daily, weekly, and monthly basis. The important parameters are, #. From #. To #. :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` .. _Ref136506888: .. _Ref38111956: Work hour summery report of user service portal """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" #. Date #. Total work hours Total :ref:`Work hours (HW)` for the date. Productivity report of user service portal """"""""""""""""""""""""""""""""""""""""""""""""""" Productivity report is generated for a selected time with user/employee productivity parameters as follows. #. From #. To #. :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` .. _Ref38111979: Event detail report of user service portal """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Event details represent all users/employees event details information as follows. #. Shift Shift name #. Event type #. Date and time #. Time zone Time zone difference in hours with respective to UTC. #. Location coordinates Longitude and Latitude coordinates of the event location #. Location source #. Address #. Description #. Device mode The device is registered to the user or user group. #. Device group name Device group name if registered to a user group. #. Device group description Device group description if registered to a user group. #. Device group deleted #. Restriction group name #. Restriction group description #. Restriction group deleted. .. _Ref46304541: Report data view of user service portal ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image784.PNG :width: 668 :figclass: align-center Report data view of user service portal #. :ref:`Report settings of user service portal` #. Shift filter Select the shift name to filter report data. #. Report table #. Reload button Reload report data once the setting and filters have been changed. .. _Ref136512786: Report settings of user service portal ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image786.PNG :width: 542 :figclass: align-center #. Report calculation strategy Change the calculation based on Daily, Weekly or Monthly basis. Report calculation strategy is not available for :ref:`Event detail report of user service portal` . #. Time filter Show time ranges in Hours format or Hours and minutes format or hours, minutes and seconds format. Report calculation strategy is not available for :ref:`Event detail report of user service portal` . #. Date range Refer section for more details. Date range """"""""""""""""""" Select the start and end date to request report data. .. figure:: Images/chapter_control_panel/image788.PNG :width: 320 :figclass: align-center Date range view of the user service portal #. Start date #. End date #. Date navigation Increment or decrement start and end date keeping the difference between start and end dates using back backward and forward arrow buttons. #. Reset button Set the start date to the current date keeping the difference between end date. Report table of user reports """"""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image790.PNG :width: 668 :figclass: align-center Report table of user reports #. Report columns #. :ref:`Table menu` #. Report data #. :ref:`Table paging options` .. _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: NCheck Admin and Attend Clients for Windows, Android and IOS can be registered to an employee, employe group or location. To register the application the registration token can be generated for the selected registration mode. Once the registration token is generated, the token will be display as follows. .. figure:: Images/chapter_control_panel/image792.PNG :width: 419 :figclass: align-center Register device view #. Guidance to register client. #. :ref:`Registration token view` #. The registration token expiration time One the token expired, it cannot use to register the client. A new registration token should be generated again. #. Close button .. _Ref34296842: .. list-table:: Error messages of registration view :widths: 1705 6480 * - Error code - Error message * - 2035 - Failed to email registration token. .. _Ref179879185: Registration token view +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Th registration token view is showing the registration token required to register NCheck client application. .. figure:: Images/chapter_control_panel/image794.PNG :width: 499 :figclass: align-center Registration token view #. Scan token Scan QR code to get the registration token and server URL. #. Send email Email registration token to an email. To send email, you should configure email as mentioned in :ref:`Email notification settings` section. #. Copy token Copy registration token. .. _Ref179886481: Calendar view ----------------------------------------------------- The calendar view is used to represent data for dates. In either NCheck this calendar view is shown in larger screens only. The calendar view is shown below. .. figure:: Images/chapter_control_panel/image796.PNG :width: 306 :figclass: align-center Calendar view in event logs management #. Year selection menu #. Refresh button Refresh calendar by retrieving data. #. Button to navigate to previous month #. Button to navigate to next month #. Selected month The selected month is showing all available dates of the month. And each date view may show specific data depending on the use case. For example, according to the figure, each date view represents number of events as well as error/valid events with colors. #. Legend Based on the data represents, this view may appear. .. _Ref37615197: .. _tooltip_server_location_restrictions_title: Location restrictions ------------------------------------------------------------------------------------------------------------- .. _tooltip_server_location_restrictions_desc: Location restrictions can be applied for selected employee/employee group in order to bound check-in/checkout events to the area. Location restrictions view as follows, .. figure:: Images/chapter_control_panel/image798.PNG :width: 457 :figclass: align-center #. Location restrictions table #. Add new location button Add location restriction. Refer section for more details. Location restriction table +++++++++++++++++++++++++++++++++++++++++++++ This view shows all location restrictions and operations as follows .. figure:: Images/chapter_control_panel/image800.PNG :width: 296 :figclass: align-center #. Restriction name #. Address where the restriction applied #. Options #. Edit button :ref:`Edit location restriction` #. Delete button Delete location restriction for the employee/group .. _Ref32400768: Edit location restriction ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Edit existing location restriction as follows. .. figure:: Images/chapter_control_panel/image802.PNG :width: 410 :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 restrictions can be added as follows. .. figure:: Images/chapter_control_panel/image804.PNG :width: 404 :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 restrictions as follows. .. figure:: Images/chapter_control_panel/image806.PNG :width: 163 :figclass: align-center Add new location restriction view #. Restriction name #. Description #. Address where the restriction applies #. Latitude #. Longitude #. Select location from the map Pick location from map view. You must configure map from :ref:`Location map provider` setting first. #. radius #. Allow bypass Check this option to allow user to bypass the location restriction as mentioned in section #. Add button Update button will be disabled if the mandatory fields are empty or :ref:`Validation errors` exit. :numref:`Ref37405922` shows error messages could appear when updating location restriction .. _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. .. _Ref174441217: Manage passes ----------------------------------------------------- Pass is used to identify employees and visitors when biometric data is not required. Pass can be generated from either NCheck or imported from any 3rd part system. Once a pass is assigned for employee/visitor, that can be used to record their attendance from the allowed period (If defined) or else forever. Passes can be assigned to an employee/visitor in the following ways. #. Assign a new pass to the employee/visitor Generated pass either from NCheck or any 3rd party system. #. Reuse existing pass Once pass unassigned from employee/visitor, it is available for assign. .. _Ref174435229: Pass types ++++++++++++++++++++++++++++++++++++++++++++++++++ NCheck support following pass data types #. Barcode #. RFID #. Vehicle number plates Manage employee/visitor passes +++++++++++++++++++++++++++++++++++++++++++++++++ Employee/visitor passes view allows employees to manage pass assignments as follows. .. figure:: Images/chapter_control_panel/image808.PNG :width: 377 :figclass: align-center Employee/visitor passes view #. Pass assigning options Add passed for employees/visitors. Employees are allowing one pass while visitors can have multiple passes. #. :ref:`Create pass assignment` #. Select existing #. Employee/visitor pass assignment view #. Paging Navigating between pass assignments #. Close buttons .. _Ref174439558: Create/update pass assignment +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Employee/visitor pass assignments can be created or updated as follows. .. figure:: Images/chapter_control_panel/image810.PNG :width: 492 :figclass: align-center view for create/update pass assignments #. Action name for pass creates or edit #. Pass name Unique identification for pass. #. Pass data view All pass data is showing in this area. Refer :ref:`Pass data view` section for more details about pass data. #. Add pass data button Add pass data to the pass. Refer :ref:`Pass data view` section for more details about pass data. #. Assign from history button #. Valid from Specify a date that the pass can be used for if required. Refer :ref:`Date selection view` section for more details of selecting valid from date #. Valid to Specify a date that the pass is expired if required. Refer :ref:`Date selection view` section for more details of selecting valid from date .. _Ref174435328: Pass data view """""""""""""""""""""""""""""""""""""""""""" Pass data represents :ref:`pass type` with the data as shown below. .. figure:: Images/chapter_control_panel/image812.PNG :width: 283 :figclass: align-center Pass data view #. Remove button Remove pass data from the pass. #. Pass type Pass type from :ref:`pass types` . #. Pass data Pass data. This cannot be empty or duplicated in the pass. .. _Ref174435981: Date selection view """"""""""""""""""""""""""""""""""""""""""""""""" Date selection view is used to select/edit pass start and end date as below. .. figure:: Images/chapter_control_panel/image814.PNG :width: 305 :figclass: align-center Date selection view #. Selected date #. Date picker button This is showing a date picker to select date. #. Time picker button This is showing a time picker to select time. #. Remove date button Clear selected date and time. Assign pass data from history """""""""""""""""""""""""""""""""""""" NCheck server keeps employee and visitor unidentified event data including biometrics data and id data. Unidentified biometric data can be used to enroll employees and visitors as mentioned in :ref:`Enroll from history` section. Unidentified id data can be used to create passes. Assign pass data from history dialog is shown below. .. figure:: Images/chapter_control_panel/image816.PNG :width: 471 :figclass: align-center dialog to select an unidentified event data #. :ref:`Unidentified id data filter view` #. :ref:`Unidentified id data list view` #. Add button Add selected unidentified id data as pass data. #. Close button .. _Ref174439508: Unidentified id data filter view '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' Filter all unidentified id data as below. .. figure:: Images/chapter_control_panel/image818.PNG :width: 473 :figclass: align-center Unidentified id data view #. From Retrieve unidentified id data from specified date. By default, this is the current date. #. To Retrieve unidentified id data to specified date. By default, this is the current date. #. Identification types Unidentified id data type as user id, barcode, RFID or vehicle number plate. #. Filter by group Retrieve unidentified id data from selected user group. #. Search button .. _Ref174439514: Unidentified id data list view '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' All filtered unidentified id data list is showing in this area. .. figure:: Images/chapter_control_panel/image820.PNG :width: 301 :figclass: align-center Unidentified id data list view #. :ref:`Unidentified id data view` #. Unidentified id data paging .. _Ref174439486: Unidentified id data view ''''''''''''''''''''''''''''''''''''''''''''''''''''''' The unidentified Id date view shows captured id data details as below. .. figure:: Images/chapter_control_panel/image822.PNG :width: 142 :figclass: align-center unidentified id data view #. Delete button Delete unidentified id data. #. Unidentified id data type icon #. More details of unidentified events as shown in :numref:`Ref174439431` . #. Modality User id, RFID, Barcode, license plate #. Time Unidentified event time #. Latitude and longitude Location coordinate where unidentified event recorded. #. Address Address where unidentified event recorded. #. Unidentified id data #. Unidentified event time. Select existing pass +++++++++++++++++++++++++++++++++++++++ .. _Ref174439431: .. figure:: Images/chapter_control_panel/image824.PNG :width: 372 :figclass: align-center Unidentified event details dialog Select pass existing dialog allows to assign existing passes for employees and visitors as below. .. figure:: Images/chapter_control_panel/image826.PNG :width: 478 :figclass: align-center #. :ref:`Existing pass management view` #. Review button Review and update selected pass if any changes required. This will open :ref:`update pass assignment` dialog. #. Assign button Assign selected pass to the employee or visitor. #. Close button .. _Ref174440500: Existing pass management view """"""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image827.PNG :width: 554 :figclass: align-center Pass management view #. New button Add new pass. Refer :ref:`Create/update pass assignment` section for more information. #. Advanced menu #. Import menu Refer :ref:`Import pass data` section for more information. #. Export meu Refer :ref:`Export pass data` section for more information #. :ref:`Pass filtering view` #. :ref:`Pass list view` #. :ref:`Pass quick view` .. _Ref174440851: Pass filtering view ''''''''''''''''''''''''''''''''''''''''''''''''' Filter pass list bypass name, pass type and pass status as follows. .. figure:: Images/chapter_control_panel/image829.PNG :width: 347 :figclass: align-center Pass filtering view #. Pass name Search bypass name #. Pass type Pass type as user ID, Barcode, RFID, License plate or any. #. Pass status Pass status as assigned or unassigned #. Search button .. _Ref174440864: Pass list view '''''''''''''''''''''''''''''''''''''''''''' .. figure:: Images/chapter_control_panel/image831.PNG :width: 270 :figclass: align-center Pass list view All available passes are showing in a :ref:`Data table` . .. _Ref174440870: Pass quick view ''''''''''''''''''''''''''''''''''''''''''''' The pass quick view shows pass data as follows. .. figure:: Images/chapter_control_panel/image833.PNG :width: 431 :figclass: align-center Pass data quick view #. :ref:`Pass data view` #. :ref:`Pass assignment view` .. _Ref174440905: Pass data view '''''''''''''''''''''''''''''''''''''''''''' .. figure:: Images/chapter_control_panel/image835.PNG :width: 436 :figclass: align-center Pass data view #. Pass name #. Pass data All available pass data are showing in this area. #. Update button Update pass data. Refer section for more details. #. Delete button Delete pass data. .. _Ref174440909: Pass assignment view '''''''''''''''''''''''''''''''''''''''''''''''''' Pass assignment view shows details of the employee and visitor who use the pass. .. figure:: Images/chapter_control_panel/image837.PNG :width: 282 :figclass: align-center Pass assignment view #. Number of pass assignments. #. Employee or visitor details First name and last name of the user type (E for employee and V for visitor) uses the pass including option to unassign pass. .. _Ref174440876: Import pass data '''''''''''''''''''''''''''''''''''''''''''''' Import pass option is used to import pass and pass assignments data. .. figure:: Images/chapter_control_panel/image839.PNG :width: 374 :figclass: align-center Pass data import view To import pass data, #. Select data needs to be imported #. Select Start import button Select Start import button to select pass data file. Refer :ref:`Select import location` for more details. .. _Ref174440879: Export pass data '''''''''''''''''''''''''''''''''''''''''''''' Export pass and pass assignment data. Pass data export view is shown below. .. figure:: Images/chapter_control_panel/image841.PNG :width: 377 :figclass: align-center Pass data export view To export pass data, #. Select the pass data to export. #. Start export button Select start export button to select the event log export location. Refer :ref:`Select export location` for more details .. _Ref174359717: .. _tooltip_user_employee_biometrics_title: Manage biometric data ---------------------------------------------------------------------------------------------------------- .. _tooltip_user_employee_biometrics_desc: Biometric data is used to identify users when recording attendance from client applications. At least once biometric should be enrolled to identify employee or visitor from client applications. Biometric data dialog is using to manage employee and visitor biometric data, .. figure:: Images/chapter_control_panel/image843.PNG :width: 404 :figclass: align-center Add biometrics view #. Enrolled biometrics #. :ref:`Enroll from history` #. Menu for :ref:`Capture from client applications` #. Menu for :ref:`Upload biometric image` #. Delete button #. Close button .. _Ref174359764: .. _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 employee/visitor while recording attendances, are kept in NCheck server. These biometric images can be used to enroll users. In the Select from history window, .. figure:: Images/chapter_control_panel/image845.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 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:`Ref174360096` . .. _Ref174360096: .. figure:: Images/chapter_control_panel/image847.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 each page. #. Timeline 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 shows all error messages could appear. #. 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/chapter_control_panel/image849.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. #. Biometric image #. Close button .. _Ref174359781: Capture from client applications ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Biometrics can be enrolled through the NCheck client applications such as NCheck Attend for Windows and Android and NCheck Admin for Windows and Android. To capture .. figure:: Images/chapter_control_panel/image851.PNG :width: 243 :figclass: align-center Menu for capture biometrics from client applications #. Select biometric capture type from 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 Attend clients` #. :ref:`Capture face from Admin clients` #. :ref:`Capture fingerprint from Admin clients` #. :ref:`Capture iris from Windows Admin client` The error messages that could appear when capture biometric from clients are shown below. .. list-table:: Error messages when capture biometrics :widths: 1435 6210 * - Error code - Description * - 3007 - The 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 been enrolled for another user * - 2038 - Could not enroll in biometrics. The device has been blocked .. _Ref174359880: Capture face from Attend clients """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. list-table:: Face enroll views for Attend client :widths: 1075 7560 * - Windows Attend client - .. figure:: Images/chapter_control_panel/image853.PNG :width: 407 :figclass: align-center Windows Attend client face capture view * - Android Attend client - .. figure:: Images/chapter_control_panel/image855.PNG :width: 176 :figclass: align-center Android Attend client face capture view #. Camera preview #. Face rectangle (Admin client only) #. Capture button Select capture button to capture face image in Attend client. In Windows Admin, select the 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 allow them to capture a single image before uploading. #. 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 upload to the server. #. Android Attend client resolution menu #. Change front/back camera button .. _Ref174359886: Capture face from Admin clients """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. list-table:: Face enroll views for Admin clients :widths: 1075 7560 * - Windows Admin client - .. figure:: Images/chapter_control_panel/image857.PNG :width: 386 :figclass: align-center Windows Admin client face capture view * - Android Admin client - .. _Ref174360151: .. figure:: Images/chapter_control_panel/image859.PNG :width: 141 :figclass: align-center Menu of Android Admin client face capture view .. figure:: Images/chapter_control_panel/image861.PNG :width: 167 :figclass: align-center Android Admin client face capture view #. Camera preview #. Face rectangle (Admin client only) #. Capture button Select capture button to capture face image in Attend client. In Windows Admin, select the 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 are allowed to capture a single image before uploading. #. 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 upload to the server. #. Menu of Android Admin client face capture view as shown in :numref:`Ref174360151` . #. Switch camera Change front/back camera #. Resolution Camera resolutions dialogue .. _Ref174359889: Capture fingerprint from Admin clients """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. list-table:: Fingerprint enroll views for Admin clients :widths: 1075 7110 * - - Admin client * - Windows - .. _Ref174360190: .. figure:: Images/chapter_control_panel/image863.PNG :width: 454 :figclass: align-center Windows Admin client fingerprint capture view * - Android - .. figure:: Images/chapter_control_panel/image865.PNG :width: 217 :figclass: align-center Android Admin client fingerprint capture view #. Fingerprint scanner name (Windows Admin client only) #. Fingerprint scanner status #. Android Admin client is Showing “Fingerprint capturing” message if the scanner is available. Otherwise “Fingerprint reader not available” #. Windows Admin client is showing fingerprint icon as shown in :numref:`Ref174360190` 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 Admin client allows to capture multiple fingerprint images. Android Admin client allows to capture only single fingerprint image before uploading. #. Cancel button (Windows client only) #. Continue button In Windows Admin client, select continue button to upload captured fingerprint images. Android Admin client will upload the fingerprint image automatically once it captured successfully. .. _Ref174359894: Capture iris from Windows Admin client """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. figure:: Images/chapter_control_panel/image867.PNG :width: 503 :figclass: align-center Windows Admin client iris capture view #. Iris preview #. Iris scanner name #. Captured iris image list #. Cancel button #. Continue button Upload captured iris images to the server. .. _Ref174359793: Upload biometric image ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image869.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 occur by 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. Capture ID data ---------------------------------- NCheck control panel provides a feature to capture id data such as barcode and RFID when launching control panel from the client application. Client application provides the following capturing methods. #. :ref:`Capture barcode` #. :ref:`Capture RFID` .. _Ref174361374: Capture barcode +++++++++++++++++++++++++++++++++++++++++++++++++++++++ Once launching NCheck control panel from Admin client application, barcode capturing button will appear next to the barcode field as follows. .. figure:: Images/chapter_control_panel/image871.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:`Ref174362231` . .. _Ref174362231: .. list-table:: Capturing barcode from Client applications :widths: 1525 7467 * - Android client - #. Main menu .. figure:: Images/chapter_control_panel/image873.PNG :width: 250 :figclass: align-center Barcode capture view of the Android client #. Switch camera #. Change resolution #. Barcode scan area The :numref:`Ref174361951` is showing the error message that could be appeared. * - Windows client - #. Select the barcode text field #. Scan the barcode from the connected barcode scanner The :numref:`Ref174361951` is showing an error message that could be appeared. .. _Ref174361951: .. list-table:: Error message of capture barcode :widths: 1435 6210 * - Error code - Description * - 3005 - Barcode scanner could not be found. * - 2039 - Could not capture barcode. The device has been blocked .. _Ref174361378: Capture RFID ++++++++++++++++++++++++++++++++++++++++++++++++++++ Once NCheck control panel is launched from Admin client application, RFID capturing button will appear next to the barcode field as follows. .. figure:: Images/chapter_control_panel/image875.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:`Ref174362216` . .. _Ref174362216: .. list-table:: Capturing RFID from Client applications :widths: 1885 7107 * - Android client - #. RFID scan view appears as :numref:`Ref174362138` .. _Ref174362138: .. figure:: Images/chapter_control_panel/image877.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:`Ref174362173` is showing the error message could appear. * - Windows client - #. Select the RFID text field #. Scan the RFID from the connected RFID scanner #. RFIC id will appear in the RFID field. The :numref:`Ref174362173` is showing the error message could be appeared. .. _Ref174362173: .. 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 .. _Ref174480324: Employee/visitor profile picture ------------------------------------------------------------------------ .. figure:: Images/chapter_control_panel/image879.PNG :width: 328 :figclass: align-center Profile picture view #. :ref:`Profile picture from the local file system` #. :ref:`Profile image from unidentified image` .. _Ref174480158: Profile picture from the local file system ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Select the profile picture from the local file system. After selecting the image, crop view allows to crop the user image as shown in figure .. figure:: Images/chapter_control_panel/image881.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 .. _Ref174480163: .. _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 users when recording the attendances are known as unidentified images. Users can select the user profile image from these unidentified images. .. figure:: Images/chapter_control_panel/image883.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 .. _Ref33715114: Import and Export information -------------------------------------------------------------------- NCheck user information can be exported 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 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 encrypted 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 supports AES 256 encryption method to extract exported zip file. .. _Ref43362353: .. figure:: Images/chapter_control_panel/image885.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 The 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’s 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. #. 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 shown in Import and Export information section. Unlike other information administrators feel 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/chapter_control_panel/image887.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/chapter_control_panel/image889.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/chapter_control_panel/image891.PNG :width: 660 :figclass: align-center CSV template view of User/user group location restriction information #. 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/chapter_control_panel/image893.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/chapter_control_panel/image895.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 The timestamp for the checkout start time to prevent early checkouts. #. Checkout end The 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/chapter_control_panel/image897.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/chapter_control_panel/image899.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/chapter_control_panel/image901.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/chapter_control_panel/image903.PNG :width: 641 :figclass: align-center #. Start Date Leave start day #. End date Leave end day #. Created at Leave created date in the NCheck server #. leave type #. Employee code .. _Ref30676624: Event logs information +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image905.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 #. Max OT .. _Ref31024161: .. _Ref30676393: Select import location +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ This view allows to browse files In the local file system for operations in NCheck system. .. figure:: Images/chapter_control_panel/image907.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 messages that could appear 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 errors occurred during data import. Please contact administrator or NCheck 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 system. .. figure:: Images/chapter_control_panel/image909.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 opened via Microsoft Windows default extractor. You may use any third-party software which supports encrypted files extraction. .. figure:: Images/chapter_control_panel/image911.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 that could appear 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 errors occurred during data export. Please contact administrator or NCheck support for more details. .. _Ref30676334: Download exported files """""""""""""""""""""""""""""""""""""""""""""""""""" .. _Ref30676344: Download files to the local file system. .. _Ref34383429: Save to FTP location +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ This view allows to set FTP location details for file save operations in NCheck server .. figure:: Images/chapter_control_panel/image913.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 are required #. FTP Username #. FTP password Report parameters ------------------------------------ All report parameters can be explained using the following figure. .. figure:: Images/chapter_control_panel/image915.PNG :width: 486 :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: .. _Ref136506859: .. _tooltip_report_parameter_work_hours_title: Work hours (HW) +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_work_hours_desc: Total summation of time differences between consecutive check-ins and check-outs. .. figure:: Images/chapter_control_panel/image917.PNG :width: 222 :figclass: align-center .. _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` . .. figure:: Images/chapter_control_panel/image918.PNG :width: 222 :figclass: align-center .. _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/chapter_control_panel/image919.PNG :width: 619 :figclass: align-center According to the Figure this can be defined. .. figure:: Images/chapter_control_panel/image920.PNG :width: 536 :figclass: align-center .. _Ref181276017: .. _tooltip_report_parameter_shift_hours_title: Shift hours ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_shift_hours_desc: The number of hours between shift starts andendsd. .. _Ref30675033: .. _tooltip_report_parameter_shift_work_hours_title: Shift work hours (HS) ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_shift_work_hours_desc: The number of hours should be covered within the shift. .. _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)` .. figure:: Images/chapter_control_panel/image921.PNG :width: 166 :figclass: align-center .. _Ref30676875: .. _tooltip_report_parameter_non_productive_hours_title: Unproductive hours +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image922.PNG :width: 131 :figclass: align-center .. _Ref180744616: .. _Ref30676864: .. _tooltip_report_parameter_overtime_hours_title: Max overtime hours (OTMAX) ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_overtime_hours_desc: Maximum overtime hours per person can complete during the shift. .. _Ref180744611: .. _tooltip_report_paramter_overtime_hours_title: Overtime hours +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_paramter_overtime_hours_desc: Overtime hours can be defined as .. figure:: Images/chapter_control_panel/image923.PNG :width: 262 :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/chapter_control_panel/image924.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 starts 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 starts 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. .. _Ref181275686: .. _tooltip_report_parameter_actual_break_hours_title: Actual break hours ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_actual_break_hours_desc: Total beak hours the employee has taken from the available break hours. .. _Ref30676903: .. _tooltip_report_parameter_efficency_title: Efficiency ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_efficency_desc: The ratio between :ref:`Productive hours (HP)` and work time is defined for the shift. .. _Ref31026193: .. _tooltip_report_parameter_event_log_count_title: Event logs count ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_event_log_count_desc: Number of events for the 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 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 employees 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. .. _Ref181275721: .. _tooltip_report_parameter_attendance_title: Number of attendances +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_attendance_desc: Number of attendees in the selected date range. .. _Ref31026213: .. _tooltip_report_parameter_replacements_title: Replacements +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_replacements_desc: Depending on the organization requirement such as handling the work load manage absentees, additional employee(s) can be added to a specific roster item as mentioned in :ref:`Add/edit schedule item` section. This parameter shows the number of additional user(s)/employee(s) replaced for the user/employee in such cases. .. _Ref181284246: Employee status +++++++++++++++++++++++++++++++++++++++++++++++++++++++ The statuses are #. Active #. Block The block employee cannot record attendance. #. Terminate The terminated employees are not shown in the system. .. _Ref181292746: Deleted employee ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The employee is deleted or not. .. _Ref181292727: Terminated date +++++++++++++++++++++++++++++++++++++++++++++++++++++++ The terminated date and time of the employee if terminated. .. _Ref108705710: .. _tooltip_report_parameter_time_spent_title: Time spent ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_time_spent_desc: The time spent on the appointment. This is an addition of time difference of consecutive check-in and check-outs. .. _Ref108705670: .. _tooltip_report_parameter_appointments_title: Appointments ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_appointments_desc: Number of appointments booked by visitors. .. _Ref108705679: .. _tooltip_report_parameter_present_title: Present ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_present_desc: Number of visitors who made either access or attendance event for the appointment. .. _Ref108705685: .. _tooltip_report_parameter_access_visitors_title: Access visitors ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_access_visitors_desc: Number of visitors who made access to events for the appointment. .. _Ref108705692: .. _tooltip_report_parameter_attendance_visitors_title: Attendance visitors ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_attendance_visitors_desc: Number of visitors who made attendance(check-in/check-out) events for the appointment. .. _Ref108706162: .. _tooltip_report_parameter_appointment_status_title: Appointment status ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_appointment_status_desc: Appointment status as mentioned in :ref:`Appointment completion status` section. .. _tooltip_report_parameter_approval_status_title: Appointment approval status +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_report_parameter_approval_status_desc: Appointment approval status as mentioned in :ref:`Appointment approval status` section. .. _Ref178763592: Data table -------------------------------------------------- Data table is a controller which is used to represent a large list of data. The main advantages of using data tables are, #. Reduce data retrieval time Retrieve data page by page according to the user requirement when large list of data available. #. Data filtering #. Data sorting #. Show/hide data columns. The data table is shown below. .. figure:: Images/chapter_control_panel/image925.PNG :width: 597 :figclass: align-center Data table #. :ref:`Table header` #. Table content area #. Selected row #. :ref:`Table paging options` .. _Ref32402432: .. _Ref32565608: Table header +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_control_panel/image927.PNG :width: 679 :figclass: align-center Figure . Table header column view #. Check/uncheck to select/deselect all data rows in the content area. #. Sorting icon Click on each column name to sort column data. The sorting icon appears next to the column name according to the currently applied sorting as shown in :numref:`Ref178760252` . #. :ref:`Table menu` .. _Ref178760252: .. _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/chapter_control_panel/image929.PNG :width: 27 :figclass: align-center - Columns will be sorted in ascending order * - .. figure:: Images/chapter_control_panel/image930.PNG :width: 32 :figclass: align-center - Columns will be sorted in descending order .. _Ref181180693: Table content area ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ All the data are shown in this area as rows. A content row may have followed information. .. figure:: Images/chapter_control_panel/image931.PNG :width: 419 :figclass: align-center Data table row #. Row selection Checkbox to select/de select record. This allows to select multiple rows from the table and perform available actions for selected rows as mentioned in :ref:`Actions view` section. #. Row data area Represent record details #. :ref:`Quick access menu` .. _Ref178920888: Quick access menu """"""""""""""""""""""""""""""""""""""""""""""" The quick access menu is used to show important operation of each data row represent in the data table. .. _Ref179873204: .. _Ref179873242: Actions view """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""" The Actions menu appears on the top of the data table once select row(s) as shown below. .. figure:: Images/chapter_control_panel/image933.PNG :width: 668 :figclass: align-center Actions menu for employee table #. Selected employee rows #. Actions menu A specific operations available for selected rows in the table. This operation may change according to the data that appears in the data table. #. Number of selected rows To clear the selection, select clear button next to the selected rows. .. _Ref32565818: Table menu +++++++++++++++++++++++++++++++++++++++++++++++++ Over the NCheck control panel, a list of data is representing using data tables. The following features are available in the data table. .. figure:: Images/chapter_control_panel/image935.PNG :width: 136 :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. #. The visible icon appears before the visible column name. Click to hide the column from the table. #. The hidden icon appears before the hidden column name. Click to visible the column in the table. .. _Ref32402632: Table paging options +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ The main advantage of using a data table is retrieving data page by page to reduce the data retrieval time when there is large amount of data. Table paging options allow you to navigate between pages. .. figure:: Images/chapter_control_panel/image937.PNG :width: 524 :figclass: align-center Figure . Table paging view #. Button to navigate to the first page. #. Button to navigate to the previous page. #. Current page number out of number of pages available #. Button to navigate to the next page. #. Button to navigate to the last page. #. Number of rows per page. The available options are 20, 50 100. #. Number of rows available in the current page out of total number of rows Control panel settings ----------------------------------------- Administrator allows to configure below mentioned settings in the NCheck 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 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _Ref136330733: .. _Ref31026487: .. _tooltip_server_control_panel_general_settings_shift_start_and_end_time_title: Default shifts start and end time """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_general_settings_shift_start_and_end_time_desc: The default shift start time is 00.00.00 and end time is 23.59.59. The shift start time, and duration can be selected within 7 days period. .. figure:: Images/chapter_control_panel/image939.PNG :width: 656 :figclass: align-center Default shift starts and end time view #. Default shifts start time #. Duration in hours and minutes The duration can be selected between shift start and 7 days. #. Default shift end time Default shift end time in days, hours, and minutes #. Save button #. Reset button .. _Ref143706163: .. _tooltip_server_control_panel_general_settings_check-in_restriction_title: Restrict check-in time below interval """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_general_settings_check-in_restriction_desc: Restrict user check-ins before and after the default shift start. .. figure:: Images/chapter_control_panel/image941.PNG :width: 608 :figclass: align-center Check-in time restriction view #. Check-in start Number of hours restrict check-ins before shift start. The default value is Minimum (Default shift end -24 hours, Default shift starts). Check-in start hours could be between shift start and (Default shift start -24 hours). #. Check-in end Number of hours restrict check-in after default shift start. The default value is default shift end. Check-in end could be between the default shift end and 7 days. #. Save button #. Reset button .. _Ref143706169: .. _tooltip_server_control_panel_general_settings_check-out_restriction_title: Restrict check-out time below interval """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_general_settings_check-out_restriction_desc: Restrict user check-outs before and after the shift end. .. figure:: Images/chapter_control_panel/image943.PNG :width: 606 :figclass: align-center Check-out time restriction view #. Check-out start Number of hours restrict check-out before the shift end. The default value equals to shift start. Check-out start restriction could be a value between (shift start. - 24 hours) and 7 days. #. Check-out end Number of hours restrict check-out after the shift end. The default value is minimum (shift start + 24 hours, shift end). The check-out end restriction could be a value between 0 hours and 7 days. .. _Ref144910823: .. _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. The 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: The start date of the month for the organization. The default is the 1st day of the month. .. _Ref136005104: .. _tooltip_server_control_panel_general_settings_year_start_month_title: Year start month """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_general_settings_year_start_month_desc: The start month of the year for the organization. The default year starts is January. .. _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 controls default shift selection. The default is Allow when other shifts are 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. .. _tooltip_server_control_panel_general_settings_auto_re_evaluate_eventlogs_title: Auto re-evaluate eventlogs """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_general_settings_auto_re_evaluate_eventlogs_desc: The order of the checkin checkout events for people is very important because it has significant impact on reporting. The order might be changed due to several reasons. #. User record check-in but forget to record checkout #. User record check-in and check out several client devices at the same time. when clients synchronize eventlogs, the order might be changed To prevent this problem, auto evaluate eventlogs will automatically check eventlogs for each person add events at the end of the checkout, end of the current shift as following options. #. Disabled The existing event will be kept as it is. #. Re-order check-in check-out pairs Add check-out event for each check-in event at the checkout end of the current shift. #. First check-in and last check-out Change first event as check-in and last event as check-out in the current shift. The rest of the event in between first check-in and last check-out will be access events. .. _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, the administrator gets email or control panel notification if a user who is 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: The number of maximum unidentified events 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. .. _Ref213317442: .. _tooltip_server_control_panel_general_settings_eventlog_images_retention_period_title: Event log images retention period """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_general_settings_eventlog_images_retention_period_desc: NCheck server keeps event log image (The face, finger or iris biometric image that captured from the client devices to record user attendance events) with the event log and this may require space when the number of event logs increases with the time. To overcome this issue, you can delete old event log images and keep only the event thumbnail specifying the number of months. .. _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 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 cloud, enable this setting to activate Admin 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 Admin 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 (Admin clients) or record the event as either check-in or check-out. Following capture start modes can be selected 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 Admin 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 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 Admin clients when the offline mode is enabled. The 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 records to prevent duplicate records in seconds. The 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 sent to the NCheck server for user identification. Time took to record attendance can be dependent 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 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_kiosk_mode_desc: Attend and Admin clients registered to employee groups are used by the employees/visitors to record their attendances. It’s better to hide options because any employee/visitor can take control. In this case, if the device is in Kiosk mode, it hides a lot of features from the device to prevent ordinary employees and visitors success from it. .. _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 Attend for Android can be given here. Exit code is empty by default. .. _Ref180094926: .. _tooltip_server_control_panel_device_settings_client_mocde_title: Client mode """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_client_mocde_desc: This client mode has two options #. Attendance mode #. Web mode Refer :ref:`Registration type selection view` section for more information about attendance and web modes .. _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 Attend clients that 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 preference of Android and IOS Attend clients. #. Always use predefined The location coordinates will be taken from the predefined location. The predefined location view will appear as follows either prefer GPS over predefined or always use predefined is selected. .. figure:: Images/chapter_control_panel/image945.PNG :width: 407 :figclass: align-center Predefined location view #. Name of the predefined location #. Longitude and latitude of the predefined location #. Add/edit predefined location Predefined location can be added as mentioned below. The predefined location view is shown below. .. figure:: Images/chapter_control_panel/image947.PNG :width: 300 :figclass: align-center Add/edit predefined location #. Name #. Description #. Time zone Time zone of the predefined location. #. Latitude coordinate #. Longitude coordinates #. Address #. Select the location from the map. Selected the latitude and longitude coordinates from the map as configured from :ref:`Location map provider` setting. #. Update button .. _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 Attend for Android registered for a user allows to enroll face template during attendance recording if no template has enrolled for a user. Refer :ref:`Enroll biometrics` section for more details. .. _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 Attend 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. #. IOS 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 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 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_hide_user_list_on_windows_client_desc: Enable this setting to hide the view which is showing recent events in Attend and Admin clients. .. _Ref136008961: .. _tooltip_server_control_panel_device_settings_multiface_mode_title: Multi face mode """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_multiface_mode_desc: Enable this setting to enable multi face capturing mode in NCheck Atten clients. .. _Ref136006358: .. _tooltip_server_control_panel_device_settings_cancel_event_buton_title: Cancel event button in the feedback view """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_cancel_event_buton_desc: The cancel button in the client feedback view allows to cancel the event after recording. If this setting is disabled, cancel button will not be visible in the clients. .. _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 user attendance from NCheck Attend 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 users to select check-in/checkout when the multi-face capturing mode (Refer Attend client section for more details about multi face mode) is enabled in the NCheck Attend client devices. This setting has been enabled by default. .. _Ref213322052: .. _tooltip_server_control_panel_biometric_settings_server_face_liveness_title: Server-side face liveness setting """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_biometric_settings_server_face_liveness_desc: Server-side face liveness setting can be used to check live faces of the captured face images from NCheck client applications from the server. The available server-side face liveness options are #. Disabled The server-side face liveness is disabled. #. Detect The attendance will be recorded if the face image is captured from a live face. #. Required The attendance event will be recorded if it is recorded with the live face and the liveness score giving from the algorithm is greater than the :ref:`Server face liveness confidence threshold` . .. _Ref213321961: .. _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. .. _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: This feature available for NCheck Admin clients to prevent recording attendance with non-live faces such as photos and videos. When the client-side face liveness is enabled, the user face must be placed in the face oval in the camera preview and keep still until the liveness checks are completed by the client application. This may take 2-3 seconds when the face is clearly visible to the camera. The available options are #. Disabled The face liveness is disabled. #. Detect The attendance will be recorded if face image is captured from a live face. #. Required The attendance event will be recorded if it is recorded with the live face and the liveness score giving from the algorithm is greater than the :ref:`Face liveness threshold for client application` . .. _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. .. _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 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. The 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. The default face quality value is 40. Face quality will be 0, if the “Mask detection” setting is set to detect or required. .. _Ref136329391: .. _tooltip_server_control_panel_device_setting_mask_detection_title: Mask detection """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_setting_mask_detection_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. This feature is available for NCheck Admin clients only. There are 3 mask detection options available. #. Disable 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 Admin client - Indicator of Android Admin client * - Mask detection score >= Mask detection threshold - .. figure:: Images/chapter_control_panel/image949.PNG :width: 68 :figclass: align-center - .. figure:: Images/chapter_control_panel/image950.PNG :width: 76 :figclass: align-center * - Mask detection score < Mask detection threshold - .. figure:: Images/chapter_control_panel/image951.PNG :width: 60 :figclass: align-center - .. figure:: Images/chapter_control_panel/image952.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 Admin client - Indicator of Android Admin client * - Mask detection score >= Mask detection threshold - .. figure:: Images/chapter_control_panel/image949.PNG :width: 68 :figclass: align-center - .. figure:: Images/chapter_control_panel/image950.PNG :width: 76 :figclass: align-center * - Mask detection score < Mask detection threshold - .. figure:: Images/chapter_control_panel/image953.PNG :width: 64 :figclass: align-center - .. figure:: Images/chapter_control_panel/image954.PNG :width: 77 :figclass: align-center .. _Ref136334928: .. _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. .. _Ref213323375: .. _tooltip_server_control_panel_device_settings_hat_detection_title: Safety helmet detection """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_hat_detection_desc: Due to some safety measures, in some use cases such as construction, moto mechanics employees must wear face covering such as safety helmets. The setting can be used to restrict the face covering when employees record attendance in such use cases. This feature is available for NCheck Admin clients only. There are 2 available options for face covering detection #. Disabled No face covering is required to record attendance. #. Detect Attendance event can be recorded without a face covering. But there will be a hat indication with orange color in the face preview if employee is not wearing a safety helmet. #. Required Attendance event will not be recorded if the face covering score giving by the algorithm is less than the :ref:`Safety helmet detection threshold` . In this case there will be red color hat indication on the face preview. .. _Ref213323135: .. _tooltip_server_control_panel_device_settings_hat_detection_threshold_title: Safety helmet detection threshold """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_device_settings_hat_detection_threshold_desc: Decrease the value, if a user face with a safety helmet is not identified as mentioned in “Safety helmet detection” settings. .. _Ref136328878: .. _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. .. _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 is 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 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 iris 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 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: The 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: Users must select appropriate font from this setting to export report successfully according to 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: Location map provider """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_server_control_panel_web_settings_event_log_location_map_provider_desc: Select map provider to configure map. 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 user’s event logs according to the selected map provider in :ref:`Event log location map provider` setting. Visitor parameters ------------------------------------- .. _Ref108077599: Slot time +++++++++++++++++++++++++++++++++++++++++++++++++ Slot time divides schedule time into appointment booking time slots and visitor appointments can be booked in a selected time slot. Default slot time is 0 and then it takes the whole schedule period as a single slot. .. _Ref108077604: Slot occupancy ++++++++++++++++++++++++++++++++++++++++++++++++++++++ Number of appointments per slot. The default value is 0 and then it can book any number of appointments per slot. .. _Ref108077608: Automatic approval of visit requests ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Enable this setting to approve visitor appointments automatically created from online or kiosk pages. Otherwise NCheck administrator must approve the appointments before visit. .. _Ref129300009: Reservation time out ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Selected booking on hold time to prevent booking anyone else in online and registration device booking pages. This period is known as reservation time out. .. _Ref108077613: Biometric collection ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Select biometric modality to collect selected biometric modality from registration Kiosk devices. Following biometrics type can be configured. #. None No biometric required #. Face #. Finger #. Iris .. _Ref108077617: .. _tooltip_control_panel_schedules_and_locations_additional_settings_pass_type_title: Pass type +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_control_panel_schedules_and_locations_additional_settings_pass_type_desc: Defines the pass type used to read when existing pass is used or issue when generated pass is used from Kiosk or in online appointment booking. RFID passes can be issued only from registration Kiosk devices. Pass type can be configured as follows. #. ID A unique identification number #. Barcode #. RFID .. _Ref109129399: .. _tooltip_control_panel_schedules_and_locations_additional_settings_pass_generation_title: Visitor pass generation +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_control_panel_schedules_and_locations_additional_settings_pass_generation_desc: When an appointment is booked, it can use an existing or generated pass. Pass generation settings allow to configure it. Pass generation can be configured as below. #. Always generated and not re-used The visitor pass is generated by the NCheck system. #. Generate if not available and re-use Visitor allows to use previous visitor pass. If a visitor has no previous pass, NCheck will generate a new pass. #. Printed pass no reusing NCheck allows to create appointments using visitor pass newly generated by 3rd party. #. Printed pass with re-use NCheck allows to create appointments with used visitor pass (3rd party generated) in previous visit. .. _Ref108077625: Custom visitor feedback view ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Default Feedback view of NCheck client application when Visitor is identified can be changed with custom visitor feedback view. Custom visitor feedback views can be available for some visit types and can also be added to the system as an extension on request. .. _Ref108077629: .. _Ref118883169: Online booking +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Enable or disable online appointment booking for the visit schedule. By enabling this setting, the following settings will be available to configure. #. :ref:`Allow visitors to download pass` .. _Ref109127568: .. _tooltip_control_panel_schedules_and_locations_additional_settings_download_pass_title: Allow visitors to download pass """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. _tooltip_control_panel_schedules_and_locations_additional_settings_download_pass_desc: Enable or disable downloading generated pass from online appointment submission. .. _Ref108077634: Book appointments from walk in kiosk ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Enable or disable kiosk appointment booking for the visit schedule. By enabling this setting, the following setting will be available to configure. .. _Ref108077637: Allow change appointment time +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Enable, disable changing appointment start time on visitor appointment booking online or from registration Kiosk devices. The default appointment start time is booking shift/time slot start. By enabling this setting, :ref:`Use default appointment end time` will be shown. .. _Ref109127603: Use default appointment end time """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" Enable, disable changing appointment end time on visitor appointment booking online or from registration Kiosk devices. Default appointment end time is booking shift/time slot end.