Getting Started

This getting started document guide you to setup NCheck Bio Attendance Cloud and on-promises Server, install clients and perform the initial configuration of the attendance control system. You can follow below steps to setup and configure the system.

  1. NCheck Bio Attendance server setup

  2. Enroll users

  3. Enroll user biometrics

  4. Create user groups (Optional)

  5. Register client application

  6. Shifts and roster management(Optional)

  7. Record attendance

Setup NCheck Bio Attendance Cloud server

  1. Go to NCheck Bio Attendance web site.

  2. Select Sign up button

  3. In the sign up page, include

    • your name

    • Your company/organization name

    • Email

    • Select signup button

    _images/cloud_signup.PNG

    Figure 1 NCheck Bio Attendance Cloud server signup

  4. In the next step, you will be asked to verify the email address. A verification number will be sent to the email address you have given above. Please enter the verification number in the email and select verify button.

    _images/cloud_signup_verify.PNG

    Figure 2 NCheck Bio Attendance Cloud server email verification

  5. After the email address is verified, you have to enter additional details as below. Accept the terms and conditions and select register button.

    _images/cloud_signup_register.PNG

    Figure 3 NCheck Bio Attendance Cloud server registration

    Note

    By default, Free plan will be assigned to your NCheck Bio Attendance Cloud server account. You are allowed to change the subscription later. Refer plans and pricing for more details about available subscriptions.

  6. After successful registration, you will be asked to login to the NCheck Bio Attendance Cloud server account as below.

    _images/cloud_signup_success.PNG

    Figure 4 NCheck Bio Attendance Cloud server registration

Setup NCheck Bio Attendance server and standard client on windows

System requirements

  1. Microsoft Windows 8 or higher operating system

  2. 1GB of disk space

  3. 4GB of RAM

  4. JAVA SE runtime environment 8

  5. One biometric capture device such as camera, fingerprint or iris scanner.

Download and install

NCheck Bio Attendance can be downloaded from product downloads section for 32bit and 64bit platforms.

Important

Your windows user account should have administrative privileges to install NCheck Bio Attendance.

  • Run the installer package

    Proceed with default options provided in each step.

  • Activate NCheck Bio Attendance license

    After the successful installation, NCheck Bio Attendance installer will show the license activation window as Figure 5

    _images/license_manager.PNG

    Figure 5 Licensing window for NCheck Bio Attendance Standard client for Windows

    You can activate the trial for evaluation purpose. Trial activation requires permanent internet connectivity. See license activation section for more details.

  • Starting NCheck Bio Attendance server

    NCheck Bio Attendance 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 Figure 6.

    _images/success-tray-app.png

    Figure 6 NCheck Bio Attendance tray icon when the server is ready

  • Finish installation and launch NCheck Bio Attendance standard client.

_images/complete-setup.png

Figure 7 NCheck Bio Attendance installation completion window for Windows

Enroll users

Launch NCheck Bio Attendance control panel

NCheck Bio Attendance Cloud server

  1. Goto login page of the NCheck Bio Attendance Cloud server.

  2. Enter your username and password

login window

Figure 9 NCheck Bio Attendance Cloud server login page

NCheck Bio Attendance On-premises server

  1. In the tray application, right click on the NCheck Bio Attendance server icon and select Control panel option.

    _images/tray-app.png

    Figure 10 Tray icon menu

    Note

    You can also launch control panel on a browser from server tray icon context menu or on browser with URL https://<server>:<port>. The default port is 8443.

    login window

    Figure 11 NCheck Bio Attendance control panel login window

  2. In the login window, provide user name and password to log in to control panel. The default username is admin and password is admin.

Note

NCheck Bio Attendance server interface will work with recent versions of Mozilla Firefox, Google Chrome, Microsoft Edge, Opera and most common web browsers. It does not work with Internet Explorer browser.

Add user

NCheck Bio Attendance control panel, the user management section can be used to manage users.

  • Go to control panel and select User management.

Table 1 NCheck Bio Attendance Cloud/On-premises User management

NCheck Bio Attendance Cloud server

User server_getting_started_user_management

Figure 12 User management view of NCheck Bio Attendance Cloud server control panel

NCheck Bio Attendance On-premises server

User server_getting_started_user_management

Figure 13 User management view of NCheck Bio Attendance On-premises server control panel

  • Select Add button to create a new user.

Table 2 NCheck Bio Attendance Cloud/On-premises add user

NCheck Bio Attendance Cloud server

