GETTING STARTED ================================ This getting started document guides you to setup your NCheck system and perform the initial configuration of the attendance control system. You can follow the steps below to set up and configure the system and start attendance recording. #. :ref:`Planning your attendance management system` #. :ref:`Start the attendance management system` #. :ref:`Set up attendance management system` #. :ref:`Launch web control panel` #. :ref:`Set up client devices` .. _Ref28945833: Planning your attendance management system ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ NCheck can support employee time attendance of any organization from small offices to large multi-site organizations. It is scalable from a single standalone device to thousands of devices distributed in multiple locations. Therefore, it provides the following deployment options. Deployment option is differentiate based on the place attendance data storage. .. list-table:: NCheck deployment options :widths: 2904 2898 2898 * - Deployment Option - Place of attendance data - Remarks * - Cloud Subscription - NCheck cloud - IT Expertise are not needed * - On Premises - NCheck on-premises server - Additional overhead on system maintenance * - Standalone - NCheck Admin Application - Simple cost-effective solution for small office .. _Ref31810625: Start the attendance management system ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Starting a NCheck biometric attendance management system prepares the attendance system database and the service to communicate with NCheck clients. NCheck database and the service can be set up #. Cloud - In NCheck cloud service #. On-premises – NCheck server installed in your place. .. _Ref28946085: Start an attendance management system with Cloud --------------------------------------------------------------------------------------- #. Go to NCheck `web site `_ #. Select Sign up button #. From the getting started page, select create new organization. .. figure:: Images/chapter_getting_started/image2.PNG :width: 380 :figclass: align-center Getting started page of cloud signup #. In the create account page, enter full name, email and password. Then check captcha to verify yourself and select the continue button. .. figure:: Images/chapter_getting_started/image4.PNG :width: 246 :figclass: align-center NCheck sign up view #. In the next step complete your company details including company name, country. Phone number and organization size. Select continue button. .. figure:: Images/chapter_getting_started/image6.PNG :width: 322 :figclass: align-center Company details page of the cloud signup #. In the next step you will be asked where did hear about NCheck. Check the information source from available and select the continue button. .. figure:: Images/chapter_getting_started/image8.PNG :width: 291 :figclass: align-center where did you hear about us page of cloud signup #. After that you will see the signup completion page as below. It includes NCheck. Clients download links to download client. If you need demonstration about using NCheckcloud bio attendance and visitor management system, you can request from request demonstration button. Select Go to control panel option to login to the web control panel. .. note:: Free plan will be assigned to your NCheck Cloud subscription. You can change the plan of your subscription from the administration control panel. Refer `pricing `_ for more details about available subscriptions. Start an attendance and visitor management system with the server ------------------------------------------------------------------------------------ NCheck can be set up in Windows and Linux platforms. #. :ref:`Setup NCheck server in Windows` #. :ref:`Setup NCheck server in Linux` .. _Ref131441970: Setup NCheck server in Windows ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ System requirements """""""""""""""""""""""""""" #. Microsoft Windows 8 or higher operating system #. 1GB of disk space #. 4GB of RAM #. JAVA runtime environment 11 #. One biometric capture device such as a camera, fingerprint, or iris scanner. Android and iOS, inbuild camera, Windows integrated and USB web cams are used for face capture. For other supported IP cameras, fingerprint readers and iris scanners, visit `support devices at our web site `_ Download and install """"""""""""""""""""""""""""" NCheck can be downloaded from `product downloads `_ section of the web site .. note:: Important: Your windows user account should have administrative privileges to install NCheck server. .. note:: Note: If the required Java runtime environment is not installed, Installer will ask to install Java runtime environment and stop NCheck installation. #. Run the installer. #. Activate NCheck license NCheck installer will show the license activation window After the successful installation of the server. .. figure:: Images/chapter_getting_started/image10.PNG :width: 334 :figclass: align-center Licensing window for NCheck Admin client for Windows #. Starting NCheck server NCheck server will start automatically, and server icon will be displayed in the windows tray. When the server is ready, the icon will be shown in the Windows tray as :numref:`Ref32478361` . .. _Ref32478361: .. figure:: Images/chapter_getting_started/image12.PNG :width: 132 :figclass: align-center NCheck tray icon view when the server is ready #. Finish installation Optionally, you can choose to launch Server Configuration window, NCheck Admin client and User’s guide. Completion dialog also shows the NCheck server status and TCP port of the server. .. figure:: Images/chapter_getting_started/image14.PNG :width: 404 :figclass: align-center NCheck installation completion dialogue for Windows Refer :ref:`Install for windows` section for more details about install NCheck server in Windows. .. note:: You can activate the trial for evaluation purposes. Trial activation requires permanent internet connectivity. See license activation section for more details. .. _Ref131441979: .. _Ref31810645: Setup NCheck server in Linux ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Refer `this link `_ to setup Docker image for Linux. Refer :ref:`Install On-premises server on Linux` section for more details. .. _Ref131449437: Set up attendance and visitor management system ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Following basic configuration requires to set up the attendance and management system for attendance and visitor managements #. :ref:`Launch web control panel` #. :ref:`Add new user` #. :ref:`Enroll user biometrics` #. :ref:`Create user groups (Optional)` .. _Ref31810698: Launch web control panel --------------------------------------------------------------- NCheck administration and configuration application is NCheck control panel application. This is a web-based application that can be accessed using popular web browsers using following URL. .. list-table:: Access NCheck web control panel :widths: 1890 2520 4940 * - - URL - Remarks * - Cloud - https://cloud.ncheck.net - * - On Premises - https://server:port - #. Server – Sever name or IP address #. Port – NCheck 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 client installations. This application can be launched from .. _Ref32491160: .. figure:: Images/chapter_getting_started/image16.PNG :width: 216 :figclass: align-center NCheck system tray menu view .. list-table:: Login to the NCheck control panel :widths: 2444 6572 * - Server - Right click on the NCheck server tray application icon and select “Control panel” menu item as shown in :numref:`Ref32491160` . * - Windows client - Open the application menu and select login to control panel. * - Android Client - .. 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. Sign in to web Control Panel +++++++++++++++++++++++++++++++++++++++++++++++ .. figure:: Images/chapter_getting_started/image18.PNG :width: 273 :figclass: align-center NCheck login page If you used used gmail or intuit account to sign up with NCheck cloud, you can use Gmail/intuit credentials to login with NCheck Control panel. Otherwise, you can use username and password used to sign up with NCheck cloud. For on-premises server, the default username and password are “admin”. .. _Ref32478437: .. figure:: Images/chapter_getting_started/image20.PNG :width: 651 :figclass: align-center NCheck control panel initial dashboard view After signing in, you will be landed in the NCheck Control Panel Dashboard as shown in :numref:`Ref32478437` Once you logged in first time, it will show the onboarding checklist to help you to configuring the stet Refer :ref:`Sign in to web Control Panel` section for more details about sign in NCheck control panel. When signing in second time onwards, you will be landed to the last time accessed page. If the initial required data is not set up, it will be notified to perform the initial setting up. First the users should be enrolled as mentioned in :ref:`Add new user` section. .. _Ref182392936: Add a new user ------------------------------------------------------ .. figure:: Images/chapter_getting_started/image22.PNG :width: 597 :figclass: align-center User management view of control panel #. Select the Add button to create a new user. .. figure:: Images/chapter_getting_started/image24.PNG :width: 472 :figclass: align-center NCheckr add new employyr view Refer :ref:`Add employee/visitor` section for more details about add users. After adding users, refer :ref:`Enroll user biometrics` section to enroll user biometrics. .. _Ref32491952: Enroll user biometrics ------------------------------------------------------------- User biometric is used to authenticate users in attendance recording. #. Select User #. Select “Update biometrics” button in the :ref:`Employee view` .. figure:: Images/chapter_getting_started/image26.PNG :width: 360 :figclass: align-center Launch enroll biometric for the selected user User Biometric data dialogue can be used to manage user biometric. It allows adding biometrics #. From event history #. Capture from devices such as camera, fingerprint and iris scanners using NCheck client applications. #. From images in the local file system Refer :ref:`Update employee/visitor biometrics` section for more details about enroll biometrics. .. figure:: Images/chapter_getting_started/image28.PNG :width: 351 :figclass: align-center Biometric data dialogue After enrolled user biometrics, you are allowed to Set up client or either :ref:`Create user groups (Optional)` shown in :numref:`Ref37589242` . .. _Ref37589242: .. figure:: Images/chapter_getting_started/image30.PNG :width: 362 :figclass: align-center proceed to setup clients flow .. _Ref32492815: .. _Ref32497150: Create user groups (Optional) -------------------------------------------------------------------------------------- .. figure:: Images/chapter_getting_started/image32.PNG :width: 607 :figclass: align-center User group management view User group represents multiple users, and all the settings applied to user group apply to each user representing the user group. To create the user group, #. Select User group management in the control panel. #. Select Add button User group detail dialogue is shown in below .. figure:: Images/chapter_getting_started/image34.PNG :width: 356 :figclass: align-center Group details of ass user group dialo .. figure:: Images/chapter_getting_started/image36.PNG :width: 475 :figclass: align-center Add users of the Add user group dialog Refer :ref:`Manage user Groups` section for more details about user group management. Create visitor appointment (Optional) -------------------------------------------------------- To manage visitor attendance, first an appointment must be made for each employee for the selected date as below. .. figure:: Images/chapter_getting_started/image38.PNG :width: 612 :figclass: align-center Appointment management view Select new appointment button to create appointment for visitor schedule as below. .. figure:: Images/chapter_getting_started/image40.PNG :width: 531 :figclass: align-center New appointment dialog Select appointment start and end time and visitor details and select create button to create appointment Once appointment created, to enroll biometrics for visitor select “Biometrics” button from the visitor details section of the appointment view as below. .. figure:: Images/chapter_getting_started/image42.PNG :width: 420 :figclass: align-center Visitor details of appointment view Refer :ref:`Visitor details` section for more information about updating visitor biometrics. .. _Ref31810752: .. _Ref32492252: .. _Ref32497065: .. _Ref32499390: .. _Ref28875041: Set up client devices ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. _Ref37764013: Install client application ----------------------------------------------------------------- The NCheck client applications are available for Windows, Android and IOS platforms. #. Install NCheck clients in Windows Refer :ref:`Install for windows` section for more details. #. Install NCheck clients in Android Refer :ref:`Install client for Android` section for more details. #. Install NCheck Attend client in Android Refer :ref:`Install NCheck Attend client for iOS` section for more details. .. _Ref32500971: Register client application ------------------------------------------------------------------ The Client application is required to register with the server to perform attendance recording. To register a client application. .. figure:: Images/chapter_getting_started/image44.PNG :width: 681 :figclass: align-center Register device button in the user group management view #. Go to user group management in control panel #. Select a user group #. Select Register devices button It will show the device registration dialogue shown in :numref:`Ref37589985` for the user group. To register the device, .. _Ref37589985: .. figure:: Images/chapter_getting_started/image46.PNG :width: 392 :figclass: align-center Device registration view #. Launch NCheck Admin client It should show the device registration window. #. Select On-premises option #. Enter registration token #. Search or enter server user in format. When the server is running in the same computer, it can use localhost:. Default port number is 8443. #. Select the Connect button to register. #. After Successful registration, the client application is ready for attendance recording Refer :ref:`Client registering view` section for more details. Record Attendances ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ #. NCheck Attend for Windows, Android and IOS #. Attach a camera compatible with the NCheck as mentioned in the `website `_, if it is not available. #. Face to the camera directly and select the capture button when the preview is available with the device. #. NCheck Admin for Windows and Android #. Attach a compatible biometric device (face, fingerprint or iris) with the NCheck as mentioned in the `website `_, if it is not available with the device. #. View recorded attendances Select :ref:`Manage Event logs` to view all recorded events.