SERVER ======================= Cloud server setup ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Refer :ref:`Start an attendance management system with Cloud` section for more details. .. _Ref131502612: Install On-premises server on Linux ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Refer `this document `_ to setup Docker for Linux. Once setup the Docker, follow the below sections to complete setup. #. :ref:`Prepare the program data directory` #. :ref:`Run the server` .. _Ref131496435: Prepare the program data directory -------------------------------------------------------------------------- To prepare the program data directory #. Create a directory “ProgramData” #. Copy the following license files to “ProgramData/NCheck/License” directory. #. license.lic #. config.xml .. _Ref131496440: Run the server ------------------------------------------------------ Use the following commands. #. Run the server docker run -d -p :8443 -v :/ProgramData --name ncheck ncheckadmin/bioattendance: #. Stop the server docker stop ncheck #. Start the server docker start ncheck #. Configurations Refer :ref:`Configurations` section for more details. .. _Ref130490938: Configurations ++++++++++++++++++++++++++++++++++++++++++++++++++++++ Additional Arguments can be passed as Environment variables. docker run -d -p :8443 -v :/ProgramData -e VARIABLE1=’value1’ -e VARIABLE2=’value2’ --name ncheck ncheckadmin/bioattendance: The following configurations can be used. #. :ref:`Database type (Optional)` #. :ref:`Keystore (Optional)` #. :ref:`Restore (Optional)` #. :ref:`NMatcher configuration(optional)` .. _Ref130496293: Database type (Optional) """""""""""""""""""""""""""""""""""""""""""""""""""""" Database type can be selected to configure the database to connect to HASQL, MySQL, MSSQL, Oracle. If not, HSQL will be used. For each database type (DB_TYPE) the following configuration should be used #. . SQLITE #. DB_FILE Database file name. Database will be stored in “ProgramData/NCheck/databases/server” #. MYSQL, MSSQL or ORACLE #. DB_URL Database URL. #. DB_USER_NAME Database username #. DB_PASSWORD Database password #. DB_MAX_CONNECTIONS Maximum connections for the database. Default value for connection type is 30. .. _Ref130496297: Keystore (Optional) """"""""""""""""""""""""""""""""""""""""""""""""" To setup SSL Certificate copy the keystore file (pfx) to “ProgramData”/NCheck/Keystore/. #. KEYSTORE Keystore file name #. KEYSTORE_ALIAS Keystore Alias #. KEYSTORE_PASSWORD Keystore password .. _Ref130496301: Restore (Optional) """""""""""""""""""""""""""""""""""""""""""""""" Copy the Backup file to “ProgramData>/NCheck/databases/server” #. DB_BACKUP_FILENAME Backup filename #. DB_BACKUP_PASSWORD Backup file password .. _Ref130496345: NMatcher configuration(optional) """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" #. NMATCHER_HOST NMatcher name #. NMACTHER_PORT NMacther port Install On-premises server for Windows ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Refer :ref:`Install for Windows` section for more details. Monitoring and Managing On-premises server ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ NCheck server monitoring and managing is done through the server tray. On-premises server tray ------------------------------------------ NCheck On-premises server tray provides the following options to monitor and control NCheck On-premises server. #. :ref:`Icon status` #. :ref:`Notifications` #. :ref:`Tray icon tooltip` #. :ref:`Tray icon menu` .. _Ref31882578: Icon status ++++++++++++++++++++++++++++++++++++++++++++++++++ NCheck On-premises server tray icon indicates the following status. .. list-table:: Tray icon statuses :widths: 885 3510 * - .. figure:: Images/Server/image78.PNG :width: 33 :figclass: align-center - Server is running and ready * - .. figure:: Images/Server/image79.PNG :width: 33 :figclass: align-center - Server has stopped * - .. figure:: Images/Server/image80.PNG :width: 33 :figclass: align-center - Server has stopped with errors * - .. figure:: Images/Server/image81.PNG :width: 33 :figclass: align-center - Server is running with warnings .. _Ref31882585: Notifications ++++++++++++++++++++++++++++++++++++++++++++++++++++ NCheck On-premises server notifications are showing when the status changes. Sample notifications are as follows, .. list-table:: Server tray notifications :widths: 2256 5846 * - Notification - image * - Server has started - .. figure:: Images/Server/image82.PNG :width: 353 :figclass: align-center Notification when server is started * - Server has stopped - .. figure:: Images/Server/image84.PNG :width: 371 :figclass: align-center Notification when server is stopped * - Server has ready - .. figure:: Images/Server/image86.PNG :width: 391 :figclass: align-center Notification when server is ready .. _Ref31882590: Tray icon tooltip ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Tray icon tooltip shows the following information. #. Status of the NCheck service #. Status of the NCheck On-premises server #. NCheck On-premises server database path #. NCheck On-premises server port .. figure:: Images/Server/image88.PNG :width: 463 :figclass: align-center NCheck tray icon tool tip .. _Ref31882595: Tray icon menu +++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _Ref37254907: .. figure:: Images/Server/image90.PNG :width: 218 :figclass: align-center NCheck tray icon menu #. Configuration Open NCheck On-premises server configuration as mentioned in :ref:`On-premises server configuration` section. #. Start Start NCheck On-premises server. #. Stop Stop NCheck On-premises server. #. Control panel Open the NCheck Control panel. #. NCheck Open NCheck client application for Windows. #. Application logs Open NCheck logs files folder. #. License manager Open NCheck licensing window. #. Generate diagnostic info Diagnostic info can be generated to keep track of existing problems and bugs in the NCheck On-premises server or windows client application for NCheck developers. The diagnostic file is generating in “C:/ProgramData/NCheck/Diagnostic” folder. #. Exit Exit NCheck On-premises server tray icon. .. _Ref31883576: On-premises server configuration ----------------------------------------------------------------------- NCheck On-premises server using the configuration can be applied using the NCheck configuration window. It has the following configuration sections .. figure:: Images/Server/image92.PNG :width: 266 :figclass: align-center Windows service configuration window #. :ref:`Server` #. :ref:`Database` #. :ref:`Restore database` #. Load default button Load default values to configuration dialogue. #. Save button Save the configuration and restart the server. The error messages could appear when saving configuration has shown below. .. list-table:: Error messages of server configuration save :widths: 1255 6480 * - Error code - Description * - 1001 - Could not connect with MYSQL/MSSQL {server url}: {port} server. * - 1002 - Could not connect with the email server {host name}: {port}. * - 2006 - Invalid SSL certificate file. * - 2007 - Invalid key store password or SSL key alias. * - 2008 - Invalid port number. Please select the valid port. * - 2009 - Port is used by another application. * - 2010 - Invalid SQLite database or password. Please recheck the database file or password. * - 2012 - {database name} could not be found. * - 2013 - Invalid MYSQL/MSSQL username and password. * - 1002 - Could not connect with the email server {host name}: {port}. * - 2016 - Could not connect with the email server {host}: {port}. Invalid username or password. .. _Ref37597024: Server +++++++++++++++++++++++++++++++++++++++++++++ The Server configuration section allows to add SSL certificate to the NCheck On-premises server. SSL certificate is significance to, #. Encrypt the data sent across internet so that only the intended recipient can access it #. Authentication to ensure that you communicate with the right server .. note:: You are allowed to use self-signed certificate without purchasing a certificate. NCheck server uses a self-signed certificate to enable SSL features. The SSL configuration settings are, .. figure:: Images/Server/image94.PNG :width: 427 :figclass: align-center NCheck Windows SSL configuration #. Key store file SSL certificate file path #. Key store password Password of the certificate file. #. SSL key alias #. Port HTTPS port for NCheck server. The default port is 8443. .. _Ref31883775: Database +++++++++++++++++++++++++++++++++++++++++++++++ NCheck server can be configured with following databases #. :ref:`HSQL` #. :ref:`MySql` #. :ref:`MSSQL` #. :ref:`Oracle` Proceed through the :ref:`Setup database` section to for more details. .. _Ref31884219: Setup database """"""""""""""""""""""""""""""""""""""""""" .. _Ref183008550: HSQL '''''''''''''''''''''''''''''''''' .. figure:: Images/Server/image96.PNG :width: 366 :figclass: align-center NCheck Windows SQLIte configuration #. Provide the location of the SqLite database file. If the file does not exist, a new database will be created. #. Provide the password of the database. The password should be given to use with the NCheck system. Once the password is given, it will be saved securely by the application. If the provided HSQL database file is out of date, the database will migrate to the new version automatically when the NCheck server is starting. The status of the database migration will be shown in tray icon tooltip as shown in :ref:`Tray icon tooltip` section. The possible errors on database migration have been shown below. .. figure:: Images/Server/image98.PNG :width: 334 :figclass: align-center Confirmation dialogue on password encryption change .. list-table:: Error messages of SQLite database migration :widths: 1255 5400 * - Error code - Description * - 2011 - SQLite database migration has failed with the following errors. #. Error 1 #. Error 2 .. _Ref37597148: MySql '''''''''''''''''''''''''''''''''' NCheck on-premises server compatible with MySql product version 5.6 onward. .. figure:: Images/Server/image100.PNG :width: 394 :figclass: align-center NCheck Windows MySql configuration #. Provide MySql Server name or IP address #. Provide the MySql server TCP port. This is 3306 by default #. Provide existing database names in the server. Otherwise, you must create a database first #. provide a username with all privileges on the database #. Provide the password of the users .. _Ref31884202: MSSQL '''''''''''''''''''''''''''''''''' NCheck on-premises server compatible with MSSql version 2014 onward. .. figure:: Images/Server/image102.PNG :width: 463 :figclass: align-center NCheck Windows MsSQL configuration #. Provide MSSql Server name or IP address. #. Provide the MSSql server TCP port. This is 1423 by default #. Provide existing database name in the server. Otherwise, you must create a database first #. provide a username with all privileges on the database #. Provide the password of the users .. note:: NCheck connect to MSSql server using TCP/IP protocol. TCP/IP protocol for the SQL server should have enabled in the SQL server Network configuration\ .. _Ref71912125: Oracle ''''''''''''''''''''''''''''''''''' It is required to install and configure Oracle database as mentioned in `here `_. After installing the Oracle database, #. Create a full privileged user for the oracle db #. Configure service and network as mentioned in `this link `_. To configure Oracle database with NCheck server, .. figure:: Images/Server/image104.PNG :width: 401 :figclass: align-center NCheck Windows Oracle configuration #. Provide Oracle Server name or IP address. #. Provide the Oracle server port. This is 1521 by default #. Provide existing database name in the server. Otherwise, you must create a database first #. provide a username with all privileges on the database #. Provide the password of the users .. _Ref30427628: .. _tooltip_server_control_panel_admin_tasks_restore_database_title: Restore database +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. _tooltip_server_control_panel_admin_tasks_restore_database_desc: The database can be restored back to NCheck server. .. figure:: Images/Server/image106.PNG :width: 387 :figclass: align-center NCheck Windows database restore configuration #. Backup file Select the database backup (zip file format) to restore. The database backup can be created as mentioned in :ref:`Backup data` section. #. Password Enter the database backup password Database restore status are shown in the trey icon tooltip as shown in :ref:`Tray icon tooltip` section. The possible error messages when restored database are shown below. .. list-table:: Error messages of restore database :widths: 1255 6750 * - Error code - Description * - 2015 - Data restore has failed. Could not decrypt the file with the given password. * - 2014 - Data restore has failed. Invalid backup file. * - 4002 - An unidentified error occurred during data restore. Please contact administrator or NCheck support for more details.