Add new user

Figure 15 NCheck Bio Attendance Cloud server Add new user view

NCheck Bio Attendance On-premises server

Add new user

Figure 16 NCheck Bio Attendance On-premises server add new user view

Enroll user biometrics

User biometric is used to authenticate users in attendance recording.

  • Select User

    Selected user details will be shown in the user quick view.

  • Select Biometrics button

    Table 3 NCheck Bio Attendance Cloud/On-premises enroll user

    NCheck Bio Attendance Cloud server

    User management Biometrics

    Figure 18 NCheck Bio Attendance Cloud server biometric button in the User management view

    NCheck Bio Attendance On-premises server

    User management Biometrics

    Figure 19 NCheck Bio Attendance On-premises server biometric button in the User management view

    User Biometric data dialogue can be used to manage user biometric. It allows adding biometrics

    • Capture from devices such as camera, fingerprint and iris scanners using NCheck Bio Attendance client applications.

    • From files

    • From event history

    Add biometrics

    Figure 21 Biometric data dialogue

Create user groups (Optional)

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.

    All user groups

    Figure 22 User group management view of NCheck Bio Attendance control panel

  • Select Add button

    User group detail dialogue is shown in below.

    Add user groups

    Figure 23 Add user group dialogue

  • Select Edit button

    Select users for the user group.

    Add users to user groups

    Figure 24 Select users for user group dialogue

Shifts and roster management(Optional)

Work schedule of the users/user groups in the organization can be managed in this section. To manage shifts and rosters,

  • Select Shift and Roster in the control panel menu.

    Shift and Roster management

    Figure 25 Shift and Roster management

This view allows to, * Create Shifts * Create Rosters * Add holidays * Add leaves * Add roster items

Create Shifts

Shifts can be created to plan users daily work schedule. To create a shift,

  • Select Add button under Shifts pane.

    Add shfit dialogue

    Figure 26 Add shfit dialogue

Create Rosters

Rosters are specific duration in weeks to plan the organizational activites with shifts for certain time periods. To create rosters,

  • Select New rosters button in the Rosters pane.

    Add roster dialogue

    Figure 27 Add roster dialogue

Add holidays

Organizational holidays can be added to the employee work schedule using this option. Too add holidays,

  • Select Holidays button in the rosters pane.

    Holidays dialogue

    Figure 28 Holidays dialogue

  • Select “”Add new** button in the holidays dialogue.

    Add holiday dialogue

    Figure 29 Add holidays dialogue

Add leaves

Employee leaves such as casual, medical, vacation and mission can be added using this feature. Too add leaves,

  • Select Leave management button in the rosters pane.

    Leave management dialogue

    Figure 30 Leaves management dialogue

  • Select Add new button in the leaves dialogue

    Add leave dialogue

    Figure 31 Add leave dialogue

Add roster items

After configuring rosters and shifts, roster items can be added for specific dates with user/user groups assigning shifts. To add a roster items,

  • Select Add button

  • Select Roster item button ( optional - Select new button for a particular day in the week )

    Add roster item dialogue

    Figure 32 Add roster item dialogue

Register client application

The Client application is required to register with the server to perform attendance recording. To register a client application

  • Generate a registration code

    1. Go to user group management in control panel

    2. Select a user group

      Register user groups

      Figure 33 Register device button in the user group management view

    3. Select register devices button

      It will show the device registration dialogue as below for the user group.

      Note

      See Register NCheck Bio Attendance Clients section for more details.

      Register device

      Figure 34 NCheck Bio Attendance On-premises server device registration dialogue

  • Register client application

    1. Launch NCheck Bio Attendance standard client

      It should show the device registration window.

    2. Select On-premises option

    3. Enter registration token

    4. Search or enter server user in <server:<port> format. When the server is running in the same computer, it can use localhost:<port>. Default port number is 8443.

    5. Select the Connect button to register.

    6. After Successful registration, the client application is ready for attendance recording

Record attendance

  • NCheck Bio Attendance Lite for Windows, Android and IOS

    • Attach a camera compatible with the NCheck Bio Attendance as mentioned in face peripheral section, if it is not available.

    • Face to the camera directly and select the capture button when the preview is available with the device.

  • NCheck Bio Attendance Standard for Windows and Android

    • Attach a compatible biometric device(face, fingerprint or iris) with the NCheck Bio Attendance as mentioned in Peripherals section, if it is not available with the device.

  • View recorded attendances

    Select Eventlog management to view all recorded events.