WEB CONTROL PANEL

NCheck Bio Attendance administration and configuration application is NCheck Bio Attendance control panel application. This is a web-based application can be accessed using popular web browsers using following URL.

Start web Control panel

Table 15 Launch NCheck Bio Attendance control panel from Browser

URL

Remarks

Cloud

https://cloud.ncheck.net/login

On Premises

https://server:port/login

  1. Server – Sever name or IP address

  2. Port – Service port configured on the server. Default port is 8443.

Standalone

Simple administration functions are provided in build with NCheck Bio Attendance Standard client application.

NCheck Bio Attendance control panel launcher application with extended data capture capabilities are available with the NCheck Bio Attendance Server and NCheck Bio Attendance Standard client installations. This application can be launched from

Table 16 Launch NCheck Bio Attendance control panel from server and clients

Server

  1. Right click on the NCheck Bio Attendance server tray application icon

  2. select Control panel menu item as Figure 47

Windows Standard client

  1. Open the application menu

  2. select control panel as shown in Figure 55 .

Android Standard Client

  1. Open the side bar menu

  2. Select control panel as shown in Figure 56

_images/image80.PNG

Figure 55 NCheck Bio Attendance Windows Standard client main menu

_images/image82.PNG

Figure 56 NCheck Bio Attendance Android Standard client main menu

Note

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

Sign in to web Control Panel

Once the NCheck Bio Attendance control panel sign in is triggered in on-premises mode, you may see browser warning as shown in Figure 57 because it fails to validate the SSL certificate with trusted certificate authority. To prevent this warning

_images/image84.PNG

Figure 57 Browser warning without SSL certificate

  1. You may use browser option to skip and proceed to the site.

  2. You may use valid SSL certificate as mentioned in the On-premises server configuration section.

  3. You may add your server to trusted server list.

Once the warning has resolved as mentioned above, user will be asked to login to NCheck Bio Attendance control panel as shown in Figure 58 .

_images/image86.PNG

Figure 58 NCheck Bio Attendance control panel sign in

  1. Username

  2. Password.

  3. Login button

    After successful login in, you will be landed in the NCheck Bio Attendance Control Panel Dashboard. The possible error messages after select login button are shown in Table 17

  4. Sign up link

    This is available only on NCheck Bio Attendance Cloud. It loads the signup page for subscribing to NCheck Bio Attendance Cloud.

  5. Forget password link

    The forgot password view appears as shown in Figure 59 .

    1. Email address

    2. Security check for human

    3. Continuer button

      Password reset email will be sent to the email address if that is specified to a user in NCheck Bio Attendance. In on-premises mode Administrator allows to reset user password as mentioned in Change password section. The error message could be appeared as shown in Table 18

Table 17 Error messages of web control panel sign-in

Error code

Error message

2018

Invalid username or password.

Table 18 Error messages when reset password

Error code

Error message

2019

Could not find the user associated with {email address} email address.

After signing in, those who have administrator privileges will be landed in the NCheck Bio Attendance Control Panel Dashboard. If the initial required data is not set up, it will be notified to perform the initial setting up. Once the initial setting up has done, users will be able to access the NCheck Bio Attendance control panel as assigned roles mentioned in Web Control Panel Roles section.

_images/image88.PNG

Figure 59 Request password reset

WebControl Panel Roles

Current role of the control panel logged in user is shown in the login options. It can be

  1. Account administrator

    Account administrator is the owner of the account. He has full authority and can perform all administrative operations.

  2. Administrator

    System users can also be assigned administrative privileges. These administrators can do all the admin operations except subscription management and account detail editing.

  3. Admin Auditor

    Admin auditor can access all control panel data like administrator. But cannot change and save them.

  4. Group Administrator

    Group administrator is an Administrator who can manage an assigned group of users.

  5. Group admin auditor

    Group admin is also can access all the data which can accessed by a group administrator. But cannot change and save

  6. Standard user

    NCheck Bio Attendance Control Panel provides self service functions for standard users.

Web Control Panel View

NCheck Bio Attendance Control Panel has following components

_images/image89.PNG

Figure 60 NCheck Bio Attendance control panel

  1. Attendance system name and logo

  2. Sign in user account options control

  3. Notifications Launcher control

  4. NCheck Bio Attendance Help launcher control

  5. Menu

  6. Content area

  7. Neurotechnology company logo

  8. Product name and version

  9. Product copyright

  10. Support email

  11. Product Terms and conditions

  12. Product privacy policy

Sign in user account options

_images/image91.PNG

Figure 62 NCheck Bio Attendance sign in user account view

  1. Profile picture of the account

  2. Sign in username

  3. Current role

    One user can have different roles. Roles can be changed from the Login options . Depend on the current role, NCheck Bio Attendance Control panel operations can be changed.

  4. Signed in email

  5. My Account

    Button to view/edit your company details

  6. Login options

  7. Sign out

My Account

My Account button in sign in user account options can be used to edit your account details. Depend on the current role, this view is different.

_images/image92.PNG

Figure 63 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.

  1. Profile picture

  2. Browse button

    Select the profile picture from the local file system.

  3. Reset to default profile picture

    Rest the profile picture to the NCheck Bio Attendance default profile picture as shown in Figure 510

  4. Owner

    Owner of the attendance system account

  5. Company name

  6. Comment

    If any

  7. Email

    The email address of the owner

  8. Address line 1

  9. Address line 2

    _images/image93.PNG

    Figure 64 Default profile picture

  10. City

  11. Country

  12. State

  13. Zip code

  14. Mobile

  15. Telephone

  16. Update button

    The update button will be disabled if the Validation errors exists. All error messages could be appeared are sown in Table 19

  17. Close button

Table 19 Error messages of my account view

Error code

Error message

3001

Mobile/telephone number is not valid for the selected country/region.

3002

Invalid email address.

Login options

Login options window allows doing the following operations.

_images/image94.PNG

Figure 65 Login options

  1. Role management

  2. Change customer password

  3. Change customer profile picture

  4. Close button

Role management

_images/image95.PNG

Figure 66 Role management view

  1. Available roles for the user

  2. Selected role

  3. Role view

  4. Hint for switch account

  5. Switch button

    Select the role and select switch button. The following error messages could be appeared when switch role.

Role view
_images/image96.PNG

Figure 67 Role view

  1. Role details

    1. Admin name

    2. Admin auditor name

    3. Group code and name of the group admin/admin auditor

    4. Username

  2. Organization name

  3. Role icon

  4. Icon to indicate whether the auditor or not

Change customer password

_images/image97.PNG

Figure 68 Change customer password view

  1. Customer account details

  2. Hint to change password

  3. Password

    The password must have at least 6 characters with one digit

  4. Confirm password

  5. Update button

    The update button will be disabled if data Validation errors exists. All error messages are shown in below table.

Table 20 Error messages of changes password in login options view

Error code

Description

3003

Password does not match.

3004

Password must contain at least 6 characters with one number.

Change customer profile picture

_images/image98.PNG

Figure 69 Change customer profile picture view

  1. Selected profile picture

  2. Browse button

    Brose the picture from the file system

  3. Update button

    The error messages could be shown when updating profile picture are shown in below.

    Table 21 Error messages of updating customer profile picture in login options view

    Error code

    Description

    2020

    Selected file is not a valid image file.

Control panel notifications

_images/image100.PNG

Figure 70 Notifications view

  1. New notifications

  2. Old Notification messages

  3. Delete notification

  4. Date and time of notification

Web Control Panel Menu

NCheck Bio Attendance web Control Panel Menu is used to access main functions of control panel. Control panel provides following functions through the menu.

_images/image102.PNG

Figure 71 Web control panel menu

  1. Date and time

  2. Dashboard

  3. User Management

  4. User Group management

  5. Shift and Rosters

  6. Leaves and holidays

  7. Device Management

  8. Event log

  9. Reports

  10. Settings

  11. Subscription

  12. Admin tasks

Based on the current role, available menu items may be different. Also, the functionality inside the menu item are also different.

Table 22 Web control panel menu availability for roles

Menu Item

Role

Account Admin

Admin

Admin Auditor

Group Admin

Group Admin Auditor

Standard User

Dashboard

_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG

Manage Users

_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG

Manage user Groups

_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG

Manage Shifts and Rosters

_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG

Manage leaves and holidays

_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG

Manage devices

_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG

Manage Event logs

_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG

Reports

_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG

Admin Tasks

_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG

Settings

_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG
_images/image351.PNG

Subscription

_images/image351.PNG
_images/image361.PNG
_images/image361.PNG
_images/image361.PNG
_images/image361.PNG
_images/image361.PNG

Dashboard

The dashboard provides a graphical summary of the customer account activities of the NCheck Bio Attendance account. Customer account administrator and users marked as administrators can access the Dashboard. Summary includes

_images/image103.PNG

Figure 72 Web control panel dashboard

  1. Quick access

  2. Employees Summary

  3. Devices summary

  4. Subscription summery (NCheck Bio Attendance cloud only)

  5. Recent Employee activity

  6. Leaves and holidays summary

Quick access

_images/image104.PNG

Figure 73 Quick access view of the Dashboard

  1. Welcome note for the logged in user

  2. Selected user group for the dashboard statics

  3. Add user

    Invoke Add new user function and open Add/Edit users user form

  4. Fix attendance

    Invoke event log function and apply error event filter to fix errors in attendance events.

  5. Register device

    Invoke user group function and open register device form to register a NCheck Bio Attendance client application for a user group.

Employees Summary

This is a real time graph present number of checked-in and checked-out employees

_images/image106.PNG

Figure 74 Employee summery view of the Dashboard

  1. Total number of users

  2. No. of users Checked-in

  3. No. of users Checked-out

  4. No. of users on leave

Check-in, check-out and on leave) users will be shown in a dialogue when clicking on each region.

Devices summary

This graph presents number of devices registered with users and user group

_images/image108.PNG

Figure 75 Device summery view of the Dashboard

  1. No of connected client devices

  2. No of devices registered to users

  3. No of devices registered to user groups

User will be redirected to the Manage devices when click on a devices chart.

Recent Employee activity

Recent user event list is shown ordered with latest event first. This is limited to 20 users maximum and 24 hours.

_images/image110.PNG

Figure 76 Employee activity view of the Dashboard

  1. Overtime approval button

    The user will be redirect to the Overtime view

  2. Employee code

  3. Name

  4. Last event type

  5. Data and time

  6. Time zone

  7. Table menu

  8. Table paging options

Leaves and holidays summary

All employee leaves and holidays for the current month are shown.

_images/image112.PNG

Figure 77 Laves and holidays summary view of the Dashboard

  1. Current month

  2. Number of leaves for the day

  3. Current date

  4. Holiday

  5. Recurring holiday

    The holidays appears in recurring (weekly, monthly or annually) identified as recurring holiday

Mouse hover on each date in the calendar will show a summary of available holidays and leaves as mentioned in Leaves and holidays summery view section.

Leaves and holidays summery view

Leaves and holiday summery view is showing the available holidays and leaves for the day as follows.

_images/image114.PNG

Figure 78 Leaves and holidays summery view

  1. Holidays

    Name of all available holiday(s)

  2. No leaves

    User names and leave types

  3. Click for more actions

    Click on each date to more details about the events, leaves and holidays as mentioned in Daily statistics view section.

Daily statistics view

User will be shown a view to see events, leaves and holidays as follows when click on each day in th3e calendar view.

_images/image116.PNG

Figure 79 Daily statistics view

  1. Selected date

  2. Go to events

    User will be redirected the Event logs management section to monitor all the events in the selected date.

  3. Go to leaves and holidays

    User will be redirected to the leaves and holidays management section to monitor all leaves and holidays in the selected date.

Subscription summery

Note

This view is not available for NCheck Bio Attendance cloud control panel

_images/image118.PNG

Figure 80 Subscription summery view of the Dashboard

  1. Subscription details

    1. Plan code

    2. Plan name

      _images/image120.PNG

      Figure 81 Subscription details view of the subscription summery view

  2. Plan statistics

    1. Percentage of the added users with respect to number of all users available for the plan

    2. Number of current users

    3. Number of users available to add

    4. Progress bar showing the utilized users

      _images/image122.PNG

      Figure 82 Plan statistics view of the subscription summery view

Manage Users

The following options are available in this view.

_images/image124.PNG

Figure 83 User management view of the web control panel

  1. Add button

    Refer Add/Edit users section for more details.

  2. Search users

    Filter user from the user table

  3. Users list view

  4. User details view

  5. Advanced button

    Refer Advanced options section for more details.

Add/Edit users

This view allows to add a new user to the NCheck Bio Attendance system or edit existing user

_images/image126.PNG

Figure 84 Add user view

.

  1. User profile picture

  2. First name

  3. Last name

  4. Employee code

  5. Email

  6. Username

    The username to allow to login users to the NCheck Bio Attendance control panel. Select User email address as username option to use the email address as the username.

  7. Capture barcode

  8. Capture RFID

  9. Administrator right

    Admin right as Employee (Standard user), Admin or Admin auditor as mentioned in Web Control Panel Roles section.

  10. Address line 1

  11. Address line 2

  12. City

  13. Country

  14. State

  15. Zip code

  16. Telephone

  17. Primary user group

    Select the primary user group user belongs if the user is available in several user groups. Refer Manage user Groups section for more details.

  18. Add button

    The add button will be disabled if the mandatory data fields are empty or Validation errors exits. Refer Table 23 for all error messages could be appeared.

  19. Close button

Table 23 Error message of add/edit user

Error code

Description

3001

Mobile/telephone number is not valid for the selected country/region.

3002

Invalid email address.

2020

Selected file is not a valid image file.

2021

Employee code already exists.

2022

Barcode ID is already available for different user

2023

RFID is already available for different user

Employee code

Unique ID to identify employees. Administrator allows to specify an employee code or generate code as shown in below.

_images/image128.PNG

Figure 85 Employee code view

  1. Employee code field

  2. Generate button

    Select Generate button to generate code with 6 characters

Profile picture from the local file system

Select the profile picture from the local file system. After select the image, crop view allows to crop the user image as shown in figure

_images/image132.PNG

Figure 87 Profile picture crop view

  1. Original image view

  2. Cropping rectangle

    User can change the margin of the rectangle to crop the image

  3. Result image view after cropping

Profile image from unidentified image

Face images failed to identify user when recording the attendances are known as unidentified images. User can select the user profile image from these unidentified images.

_images/image134.PNG

Figure 88 Select profile picture form unidentified image view

  1. Date filter

    Retrieve unidentified images between selected date range

  2. Unidentified images list

  3. Close button

  4. Select button

Capture barcode

_images/image136.PNG

Figure 89 User barcode ID view

  1. Barcode text field

  2. Capture button

    Select Capture button to scan the barcode from the client application as mentioned in Table 24

Table 24 Capturing barcode from Client applications

Android client

  1. Main menu

    _images/image138.PNG

    Figure 90 Barcode capture view of the Android client

    1. Switch camera

    2. Change resolution

  2. Barcode scan area

The Table 25 is showing the error message could be appeared.

Windows client

  1. Select the barcode text field

  2. Scan the barcode from the connected barcode scanner

The Table 25 is showing the error message could be appeared.

Table 25 Error message of capture barcode

Error code

Description

3005

Barcode scanner could not be found.

2039

Could not capture barcode. The device has been blocked

Capture RFID

_images/image140.PNG

Figure 91 User RFID capture view

  1. RFID text field

  2. Capture button

    Select Capture button to scan the RFID from the client application as mentioned in Table 26 .

Table 26 Capturing RFID from Client applications

Android client

  1. RFID scan view appear as Figure 537

    _images/image1421.PNG

    Figure 92 RFID capture view of the Android client

  2. Scan the RFID

  3. RFID id will appear in the RFID ID field.

The Table 26 is showing the error message could be appeared.

Windows client

  1. Select the RFID text field

  2. Scan the RFID from the connected RFID scanner

  3. RFIC id will appeared in the RFID field.

The Table 26 is showing the error message could be appeared.

Table 27 Error message of capture RFID

Error code

Description

3006

RFID scanner could not be found

2040

Could not capture RFID. The device has been blocked

Users list view

_images/image144.PNG

Figure 93 User table view of the user management

  1. Table header

  2. Table paging options

  3. Selected user

    The selected user details are shown in User details view

User details view

  1. User quick view

    _images/image146.PNG

    Figure 94 User details view of the user management

  2. User specific settings

User quick view

This section allows to control all user specific functions when recording attend

_images/image148.PNG

Figure 95 User management quick view

  1. Username

  2. User details

    1. Address

    2. Email

    3. Phone

    4. User status

  3. User

    Added user groups.

  4. Devices

    Registered devices. Select Unregister button to unregister each device.

  5. Show events button

    Show all events of the user.

  6. Biometrics button

    Refer Change biometrics section for more details.

  7. Edit button

    Refer Add/Edit users section for more details.

  8. Change password button

    Refer Change password section for more details.

  9. Block/Unblock button

    Refer section Block/unblock users for more details.

  10. Export button

    Export following details for selected user.

  11. Register button

    This option allows to generate registration token to register the device for the selected person. Once select the button, the Client registering view will be appeared.

  12. Remove button

    Refer Remove users section for more details.

Change password

After assigning a username as mentioned in Add/Edit users section, the password can be changed. Password must be consisted with one digit and 6 characters.

_images/image150.PNG

Figure 96 Change user password view

  1. User name

  2. Email

  3. Password

    Password must have atleast 6 characters and one digit.

  4. Generate button

    Generate a password.

  5. Change button

    Change button will be disabled if the Validation errors exits. Table 28 is showing the error messages could be appeared.

  6. Close button

Table 28 Error messages of change password

Error code

Description

3003

Password does not match.

3004

Password must contain at least 6 characters with one number.

Change biometrics

In the Biometric data dialogue, new biometrics can be enrolled using the below options.

_images/image152.PNG

Figure 97 Add biometrics view

  1. Enrolled biometrics

  2. Enroll from history

  3. Menu for capture from client applications

  4. Menu for Upload biometric image

  5. Delete button

  6. Close button

Enroll from history

The face, fingerprint, and iris images, unable to identify the user while recording attendances, are kept in NCheck Bio Attendance server. These biometric images can be used to enroll users. In the Select from history window,

  1. Date range

    Biometrics will be retrieved within the selected date range.

    _images/image154.PNG

    Figure 98 Select biometrics from history view

  2. Closely matching biometrics

    NCheck Bio Attendance server will filter out the closely matching biometrics for the user from history.

  3. Filter by device

    Filter out the biometrics matching for the device.

  4. Filter by user group

    Biometrics used to enroll for the selected user group.

  5. Biometric quick view as shown in Figure 99

    _images/image156.PNG

    Figure 99 Biometric image view of select biometric from history view

    1. Biometric thumbnail

    2. Delete button

    3. Date and time biometric captured

    4. View button

      To show the Biometric detail view.

  6. Paging details

    current page and number of available pages

  7. Previous button

    Navigate to previous page

  8. Next button

    Navigate next page

  9. Enroll button

    Enroll button will be disabled if no biometric image has selected. The table is showing all error message could be appeared.

  10. Close button

Table 29 Error message of select biometric from history

Error code

Description

2024

Could not enroll selected face/finger/iris image.

Biometric detail view
_images/image158.PNG

Figure 100 Biometric detail view

  1. Biometric event date and time

  2. Biometric details

    1. Modality

      Face, Fingerprint, or Iris

    2. Event data and time

    3. Latitude

    4. Longitude

    5. Address

  3. Biometric thumbnail

  4. Close button

Capture from client applications

Biometrics can be enrolled through the NCheck Bio Attendance client applications such as NCheck Bio Attendance Lite for Windows and Android and NCheck Bio Attendance Standard for Windows and Android. To capture

_images/image160.PNG

Figure 101 Menu for capture biometrics from client applications

  1. Select biometric capture type form the list

    1. Capture face

    2. Capture fingerprint

    3. Capture iris

  2. Capture the selected biometric when the capture view is appeared as mentioned in

The error messages could be appeared when capture biometric from clients are showing below.

Table 30 Error messages when capture biometrics

Error code

Description

3007

Camera could not be found.

3008

Fingerprint scanner could not be found

3009

Iris scanner could not be found

2025

Capture face with enough lighting

2026

The biometric image has already enrolled for another user

2038

Could not enroll biometrics. The device has been blocked

Capture face from lite clients
Table 31 Face enroll views for lite client

Windows lite client

_images/image162.PNG

Figure 102 Windows lite client face capture view

Android lite client

_images/image164.PNG

Figure 103 Android lite client face capture view

  1. Camera preview

  2. Face rectangle (Standard client only)

  3. Capture button

    Select capture button to capture face image in lite client. In Windows Standard, select capture button when the user has prepared to capture the face.

  4. Camera name

  5. Captured face list

    Windows clients allows to capture multiple face images before upload. Android clients allows to capture a single image before upload.

  6. Cancel button (Windows clients only)

  7. Continue button

    In windows clients, select continue button to upload captured face list to the server. In Android client captured image will automatically uploading to the server.

  8. Android lite client resolution menu

  9. Change front/back camera button

Capture face from standard clients
Table 32 Face enroll views for standard clients

Windows Standard client

_images/image166.PNG

Figure 104 Windows standard client face capture view

Android Standard client

_images/image168.PNG

Figure 105 Menu of Android standard client face capture view

_images/image172.PNG

Figure 106 Android standard client face capture view

  1. Camera preview

  2. Face rectangle (Standard client only)

  3. Capture button

    Select capture button to capture face image in lite client. In Windows Standard, select capture button when the user has prepared to capture the face.

  4. Camera name

  5. Captured face list

    Windows clients allows to capture multiple face images before upload. Android clients allows to capture a single image before upload.

  6. Cancel button (Windows clients only)

  7. Continue button

    In windows clients, select continue button to upload captured face list to the server. In Android client captured image will automatically uploading to the server.

  8. Menu of Android standard client face capture view as shown in Figure 105

    1. Switch camera

      Change front/back camera

    2. Resolution

      Camera resolutions dialogue

Capture fingerprint from Standard clients
Table 33 Fingerprint enroll views for standard clients

Standard client

Windows

_images/image174.PNG

Figure 107 Windows standard client fingerprint capture view

Android

_images/image176.PNG

Figure 108 Android standard client fingerprint capture view

  1. Fingerprint scanner name (Windows standard client only)

  2. Fingerprint scanner status

    1. Android Standard client is Showing “Fingerprint capturing” message if the scanner is available. Otherwise “Fingerprint reader not available”

    2. Windows standard client is showing finger print icon as shown in Figure 107 if the fingerprint scanner is available. Otherwise “Unable to detect the fingerprint scanner. Please verify the finger scanner is connected and functioning correctly.”.

  3. Captured fingerprint images list

    Windows standard client allows to capture multiple fingerprint images. Android standard client allows to capture only single fingerprint image before upload.

  4. Cancel button (Windows client only)

  5. Continue button

    In Windows standard client, select continue button to upload captured fingerprint images. Android standard client will upload the fingerprint image automatically once it captured successfully.

Capture iris from Windows standard client
_images/image178.PNG

Figure 109 Windows standard client iris capture view

  1. Iris preview

  2. Iris scanner name

  3. Captured iris image list

  4. Cancel button

  5. Continue button

Upload captured iris images to the server.

Upload biometric image
_images/image180.PNG

Figure 110 Menu for upload biometric images for user

  1. Select biometric upload type from

    1. Upload face image

    2. Upload fingerprint

    3. Upload iris image

  2. Select selection to upload the biometric image from your file system. The following errors could be occurred uploading selected biometrics

Table 34 Error messages of upload biometric images

Error code

Description

2020

Selected file is not a valid image file.

Block/unblock users

The selected user can be block/unblock using this option. Blocked users are not allowed to enroll biometrics or record attendances.

Remove users

Remove selected user from the users list.

User specific settings

User specific settings allows to

  1. Manage location restrictions for user

  2. Leave entitlement

Manage location restrictions for user

Refer Location restrictions section for more details.

Leave entitlement

This view is showing the number of leaves user has taken and number of remaining leaves from each Leave type. Also, user leaved entitlement can be updated.

_images/image182.PNG

Figure 111 Leave entitlement view

  1. Leave type summery

  2. Edit button

Refer Edit leave entitlement section for more details

Leave type summery

_images/image184.PNG

Figure 112 Leave type summery view

  1. Leave type

    Refer Configure leave type section for more details.

  2. Number of leaves taken by the user

  3. Number of available leaves

Edit leave entitlement

_images/image186.PNG

Figure 113 Edit leave entitlement view

  1. Username

  2. Number of leaves available for each user

  3. Number of leaves user has already taken

  4. Update button

  5. Close button

Advanced options

_images/image188.PNG

Figure 114 Advanced options of User management

  1. Import data

  2. Export data

  3. Restore deleted users

Import data

This option allows to import all user data as mentioned in Import and Export information section. Tio import data,

_images/image190.PNG

Figure 115 Import users data view

  1. Select information to be imported from the list

  2. Select Import button to select the import location.

Refer Select import location section for more details.

Export data

This option allows export all user data as password protected zip file as follows

_images/image191.PNG

Figure 116 Export users data view

  1. Select information to be imported from the list

  2. Select Export button to select the export location.

    Refer Select export location for more details

Restore deleted users

_images/image194.PNG

Figure 117 Restore deleted users view

  1. Deleted user table

  2. Restore button

  3. Close button

To Restore deleted user,

  1. Select the user from the table

  2. Select Restore button

  3. Change the user details in the Recover user dialogue if necessary

  4. Select Recover button

Manage user Groups

Administrator and user group administrators allow managing users as user groups. All user group is the default user group including all users and it is accessible for administrator only. In the user group management dialogue.

_images/image196.PNG

Figure 118 User group management view of web control panel

  1. Add button

    Refer Add/Edit user group section for more details.

  2. Search

    Search user group by group name

  3. User groups list view

  4. User group details view

  5. Advanced button

    Refer Advanced options section for more details.

Add/Edit user group

This view allows to add a new user group or edit existing user group.

_images/image198.PNG

Figure 119 Add/edit user group view

  1. Profile picture

  2. User group code

Unique code to identify user group

  1. Description

  2. Add button

    Add button will be disabled If the mandatory fields are empty or Validation errors exists. Refer Table 35 for more details of error massagers could be occurred.

  3. Cancel button

Note

All user group could not be edited.

Table 35 Error messages of add/edit user group

Error code

Description

2020

Selected file is not a valid image file.

2027

User group code has already existed.

Error messages of add/edit user

Table 36 Error messages of add/edit user

Error message

Description

User group code has already existed. Please try different group code.

User group could not be duplicated.

User groups list view

_images/image200.PNG

Figure 120 User groups list view

  1. Table header

  2. All user group

    All user group is the default user group including all the users.

  3. Selected user group

    Selected user group details are shown in User group details view .

  4. Table paging options

User group details view

_images/image202.PNG

Figure 121 User group details view

  1. User group quick view

  2. Attached users

  3. User group specific settings

User group quick view

This view is showing user group details and allow user to perform user group specific functions

_images/image204.PNG

Figure 122 User group quick view

  1. Group name and code

  2. Number of users

  3. Devices registered to the group

    Select Unregister button to un-register the device

  4. Group admins button

    Edit group admins of the user group. Refer Group admins section for more details

  5. Register device button

    Generate registration token to register a device for selected user group. Once select the button, the Client registering view will be appeared.

  6. Edit button

    Edit the user group. Refer Add/Edit user group section for more details.

  7. Delete button

    Delete the selected user group. All user group could not be deleted.

  8. Settings button

    User group specific settings. Refer General settings section for more details.

Delete user group

Delete selected user group from the user group list.

Group admins

User group admin allows to manage users in the user group according to the assign permission level.

_images/image206.PNG

Figure 123 User group admins view

  1. User group name and code

  2. Table header

  3. Check box to add/remove group admin

  4. Write permission

    Refer Group admin permission section for more details.

  5. Table paging options

  6. Close button

Note

Group admins are not available for the All users group.

Group admin permission

Group admins can be created with following permissions.

  1. Read Write

    Group admins can manage users assigned to group.

  2. Read only

    Group admins can review users assigned to particular group.

Attached users

All users attached to the selected user group are showing in this view as follows.

_images/image208.PNG

Figure 124 Attached users view

  1. Selected user group code

  2. Table header

  3. Table paging options

  4. Edit button

    Select edit button Refer Edit attached users section for more details.

Edit attached users

This view allows to add/remove users from the user group

_images/image210.PNG

Figure 125 Edit attached users view

  1. User group code

  2. Table header

  3. Checkbox to add/remove user

  4. Table paging options

  5. Update user group button

  6. Cancel button

User group specific settings

General settings

_images/image212.PNG

Figure 126 General settings of the user group

  1. Maximum occupancy for group premises

Maximum occupancy for group premises

Administrator/user group administrator allows to limit the number of employees/users of the user group in the premises. To limit users, enable this setting and add the number of allowed users. The users who are entitle to the user group as the primary user group will be count when check-in to the premises. If the check-in count is greater than the maximum occupancy for group premises, the check-ins will be restricted. Refer Add/Edit users section to change the primary user group of the users.

Manage location restrictions for user group

Refer Location restrictions section for more details.

Advanced options of user group view

_images/image214.PNG

Figure 127 User group management advanced options

  1. Import user group data

  2. Export user group data

Import user group data

Import all user group data as mentioned in Import and Export information section, To import,

_images/image216.PNG

Figure 128 Import user groups data view

  1. Select data from the list to be imported

  2. Select start import button

Refer the Select import location section for more details

Export user group data

Export all user group data as a password protected zip file as follows,

_images/image217.PNG

Figure 129 Export user group data view

  1. Select data from the list to be exported

    1. User group information

    2. User group memberships information

    3. User group location restrictions information

  2. Select start export button

    Refer Select export location for more details

Manage Shifts and Rosters

Work schedule of the users/user groups in the organization can be managed in this section.

_images/image218.PNG

Figure 130 Shift and rosters management view

  1. Shift management view

  2. Roster management view

  3. Roster item management view

Shift management view

Daily work schedule can be created with shifts. Shift can be created with specific start time and end time with restrictions such as work hours should be covered, check-in, check-out, and OT hours. Shift management view as follows

_images/image220.PNG

Figure 131 Shift management view

  1. Shift name

  2. Shift start time

  3. Shift end time

  4. Edit button

    Edit the shift. Refer Add/Edit shifts section for more details.

  5. Delete button

    Delete the shift.

  6. Add button

    Refer Add/Edit shifts section for more details.

  7. Import/export shifts

Add/Edit shifts

This view allows to add new shift or edit existing shift details

_images/image222.PNG

Figure 132 Add/edit shifts view

  1. Shift name

  2. Description

  3. Shift start and end time

  4. Work hours

  5. Select checkbox to add time duration to restrict check-ins

  6. Select checkbox to add time duration to restrict check-outs

  7. Select checkbox to add time duration to restrict overtime hours

  8. Select checkbox to add maximum overtime hours allowed

  9. Add button

    Add button will be disabled if the mandatory fields are empty or Validation errors exists. Refer Table 37 for more details about error messages could be occurred.

  10. Close button

Table 37 Error messages of add/edit shift

Error code

Error message

2028

The shift name has already existed.

Import/export shifts

Import shifts
_images/image223.PNG

Figure 133 Import shifts view

Shift information can be imported as mentioned in Import and Export information section. To impot,

  1. Select the Shift to import Shifts information

  2. Start Import button to select the import location.

    Refer Select import location section for more details.

Export shifts
_images/image224.PNG

Figure 134 Export shift view

Shift information can be exported as a password protected zip file as follows.

  1. Select Shifts to export Shifts information

  2. Start Export button to select export location.

    Refer Select export location for more details.

Roster management view

Rosters are specific duration in weeks to plan the organizational activities with shifts for certain time periods.

_images/image226.PNG

Figure 135 Roster management view

Manage rosters view allows to,

  1. Current date

  2. Selected roster

  3. Roster name

  4. Roster range

  5. Ends on

    Roster end date if specified. Otherwise “no end date” will be shown

  6. Status

    Whether the roster is currently in user or not.

  7. Edit button

    Refer Add roster section for more details.

  8. Delete button

    Delete selected roster.

  9. New roster button

    Refer Add roster section for more details.

  10. Import/export rosters

Add roster

This view allows to add new roster.

_images/image228.PNG

Figure 136 Add roster view

  1. Roster name

  2. Repetition

    How many weeks the roster should span - Default is 1 week. Maximum 4 weeks.

  3. 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.

  4. 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.

  5. Continue button

    Continue button will be disabled if the mandatory fields are disabled or Validation errors exists. Refer Table 38 for more details about error messages could be occurred.

  6. Close button

Table 38 Error messages for add roster

Error code

Error message

2029

The roster name has already existed.

Import/export rosters

Import rosters
_images/image229.PNG

Figure 137 Import rosters view

Roster information can be imported as mentioned in Import and Export information section. Tip import,

  1. Select data from the list to import

  2. Select Start Import button to select the import location

Refer the Select import location section for more details.

Export rosters
_images/image230.PNG

Figure 138 Export rosters view

Roster information can be exported as password protected zip file as follows.

  1. Select data from the list to export

  2. Select Start Export button to select the export location

    Refer the Import and Export information section for more details

Roster item management view

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

_images/image232.PNG

Figure 139 Shift and roster management roster item management view

  1. Weeks

  2. Calendar view

  3. Roster item

  4. Add menu

  5. Filter by Shift

    Filter roster items by shift

  6. Filter by user/user group

    Filter roster items by user/user group

  7. New button

    Add roster item. Refer Add roster item section for more details

Roster item view

Following details and operation are available in the roster item view.

_images/image234.PNG

Figure 140 Roster item view

  1. Shift name, start time and end time

  2. Assigned user/user group list

  3. Assigned user/user group

    Refer Add additional staff section for more details

  4. Delete user/user group

Add menu

_images/image236.PNG

Figure 141 Add menu of roster items management view

  1. Add roster item

  2. Add additional staff

Add roster item

This view allows to add new roster item to the roster.

_images/image238.PNG

Figure 142 Add roster item view

  1. Date

  2. Shift

  3. User/user group

  4. Add button

    Add button will be disabled if the mandatory fields are empty or Validation errors exists. Refer Table 39 for more details about error messages could be occurred.

  5. Close button

Table 39 Error messaged of add roster item

Error code

Error message

2033

A roster item already existed on {date} with {shift name} shift and {user group name} user group.

Add additional staff

Additional staff view allows to add multiple user/user group for a roster item.

_images/image239.PNG

Figure 143 Add additional staff view

  1. Date

  2. Shift

  3. Select user/user group

  4. Assign button

    Assign button will be disabled if the mandatory fields are empty or Validation errors exists. Table 40 is showing error message could be appeared when add additional staffs.

  5. Close button

Table 40 Error messages of add additional staff

Error code

Error message

2033

A roster item already existed on {date} with {shift name} shift and {user group name} user group.

Manage Leaves and holidays

Leaves and holiday management of NCheck Bio Attendance web control panel allows to manage all user leaves and holidays. The Leaves and holiday management view as follows.

_images/image240.PNG

Figure 144 Leaves and holidays management view

  1. Add leave

  2. Add holiday

  3. Settings of leaves and holidays management

  4. Leaves table view

  5. Holiday table view

  6. Table view of Leaves and holidays

  7. Leave filters view

  8. Selected date view

  9. Summery view of the selected leave

  10. Calendar view

Add leave

This allows to add new leave for the selected employee.

_images/image242.PNG

Figure 145 Add leave view

  1. Select user

    Select the username who need to apply the leave.

  2. Start date

    Start date of the leave.

  3. End date

    End date of the leave

  4. Leave type

    The default leave types are Casual, Medical and Annual. Administrator allows to add custom leave types as mentioned in Configure leave type section.

  5. Leave policy

    There are two available leave policies.

    1. Normal

      This is the default leave policy. No restriction will be applied for the leave.

    2. Restricted

      Once the leave is approved, user will not able to check-in or check-out while on leave.

  6. Request reason

    The reason for the leaves.

  7. Approve reason

    The reason for leave approval.

  8. Add button

    Add leave

  9. Cancel button

    Cancel the leave dialogue.

Edit leave

Edit leave is required in following cases.

  1. Edit leave details such as leave approved duration, leave type etc.

  2. Once a user submits a leave request, the approval status must be changed as approved or rejected. When user submit a leave request administrator will be get notified as below.

    _images/image244.PNG

    Figure 146 User leave request notification

Requested leaves can be edited as follows.

_images/image246.PNG

Figure 147 Edit leave view

  1. Name

    Name of the user. This field is not editable

  2. Requested

    The leave requested period by user.

  3. Approved

    Approval period of the user leaves by the administrator. When administrator select update button only this period will be approved.

  4. Leave type

    The default leave types are Casual, Medical and Annual. Administrator allows to add custom leave types as mentioned in Configure leave type section.

  5. Leave policy

    There are two available leave policies.

    1. Normal

      This is the default leave policy. No restriction will be applied for the leave.

    2. Restricted

      Once the leave is approved, user will not able to check-in or check-out while on leave.

  6. Requested reason

    The reason for the leave

  7. Approve/reject reason

    Leave approval or rejection reason by the administrator.

  8. Approval status

    Leave approval reason as follows.

    1. Requested

      Once the user requested a leave, the approval status will be shown as requested.

    2. Approved

      To approve the leaves requested by users, set the approval status as approved. Once the leaves are approved, the user will be get notified.

    3. Rejected

      To reject the leaves requested by users, set the approval status as rejected. Once the leaves are rejected, the user will be get notified.

  9. Update button

    Update the changes.

  10. Cancel button

    Cancel the edit dialogue.

Approve leave

The requested leaves by the user can be approved or rejected by the administrator as shown in below.

_images/image248.PNG

Figure 148 Approve leave view

  1. Name

    The name of the user

  2. Leave days

    The period leaves applied

  3. Leave type

    Leave type as Casual, Medical, Annual or custom leaves as mentioned in Configure leave type section.

  4. Policy

    The policy as

    1. Normal

    2. Restricted

      User are not allowed to check-in or check-out while on leave.

  5. Reason

    The reason for the leave.

  6. Approve/reject comment

    Comment for leave approval or rejection

  7. Calendar

    The calendar view shows periods the leaves are requested.

  8. Accept button

    Approved the leaves.

  9. Decline button

    Reject the leaves

  10. Edit leave

    Edit requested leave as mentioned in Edit leave section.

  11. Cancel button

    Cancel the approve leave dialogue.

Add holiday

This allows to add a holiday for the selected date as below.

  1. Normal holiday type

  2. Recurring holiday type

Normal holiday type

The normal holiday type as follows.

_images/image250.PNG

Figure 149 Add normal holiday view

  1. Holiday type

    Holiday type as Normal

  2. Date

    Holiday date

  3. Description

  4. Add button

    Add holiday

  5. Cancel button

    Cancel add holiday dialogue

Recurring holiday type

The recurring holiday can be added as follows.

_images/image252.PNG

Figure 150 Add recurring holiday view

  1. Holiday type

    Holiday type as recurring

  2. Recurring type

    Recurring type as

    1. Weekly

      Add the holiday for once every week

    2. Monthly

      Add the holiday for once every month

    3. Yearly

      Add the holiday for once a specified month in every year. A field will be appeared to select the specified month.

  3. Day

    Select the date to apply the holiday

  4. Start

    The start date of the recurring holiday. Select start from option and specify the start date if required.

  5. End

    The end date of the recurring holiday. Select ends on option and specify the end date if required.

  6. Description

  7. Add button

    Add the recurring holiday.

  8. Cancel button

    Cancel the add holiday dialogue.

Leaves table view

Leaves table shows all user leaves for the selected leave in calendar view.

_images/image254.PNG

Figure 151 Leaves table view

  1. Name

  2. Start date

    Leave start date

  3. End date

    Leave end date

  4. No of day

    No of days leave applied

  5. Leave type

    Leave type as Casual, Medical, Annual or custom leave type as mentioned in Configure leave type section.

  6. Leave policy

    Leave policy as

    1. Normal

    2. Restricted

      Users are not allowed to check-in or check-out while on leave.

  7. Approval status

    Approval status as Requested, Approved or Rejected.

  8. Operation

    1. Edit leave

      Approved or rejected leaves can be edit as mentioned in Edit leave section. The requested leave can be approved as mentioned in Approve leave section.

    2. Delete leave

      Delete the leaves

  9. Table options

Holiday table view

Holiday table view shows holidays for selected date in Calendar view .

_images/image256.PNG

Figure 152 Holiday table view

  1. Date

    Date of the holiday

  2. Description

  3. Operation

    Delete the holiday

  4. Table options

Leave filters view

This view allows to filter all leaves for selected date in the calendar view as follows.

_images/image258.PNG

Figure 153 Filter view of leaves

  1. Select user

    Display all leaves for the selected user group

  2. Select user

    Display all leaves for the selected user

  3. Show rejected leaves

    Check this option to display the rejected leaves of users.

Selected date view

The details of the date are shown as selected leave from the Leaves table view or holiday from the Holiday table view .

_images/image260.PNG

Figure 154 Selected date view

  1. Date

    The date of the selected date from the Calendar view or date of the selected leave from the Leaves table view or date of the selected holiday form the Holiday table view .

  2. Day

  3. Select today button

    Select the current date form the Calendar view

  4. Holiday name

    This will appears if a holiday selected from the Holiday table view .

Summery view of the selected leave

This view is showing the leave summery of the selected leave from the Leaves table view as follows.

_images/image262.PNG

Figure 155 Summery view of the selected leave

  1. Username

  2. Leave period

    Start and end date of the leave with number of days

  3. Approval status of the leave

    Approval status as Requested, Approved or Rejected.

  4. Edit button

    Approved or rejected leaves can be edit as mentioned in Edit leave section. The requested leave can be approved as mentioned in Approve leave section.

Calendar view

Calendar view allow user to select the specific date from the selected month and it also represents details of the leaves and holidays across the selected month as showing below.

_images/image264.PNG

Figure 156 Calendar view of the Leaves and holiday mangement

  1. Button to navigate to previous month

  2. Button to navigate the next month

  3. Selected month

  4. Selected date

  5. Number of leaves of the day

  6. Current date

  7. Holiday

Settings of leaves and holidays management

  1. Configure leave type

  2. Import data

  3. Export data

Configure leave type

Instead of the default leave types (casual, medical, and annual), Administrator allows to add custom leave types as follows.

_images/image265.PNG

Figure 157 Leave type view

  1. Leave type table

  2. Show deleted leave type

    Check this option to show deleted leave types

  3. Delete button

    Delete selected leave type form the table.

  4. Add/edit leave type

  5. New leave type button

    Add new leave type. Refer Add/edit leave type section for more details.

  6. Close button

    Close leave type dialogue

Add/edit leave type

Add a new leave type or edit existing leave types follows.

_images/image266.PNG

Figure 158 Add leave type dialogue view

  1. Type name

    Name of the leave type. This is not editable when editing the leave type.

  2. Type description

  3. Entitlement

    Number of leaves available for users.

  4. Add button

    Add leave.

  5. Close button

    Close Add leave type dialogue.

Leave type table
_images/image268.PNG

Figure 159 Leave type table view

  1. Leave type

  2. Description

  3. Entitlement

    Number of available leaves for the leave type

  4. Created at

    Created date of the leave type

  5. Modified at

    Modified fate of the leave type

  6. Deleted

    Deleted date of the leave type if deleted.

Import data

This option allows to import leaves and holidays as mentioned in Import and Export information section. Tio import data,

_images/image270.PNG

Figure 160 Import leaves and holiday data view

  1. Select information to be imported from the list

  2. Select Start Import button to select the import location.

Refer Select import location section for more details.

Export data

This option allows export all leaves and holidays as password protected zip file as follows

_images/image273.PNG

Figure 161 Export leaves and holidays data view

  1. Select information to be imported from the list

  2. Select Start export button to select the export location.

    Refer Select export location for more details

Manage devices

Device management page allows managing all NCheck Bio Attendance client devices and API registered with the NCheck Bio Attendance NCheck Bio Attendance server.

_images/image274.PNG

Figure 162 Device management view of web control panel

  1. Devices/APIs list view

  2. Devices/APIs details view

  3. Search device by name

  4. Manage peripheral configuration

  5. Advanced options of manage devices

Devices/APIs list view

_images/image275.PNG

Figure 163 Devices/APIs table view

  1. Table header

  2. Selected device/API

    Details of the selected device/API are shown in Devices/APIs details view .

  3. Table paging options

Devices/APIs details view

This view represents the selected device/API details.

_images/image276.PNG

Figure 164 Device/API details view

  1. Device/API quick view

  2. Peripherals view

Device/API quick view

This view shows available details and operations for the selected device/API.

_images/image278.PNG

Figure 165 API quick view

_images/image280.PNG

Figure 166 device quick view

  1. Selected device/API description

  2. Device/API block/unblock state

  3. Name of the OS

  4. Logo of the OS

  5. Version of the OS

  6. Edit button

    Refer Edit device section for more details

  7. Re-register button

    Re-register device for user/user group. Refer Re-register device section for more details.

  8. Block/unblock button

    Refer Block/unblock device/API section for more details.

  9. Unregister device

    Refer Unregister device section for more details.

  10. Device settings button

    Refer Device settings section for more details.

  11. Edit button

    Refer Edit API section for more details

  12. API access permission

    1. Read-only

      Registered user group allows to retrieve data

    2. Read-Write

      Registered user group allows to retrieve/alter data

  13. Link to open NCheck Bio Attendance API documentation.

Edit device

This view allows the edit the device details.

_images/image281.PNG

Figure 167 Device management edit device view

  1. Device name

  2. Device code

  3. Device description

  4. Peripheral configuration

    Peripheral configuration for the device. Default peripheral configuration is selected by default. To create peripheral configuration, refer Manage peripheral configuration section.

  5. Save button

    Save button will be disabled if the mandatory fields are empty or Validation errors exists.

  6. Cancel button

Edit API

This view allows to edit the API details.

_images/image282.PNG

Figure 168 Device management edit API view

  1. API code

  2. Description

  3. Password

  4. API access permission

  5. Save button

    Save button will be disabled if the mandatory fields are empty or Validation errors exists.

  6. Close button

Re-register device

This view allows to re-register the selected device.

_images/image283.PNG

Figure 169 Device management re-register device view

  1. Device code Employee/username or group name

  2. Generate button

    To generate registration code. Generate button will be disabled if the employee/group code has not selected.

  3. Registration code and QR code

    Use this code to register the NCheck Bio Attendance client device.

  4. Close button

Block/unblock device/API

Block/unblock selected device/API from the list. If the device/API has blocked

  1. User could not be able to enroll biometrics or record attendances from the blocked devices.

  2. User could not be able use APIs

Unregister device

Unregister the selected device/API from the list. Unregister devices should reregister to record attendances.

Peripherals view

Peripheral view shows all available peripheral of the selected device.

_images/image288.PNG

Figure 172 Device management manage peripheral view

  1. Peripheral table

  2. Peripheral quick view

  3. Edit button

    To Edit selected peripheral. Read Edit peripheral section for more details.

  4. Disable button

    Enable/disable selected peripheral.

Peripheral table

Peripheral table represents all detail of the available peripherals.

_images/image290.PNG

Figure 173 Peripheral table view

  1. Table header

  2. Name

    Peripheral name

  3. Type

    1. Face

    2. Fingerprint

    3. Iris

    4. User id

    5. Barcode

    6. RFID

  4. Status

    Enable/disable status of the peripheral.

  5. Connection status

    1. Connected

      When the peripheral is available with the device.

    2. Disconnected

      When the peripheral is not available with the device.

  6. Table peripheral

    Selected peripheral details are shown in Peripheral quick view .

Peripheral quick view

_images/image292.PNG

Figure 174 Peripheral quick view

  1. Peripheral name

  2. Peripheral configuration

    The peripheral configuration applied to the peripheral.

Edit peripheral

Edit peripheral view allows to edit peripheral details.

_images/image294.PNG

Figure 175 Edit peripheral view

  1. Peripheral code

  2. Name.

  3. Save button

    Save button will be disabled if the mandatory fields are empty.

  4. Close button

Manage peripheral configuration

Peripheral configuration can be applied to customize the peripherals of the device when record attendances. The default peripheral configuration is applying across all the peripherals of the selected device if the custom peripheral configuration is not available.

_images/image296.PNG

Figure 176 Manage peripheral configuration view

  1. Peripheral configuration table

  2. Add/edit peripheral configuration view

  3. Add/edit peripheral configuration view

Add/edit peripheral configuration view

This view allows to add new peripheral configuration or edit existing peripheral configuration.

_images/image298.PNG

Figure 177 Add/edit peripheral configuration view

  1. Name

    Unique name for the configuration

  2. Description

  3. Authentication mode

  4. External executable

  5. Verification order

  6. Event

    Event type as check-in, check-out, and any events.

  7. Add button

    Add button will be disabled if the peripheral name/external executable name and path is empty. Table 41 shows error messages could be appeared when add/edit peripheral configurations.

  8. Cancel button

Table 41 Error messages of add/edit peripheral configuration

Error code

Error message

2036

Peripheral configuration name has already existed.

Authentication mode

Authentication mode can be applied to authenticate user to identify or verify user. Available authentication modes are,

  1. Identification

    The identification is the default authentication mode. Identification is performed on biometric and user id data as mentioned below.

    1. Biometric data

      User biometric data such as face, finger print and iris are comparing against the database with previously collected biometric samples depending on the Recognition threshold . If the matching score is greater than the Recognition threshold value, user is considered as identified. Therefore, this mode may demand large processing time.

    2. User id data

      User id data such as user id, barcode and QR code are comparing against the database and giving the matching users.

  2. Verification

    The verification mode can be applied with a user id peripheral and a biometric peripheral to verify the user against the previously collected biometric sample. To get verified, matching score should be greater than Verification threshold .

    _images/image3011.PNG

    Figure 178 Device management verification mode combination

  3. None

    Attendances are not recording when the authentication mode is none.

Verification order

As mentioned in Authentication mode section, if the verification mode is selected, the verification order can be set as either the “id first” to enter the user id(employee code, barcode, RFID) first or the “Biometric first” to capture the biometric first.

External executable

System can be configured to run external programs (either from external executable or API) during user identification. For an example, an automatic door opening program can be executed upon successful user identification.

Add/edit external executable

This view allows to add new external executable or edit existing external executable.

_images/image304.PNG

Figure 179 Device management add/edit external executable

  1. Add new external executable

  2. Name

    Unique name for the external executable.

  3. Executable path

    API URL or absolute path for the external executable

  4. Trigger on

    Trigger the external executable on,

    1. Check-ins

    2. Check-outs

    3. Any events

    4. Unidentified events

  5. Parameters

    Following parameters with values can be passed to the URL or executable.

    1. Event (EVENT)

      Event type as CHECKIN, CHECKOUT or UNIDENTIFIED.

    2. Sequence id (SEQUENCE_ID)

      Id of the event.

    3. Time stamp (TIMESTAMP)

      Date and time of the event.

    4. User reference (USER_REF)

      Employee code of the user.

    5. Username (USER_NAME)

      First name and last name of the user event recorded.

    6. Shift code (SHIFT_CODE)

      Shift code of the NCheck Bio Attendance Standard clients. In the standalone mode shift code is DEFAULT.

    7. Location (LOCATION)

      Longitude and latitude of the event geo location. example: {Longitude, latitude}

    8. User status (USER STATUS)

      User is blocked or not. Pass 0 if the user has blocked otherwise 1.

    9. Address (ADDRESS)

      Address of the user.

    10. Peripheral code (PERIPHERAL_CODE)

      Unique identified number of the peripheral.

  6. Remove button

    Remove external executable.

Advanced options of manage devices

  1. Generate API access credentials

Generate API access credinitals

NCheck Bio Attendance server has given the API access to access user, biometric, event data across given user group to use in third party applications.

_images/image306.PNG
_images/image306.PNG

Figure 180 Device management API credentials view

  1. Selected user group

    The default is All user group

  2. Description

  3. API access

    Assign permission to use API

    1. Read only (Auditor)

      Assigned user group allows only to retrieve data from the API.

    2. Read-Writer (Admin)

      Assigned user group has permission to retrieve and alter data.

  4. Create button

    Create button will be enabled if the API description has added. After create API, user name and password which is required for API access will appear as shown in Figure 5127. For more details refer API Documentation section.

    _images/image308.PNG

    Figure 181 API access credentials view

The error messages could be appeared when creating API are showing below.

Table 42 Error messages of API credentials creation

Error code

Error message

2036

Peripheral configuration name has already existed.

Manage Event logs

Event logs can administrator to add, edit, delete and review all event logs recorded.

_images/image310.PNG

Figure 182 Event log management view

  1. Refresh data

  2. Re-evaluate button

    Evaluate all the event logs to fix events with missing check-ins/check-outs.

  3. Add button

    Add new event log. Refer Add event log section for more details

  4. Add from unidentified button

  5. Import/export event logs

  6. Event log detail view

Add event log

This view allows to add new event log.

_images/image312.PNG

Figure 183 Add event log view

  1. Username

  2. Status

    Check-in or Check-out

  3. Selected date

  4. Selected time

  5. Time zone

  6. Shift

  7. Shift date

    When an employee Check-in or Check-out not in the same date

  8. as the event date, (E.g. Working overtime or Shift spans for two days) shift date should be specified. Otherwise the event will belong to current day’s shift.

  9. Description

  10. Add event button

    Add event button will be disabled if the user of the event has not been selected. Table 43 is showing the error messages could be appeared when add events.

  11. Close button

Table 43 Error messages of add event logs

Error Code

Error message

2037

Could not record events. The device has been blocked

2042

Could not record events. The user has been blocked.

2043

Could not record event. Check-in time has restricted.

2044

Could not record event. Check-out time has restricted.

Add from unidentified

The events failed to identify users are called unidentified events. This feature allows to add events from unidentified events.

_images/image314.PNG

Figure 184 Add event from unidentified event view

  1. Date filter

  2. Unidentified event list

  3. Unidentified event quick view

  4. Add button

    Add button will be disabled if no biometric image will be selected from the list. Add event log view will be shown to give details of user after select the add button.

  5. Close button

Unidentified event quick view

Biometric thumbnail image with the event timestamp are showing as follows.

_images/image316.PNG

Figure 185 quick view of the unidentified event

  1. Modality thumbnail

  2. Delete unidentified event button

  3. Unidentified event details button

  4. Event date and time

Unidentified event details view

The detail view of the unidentified events.

_images/image318.PNG

Figure 186 Unidentified event details view

  1. Modality thumbnail

  2. Modality type

    1. Face

    2. Fingerprint

    3. iris

  3. Event date and time

  4. Latitude of the event location

  5. Longitude of the event location

  6. Event address

  7. Close button

Event log detail view

  1. Event/map view

  2. Overtime view

Event/map view

Event view show all user event for the selected date.

_images/image320.PNG

Figure 187 Events view

_images/image322.PNG

Figure 188 Map view

  1. Event filters view

  2. Selected date view

  3. Selected event quick view

  4. Event calendar view

  5. Events table

  6. Map view

Event filters view

All events can be filtered as follows,

_images/image324.PNG

Figure 189 Event filters view of event/map view

  1. Select shifts

    Filter events by shifts. Default shift is All shifts.

  2. Select user groups

    Filter events by user group. Default user group is All user group.

  3. Select user

    Filter events by selected user.

  4. Show only error events

    Filter check-ins without check-outs and check-outs without check-ins.

  5. Group events

    1. Event time: Events will be displayed according to the check-in/checkout time in the day.

    2. Shift time: Events will be displayed based on the shift start time and shift end time.

Selected date view

_images/image326.PNG

Figure 190 Selected date view of event/map view

  1. Selected date

  2. Day start time

  3. Select today button

    Select this button to select the current date from the calendar view.

Selected event quick view

_images/image327.PNG

Figure 191 Event log management selected event quick view

  1. Event type

  2. Username

  3. Event time

  4. Event location

  5. Edit button

    Refer Edit event section for more details.

  6. Delete button

Event calendar view

Event calendar is representing following details.

_images/image328.PNG

Figure 192 Calendar view of event/map view

  1. Selected month

  2. No. of missing check-outs

  3. Events recorded with correct check-ins and check-outs sequence.

  4. No. of missing check-ins

  5. Current date

  6. Calendar month navigation buttons

Events table

_images/image330.PNG

Figure 193 Event table view

  1. Table header

  2. Name

  3. User ID

  4. Shift name

  5. Direction and status

    Event type as check-in or check-out

  6. Event time

  7. Event time zone

  8. Location

    Longitude and latitude coordinates of the event location.

  9. Address

    Address of the event location

  10. Selected event log

    To edit event, double click on event log row. Refer Edit event for more details.

  11. Table paging options

Edit event

_images/image332.PNG

Figure 194 Event log management edit event

  1. name

  2. Status

  3. Event date

  4. Event time

  5. Event time zone

  6. Shift

  7. Shift date

  8. Event location

  9. Show location button

    Show the event location on the google map.

  10. Description

  11. Authentication

    Authentication as face, fingerprint, iris, barcode, RFID, or user id

  12. Event record type

    1. Event recorded by admin

      Event added by admin

    2. Online recorded event

      Event recorded from NCheck Bio Attendance client application.

  13. Save changes button

    Following errors could be occurred when save changes of event logs.

  14. Close button

Table 44 Error messages of edit device

Error Code

Error message

2037

Could not record events. The device has been blocked

2042

Could not record events. The user has been blocked.

2043

Could not record event. Check-in time has restricted.

2044

Could not record event. Check-out time has restricted.

Map view

The event map is showing the location of user’s recent event for the selected date. All checkout events are shown in red color and check-in events are shown in green color. Selected event will be shown in yellow color.

_images/image333.PNG

Figure 195 Event log management Map view

_images/image336.PNG

Check-in events are showing in green color

_images/image338.PNG

Checkout events are showing in red color

_images/image340.PNG

Selected event is showing in yellow color

Overtime view

_images/image342.PNG

Figure 196 Overtime view

  1. Overtime filter view

  2. User overtime quick view

  3. Overtime calendar view

  4. Overtime table

Overtime filter view

Overtime filter view shows following filters

_images/image344.PNG

Figure 197 Filter view of the Overtime view

  1. Select shifts

    Filter events by shifts. Default shift is All shifts.

  2. Select user groups

    Filter events by user group. Default user group is All user group.

  3. Select user

    Filter events by selected user.

User overtime quick view

Overtime quick view shows following details.

_images/image346.PNG

Figure 198 User overtime quick view

  1. Username

  2. Max overtime status

  3. Overtime hours

  4. Edit button

Overtime calendar view

Overtime calendar shows following information for each day.

_images/image347.PNG

Figure 199 Overtime calendar view

  1. Selected month

  2. Number of overtime entries submitted to approval or rejection

  3. Calendar month navigation

Overtime table

_images/image348.PNG

Figure 200 Overtime table view

  1. Table header

  2. Username

  3. employee code

  4. First checked-in date and time

  5. Last checked-out date and time

  6. Max overtime status

  7. Number of overtime work hours user has worked

  8. Number of Max OT hours allowed for the shift

  9. Selected overtime

    Selected overtime details are shown in User overtime quick view

  10. Table paging options

Edit overtime

This view allows to edit overt time details.

_images/image352.PNG

Figure 201 Edit overtime view

  1. Username

    Username cannot be adapted.

  2. Check-in date

    Check-in date cannot be adapted.

  3. Overtime hours

    Number of overtime hours user has worked. This entry cannot be updated.

  4. Max OT

    Number of maximum overtime hours allocated for user.

  5. Max overtime status

  6. Shift

    Shift cannot be updated

  7. Save changes button

    Save changes button will be disabled if the Validation errors exists. Table 45 shows all error messages.

  8. Cancel button

Table 45 Error message of edit overtime

Error code

Error message

3010

Could not record overtime. Overtime should not be greater than the max overtime hours.

Max overtime status

  1. None

    Once user completed the events for the day, approval status will be none if the overtime hours exist. Administrator will mark the overtime as approved or rejected.

  2. Approved

    Accepted overtime by administrator.

  3. Rejected

    The rejected overtime by administrator.

Import/export event logs

Import event logs

_images/image354.PNG

Figure 202 Import event logs view

Import event logs information can be imported as mentioned in Import and Export information section. To import event logs,

  1. Select event logs

  2. Select Start import button

    Select Start import button to select event logs file. Refer Select import location for more details.

Export event logs

_images/image358.PNG

Figure 203 Export event logs view

Event log details can be exported as password protected zip file as below.

  1. Export event log information for selected date.

  2. Start export button

  3. Select start export button to select the event log export location.

    Refer Select export location for more details.

Reports

Report page provides a set of standard reports on employee time attendance. Report view as follows,

_images/image3611.PNG

Figure 204 Report view of Web control panel

  1. Report types

  2. Report settings

  3. Export menu

    Refer Export report data section for more details.

  4. Schedule menu

    Refer Schedule reports section for more details.

  5. View schedules

  6. Report filters

  7. Report area

  8. Reload page

Report types

The available reports are,

  1. Total work hour report

  2. Work hour summary report

  3. Productivity report

  4. User detail report

  5. Event details

  6. Arrival and Departure report

Total work hour report

The Total work hours report provides work hours details for a selected date range. That details can be calculated by daily, weekly, monthly basis. The important parameters are

  1. From

    Date range start

  2. To

    Date range end

  3. First name

  4. Last name

  5. Employee code

  6. Productive work hours (HPS)

  7. Overtime hours

  8. First check-in

  9. Last check-out

  10. In-out hours

  11. Productive hours (HP)

  12. Shift work hours (HS)

  13. Work hours

Work hour summary report

This report provides the details as follows for users/employees.

  1. Name

  2. Employee code

  3. Work hours

  4. Overtime hours

  5. Shift hours

  6. Shift work hours (HS)

  7. Productive hours (HP)

  8. Productive work hours (HPS)

Productivity report

Productivity report is generated for a selected time period with user/employee productivity parameters as follows.

  1. First name

  2. Last name

  3. Employee code

  4. From

    Date range start

  5. To

    Date range end

  6. First check-in

  7. Last check-out

  8. Work hours

  9. Late arrival

  10. Late departure

  11. Early arrival

  12. Early departure

  13. Overtime hours

  14. Productive hours (HP)

  15. Unproductive hours

User detail report

The user details report provides a list of user’s information. The available details are

  1. User code

  2. First name

  3. Last name

  4. Deleted

    Whether the user has deleted or not

  5. Active

    Whether the user is blocked or not

  6. Address

  7. City

  8. Email

  9. Country

  10. Zip/postal code

  11. State

  12. phone number

Event details

Event details represent all users/employees event details information as follows.

  1. Name

  2. ID

  3. Shift name

  4. Shift starts

    Start time of the shift.

  5. Direction and status

    Event type as check-in or check-out.

  6. Time

    Event time

  7. Time zone

    Time zone difference in hours with respective to UTC.

  8. Location

    Longitude and Latitude coordinates of the event location.

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)

  1. Date

  2. First name

  3. Last name

  4. Employee code

  5. Availability

    Preset or absent

  6. Shift name

  7. Shift start

  8. Shift end

  9. First checked-in

    First checked-in time

  10. Early arrival

  11. Late arrival

  12. Last checked-out

    Last checked-out time

  13. Early departure

  14. Late departure

  15. Event logs count

  16. Roster item count

  17. Additional

    Additional staff

  18. Replacements

  19. Number of holidays

  20. Number of Leaves

  21. Leave policy

    Leave policy as normal or restricted.

Report settings

_images/image362.PNG

Figure 205 Report settings

  1. Report calculation strategy

    Change the calculation based on Daily, Weekly and Monthly basis.

  2. Date range

    Date range can be changed daily, weekly, and monthly according to the report calculation strategy selected above.

  3. Show

    This setting allows to add following columns to the Workhour report

  4. Show time

    Show report time wither in hours and reports or hours.

Report filters

_images/image363.PNG

Figure 206 Report filters view

  1. Shifts filter

    Filter report by shift.

  2. User groups filter

    Filter report by user group.

  3. Username filter

    Filter report by user.

Export report data

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 Table menu section. Report can be exported as follows

  1. PDF format

  2. CSV format

PDF format

Download the selected report in PDF format. When select PDF format, it will ask the font size of the pdf as follows.

_images/image364.PNG

Figure 207 Configure PDF font size in the report

  1. Report font size

    Set the font size of the PDF report between 9 and 15.

  2. Generate button

    Generate report

  3. Close button

CSV format

Download the selected report in CSV format.

Schedule reports

Note

Schedule report feature is not available for work hour summery report.

Schedule export option allows to

  1. Send reports in CSV format for the selected users daily weekly or monthly basis

  2. Backup CSV report in FTP daily, weekly, or monthly

Schedule report configurations are showing below.

_images/image366.PNG

Figure 208 Schedule reports view

  1. Report configuration

    This view is showing the specific configurations applied from Report settings and Report filters to the selected report

  2. Sending options

  3. Send date

    Report sending date

  4. Send time from

    The time report must be sent

  5. Frequency

    1. Every day

      Send the report on every day at the schedule time

    2. Every week

      Send the report once a week in above scheduled date time

    3. Every month

      Send the report once per month based on the scheduled date and time

Checking at advanced option allow to configure the period in days to send the report at once.

  1. Schedule end

    1. No end date

      Report will send continuously

    2. Have end date

      Specify the date to stop receiving the report

  2. Save changes button

    Table 46 shows error messages after select save changes button.

  3. Close button

Table 46 Error messages of schedule reports

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

Sending options

Following sending option(s) can be selected

  1. Email

  2. FTP configuration

  3. Local folder

Email

The report will be emailed to the selected recipients

_images/image370.PNG

Figure 209 Email configuration of the schedule report view

  1. Enter recipients’ email(s) separated by commas

  2. Find recipients from employee using the name

  3. Find recipients using the user group

FTP configuration

The report will be saved in the FTP location.

_images/image372.PNG

Figure 210 FTP configuration of the schedule report view

  1. FTP URL

  2. Check this if the FTP access credentials is required

  3. FTP Username

  4. FTP password

Local folder

The report will be downloaded into the given file path in the local file system.

View schedules

This feature allows to view/edit all report schedules as follows.

_images/image374.PNG

Figure 211 View report schedules

  1. Report schedule table

  2. Edit button

    Edit report schedules as mentioned in Schedule reports section

  3. Delete selected report schedule

  4. Close button

Report schedule

Report scheduled table is showing following information.

  1. Report type

    Type of the scheduled report

  2. Emails

    Email(s) of the recipients

  3. Users

    Username(s) of the recipients

  4. Groups

    Group names to send the reports for all users in the groups

  5. Sum by

    Report frequency daily, weekly, or monthly

  6. Next schedule date

  7. Next schedule time

  8. Ends on

    Report end date if specified

  9. Send time base

  10. FTP export

  11. Created time

    Created time of the report schedule

Settings

NCheck Bio Attendance server control panel settings are

  1. General settings view

  2. Client settings view

  3. Biometric settings view

  4. Web interface settings view

Notifications

_images/image382.PNG

Figure 216 Notification settings view of settings

  1. Email notification settings

  2. SMS notification settings

  3. Save button

    Save email and SMS notification settings changes.

Email notification settings

Email server can be configured with NCheck Bio Attendance On-premises server to receive notifications such as change login details, share device registration token, schedule reports. The following settings need be added to enable emails.

_images/image384.PNG

Figure 217 Email notification settings

  1. Host name

    SMTP server to manage emails.

  2. Port

    SMTP Server port. The default port is 25.

  3. Sender

  4. SSL

    Enable SSL2 configuration to ensure the safety and security of the emails

  5. Authentication

    Enable disable authentication for email server

  6. Username

    The Username of the host server. This is also the sending email address for all email notifications.

  7. Password

    The password of the host server

Sender

Sender should be configured in order to display the sender details of the receiving emails in the email client. There are two formats can be used for sender

  1. Name <Email address>

    ex: Kathrine <Kathrine@abc.com>

  2. Email address <Email address>

SMS notification settings

SMS notification settings allows to add SMS gateway to receive SMS notification send registration token, leave and holiday notifications.

_images/image386.PNG

Figure 218 SMS notification settings

  1. Host name

    Host name of the SMS gateway

  2. Username

  3. Password

  4. Port

Admin Tasks

NCheck Bio Attendance admin tasks view as follows,

_images/image388.PNG

Figure 219 Bio Attendance admin tasks of Web control panel

  1. Data backup and restore

  2. Re-extract template

  3. Delete old eventlogs

  4. Export data

  5. Import data

  6. Admin operation logs

Data backup and restore

Note

This feature is not available for NCheck Bio Attendance Cloud server

NCheck Bio Attendance server allows the administrator to backup/schedule backup all data in the specified location securely in JSON format.

Backup information

The backup file must contain following details

Table 47 Backup information

File name

details

AuthentcationData.json

Customer.json

Organization details as given in My Account section

CustomerLeaveTypes.Json

Leave types as configured in Configure leave type section.

CustomerSettings.json

Customer settings as mentioned in Settings section

Device.json

Device/API details as mentioned in Devices/APIs details view ,

FileData.json

Holiday.json

Holiday details as mentioned in Manage Leaves and holidays section.

OAuth2User.json

Peripheral.json

All peripheral details of each device as mentioned in Peripherals view section

PeripheralConfiguration.json

Peripheral configurations details

Person.json

User details

Roster.json

All roster details as mentioned in Roster management view section.

RosterItem.json

All roster item details as mentioned in Roster item management view section.

Task.json

All shift details as mention in Shift management view section.

UserGroup.json

All user group details as mentioned in Manage user Groups section.

UserGroupMembership.json

All users of user groups detail as mentioned in Attached users section.

Note

It is strongly recommended to not alter backup files in order to restore data successfully.

Backup database

This view allows to backup NCheck Bio Attendance database.

_images/image390.PNG

Figure 220 Database backup view

  1. Start backup button

    Refer Backup configuration section for more details.

  2. Schedule backup button

    Refer Schedule backup section for more details.

  3. View schedules

    Refer View schedules section for more details.

  4. Show previous backup

Backup configuration

Database can be backed up in different locations as follows,

  1. Save backup in local folder

  2. Save backup in FTP location

    _images/image392.PNG

    Figure 221 Backup database view

  3. Save backup either in FTP or local folder. Refer

  4. File password

    The Password must have at least 6 characters with one digit.

  5. Confirm password

  6. Backup event logs

    Check this option to backup all event logs

  7. Backup event logs from

    If the Backup event log option is checked, select the date from which date event logs must be included.

  8. Execute button to start

    Execute button will be disabled if the mandatory fields are empty or Validation errors exist. Table 48 Following errors could be occurred.

  9. Close button

Table 48 Error messages of backup database

Error code

Error message

1003

Unable to connect with the FTP server {server name}

3003

Password does not match.

3004

Password must contain at least 6 characters with one number.

2045

Could not email reports for the recipients.

2046

Invalid FTP file path

2047

Invalid FTP username or password

4001

Unidentified error occurred during data restore. Please contact administrator or NCheck Bio Attendance support for more details.

Schedule backup

This feature can be used to automate database backup as daily, weekly, and monthly in following locations.

  1. Schedule backup in local folder

  2. Schedule backup in FTP location

  3. Schedule backup in local folder

  4. Schedule backup in FTP location

_images/image394.PNG

Figure 222 Schedule backup in local folder view

  1. Saving backup in either local or FTP folder. Refer

  2. File password

    Password must have at least 6 characters with one digit.

  3. Confirm password

  4. Backup event log

    Check this option to backup all event logs

  5. Backup event log from

    If the Backup event log option is checked, select the date from which date event logs must be included.

  6. Schdule date

  7. Backup frequency

    Backup fequency as daily, weekly or monthly.

  8. Schdule backup button

    Execute button will be disabled if the mandatory fields are empty or Validation errors exist. Table 49 is showing the errors could be occurred.

  9. Close button

Table 49 Error messages of schedule database backup

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

View schdules

This view shows the existing email schedules and operations as follows.

_images/image396.PNG

Figure 223 View schedules view

  1. Date

    Schdule date

  2. Frequency

  3. Directory

    Local or FTP directory path

  4. Remove button

    Remove schduled backup

  5. Close button

Local folder configuration

_images/image397.PNG

Figure 224 Local folder configuration view

  1. File path

    File path to the local folder

FTP folder configuration

Following details are required to enable FTP configuration.

_images/image398.PNG

Figure 225 FTP details view of the schedule report view

  1. FTP host address

  2. File path in the file system

  3. Check this if the FTP access credentials is required

  4. FTP Username

  5. FTP password

Restore server databases

Refer Restore database section for more details.

Re-extract template

Note

This feature is not available for NCheck Bio Attendance Cloud server

Re-extract users biometric templates from biometric engine and re-enroll to improve recognition accuracy.

_images/image399.PNG

Figure 226 R-extract templates view

  1. Re-enroll button

    Refer Re-enroll templates section for more details.

  2. Show previos extraction jobs

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.

_images/image400.PNG

Figure 227 Re-extract template confirmation window

Table 50 Error messages for enroll templates

Error code

Error message

2002

License cannot be obtained

2048

Biometric re-extraction has failed on following images.

  1. {images list}

Delete old eventlogs

NCheck Bio Attendance Server keeps daily eventlogs of each user in the database and its causes to increase the database size with the time. Delete event logs feature can be used to manage unwanted eventlogs details in the database as follows.

_images/image403.PNG

Figure 228 Delete old eventlogs view

  1. Months to keep

    Number of months to keep eventlogs in the database

  2. Delete

    Delete image log either with image or delete the eventlog image.

  3. Delete button

Import data

Following information can be imported as a zip with the file hircahy as mentioned in Import and Export information section.

_images/image405.PNG

Figure 229 Admin tasks import data view

  1. User group information

  2. User/user group location restrictions information

  3. User biometrics and template files

  4. User group information

  5. User group memberships information

  6. User/user group location restrictions information

  7. Shifts information

  8. Roster items information

  9. Leaves information

  10. Holidays information

  11. Event logs information

To import,

  1. Select information need to import

  2. Select Start import button to select import location as mentioned in Select import location section.

Export data

You are allowed to export following information as password protected zip file.

  1. User group information

  2. User/user group location restrictions information

  3. User group information

  4. User group memberships information

  5. User/user group location restrictions information

  6. Shifts information

  7. Roster items information

  8. Leaves information

  9. Holidays information

  10. Event logs information

    Select the date to export event log form the date

To export,

  1. Select information need to export

  2. Select the Start export button to select export location as mentioned in Select export location section

Admin operation logs

Administrator operation logs in the NCheck Bio Attendance On-premises server control panel such as login, logout, add event logs, modify event logs, delete event logs, add person, modify person, delete person can be seen from this feature.

_images/image409.PNG

Figure 230 Admin tasks admin operations logs

  1. View logs button

    Refer View logs section for more details.

View logs

  1. Filters

    Select date range.

  2. Admin logs table

  3. Admin log quick view

    _images/image411.PNG

    Figure 231 Admin logs view logs view

Admin logs table

Admin logs table presents all available admin logs as follows.

_images/image413.PNG

Figure 232 Admin logs admin logs table view

  1. Table header

  2. Owner

    The role name who performed the admin operations.

  3. Username

    Name of the administrator.

  4. Action

    1. Login

    2. Logout

    3. Add event log

    4. Modify event log

    5. Delete event log

    6. Add user

    7. Edit user

    8. Delete user

  5. Date and time

  6. Selected admin log

    Selected admin log detail are shown in admin log quick view.

  7. Table paging options

Subscription

Note

Subscription is not available on NCheck Bio Attendance On-premises server.

_images/image414.PNG

Figure 233 Cloud subscription view of web control panel

  1. Plan statistics

  2. License statistics

  3. Outstanding summery

  4. Payments

Plan statistics

_images/image415.PNG

Figure 234 Subscription plan statistics

  1. Plan code

  2. Plan started date

  3. Rate

    Price per month in euros

  4. User limit

    Maximum number of user limits of the plan.

  5. Credit period

    Extension period to make the payment once the plan has expired. The account will be blocked automatically exceed the credit period.

  6. Paid to

    The plan has been purchased for this date.

  7. Remaining usage

    Remaining usage of the plan for the existing balance.

  8. Due date

    Expiration date of the plan after exceeding the Remaining usage and credit period.

  9. Balance

    Balance for the current date.

  10. 5.18.1.1 Change plan

  11. 5.18.1.2 Plan details history

5.18.1.1 Change plan

This view allows to change the NCheck Bio Attendance plan as follows.

_images/image416.PNG

Figure 235 Change plan window

  1. Cloud plan list

    Refer Cloud plans section for more details about cloud plans. The available plans are

    1. Free plan

    2. Plan 20

    3. Plan 50

    4. Plan 100

    5. Plan 200

  2. Plan statistics

  3. Proceed button

    Proceed button will be disabled with the errors are shown in Table 51 .

  4. Close button

Table 51 Error messages of change plan

Error code

Error messages

2049

Your current subscription has blocked. Please settle the outstanding amount and try again.

2050

Customer has blocked. Please contact NCheck Bio Attendance support.

5.18.1.2 Plan details history

Plan history window shows following information.

_images/image417.PNG

Figure 236 Plan history window

  1. Plan history

  2. License history

  3. Blocked history

Plan history

Plan history is showing all the plans used previously and the currently using plan.

_images/image419.PNG

Figure 237 Plan history view

  1. Table header

  2. Stated at

  3. Expired at

  4. Plan code

  5. Description

  6. Plan rate

  7. Table paging options

License history

License history shows all licenses currently in used and used before with following information.

_images/image421.PNG

Figure 238 License history view

  1. Table header

  2. Created at

  3. Expired at

  4. Plan code

  5. Modified date

  6. Table paging options

Blocked history

Plan block history shows plan block information as follows.

_images/image423.PNG

Figure 239 Blocked history view

  1. Table header

  2. Blocked date

  3. Blocked reason

  4. Unblocked date

  5. Unblocked reason

  6. Plan name

  7. Table paging options

License statistics

Licenses should be purchased to user the premium features with NCheck Bio Attendance client devices. Administrator allows to change Maximum number of licenses. The amount will be calculated to the maximum License count.

_images/image425.PNG

Figure 240 Subscription license statistics view

  1. Number of used license(s) and available license(s)

  2. License rate in Euros.

  3. Maximum number of licenses

  4. Percentage of the used licensees out of maximum number of licenses

Outstanding summery

Outstanding summary is a detail view of all available payments up to current date.

_images/image427.PNG

Figure 241 Outstanding summery of the Subscription

  1. Summery table

  2. View and pay bill button

    Refer View and pay bill section for more details

  3. Schedule payments button

    Refer Schedule payments section for more details

Summery table

_images/image429.PNG

Figure 242 Outstanding Summery table

  1. Outstanding plan amount

  2. Outstanding license amount

  3. Licenses/plans

    NCheck Bio Attendance Cloud server plans and clients license names with rate.

  4. Start at

    Start date of the Licenses/plans.

  5. Expire at

    Expiring date of the Licenses/plans.

  6. Paid to

    Until which date administrator made the payment Duration between plan start date and expired date/current date.

  7. Total

    Total amount for the usage.

View and pay bill

Draft bill of the NCheck Bio Attendance cloud subscription can be generated using this view.

_images/image431.PNG

Figure 243 View and pay bill view

  1. Reference number of the bill

  2. Export to PDF

  3. Neurotechnology company logo and contact information

  4. Draft view of the bill

  5. Proceed button

    Once you select procced button you will be directed to the detailed receipt. Refer Proceed for payments section for more details. Before proceeding make sure that you have not pay the bill before. Because it will take time to update billings after completed the payments.

  6. Close button

  7. Delete button

    Delete the generated bill.

Bill view

_images/image433.PNG

Figure 244 Draft view of the bill

  1. Bill generated date

  2. Customer name

  3. Customer email address

  4. VAT number

  5. Customer address

  6. Item description

    Plan/licenses name

  7. From

    The bill start date, total amount of the plan/license calculated from

  8. To

    The end date, total amount for the plan/license calculated to

  9. Plan rate

  10. Total

  11. Total plan usage

  12. Vat

  13. Total amount for plan/license usage in Eur

Proceed for payments

Once select the proceed button, user will be directed to the detailed bill shown as Figure 246 . Once select the Pay bill button, user will be asked a confirmation message as shown Figure 245 before proceed to the PayPal payment gateway.

_images/image435.PNG

Figure 245 Payment confirmation window

_images/image436.PNG

Figure 246 Detailed bill view

Schedule payments

All the payments can be scheduled on selected date to pay cloud plan outstanding amount automatically using PayPal.

_images/image437.PNG

Figure 247 Confirm PayPal subscription window

  1. Current subscription details

    1. Plan rate

    2. User limit

    3. Number of licenses

    4. Current plan

  2. Calendar view to select schedule payments

  3. Selected date

  4. subscribe and schedule button

    After select subscribe and schedule button, user will be asked a confirmation messages as shown in Figure 247 . Select OK button to procced PayPal to subscribe the monthly payments.

  5. Close button

    _images/image439.PNG

    Figure 248 create PayPal subscription view

Note

NCheck Bio Attendance will not save your PayPal username and password. Do not close the browser tab until you redirecting to NCheck Bio Attendance after payment completed in PayPal.

Payments

All pending, completed, failed payments are showing in this view.

_images/image443.PNG

Figure 249 Payments view

  1. Payments table

  2. Payment quick view

Payments table

Payment table presents all failed, pending and completed payment details as follows.

_images/image445.PNG

Figure 250 Payments table

  1. Table header

  2. Payment date

  3. Billed date

  4. Total amount

  5. Status

    1. Completed

    2. Failed

    3. Pending

  6. Selected payment

    Selected payment details are shown in Payment quick view .

  7. Table paging options

Payment quick view

_images/image447.PNG

Figure 251 Payment incomplete view

_images/image449.PNG

Figure 252 Payment completed view

  1. Payment status

    1. Completed

      paid date is appeared

    2. Failed

    3. Pending

  2. Billed date

    Bill created date

  3. Received date

    Payment received date

  4. Total

  5. Plan usage

    1. Item

      Plan name

    2. From

    3. To

    4. Rate

    5. Total

  6. Total plan usage

  7. Show invoice button

  8. Detailed receipt button

  9. Delete button

    Delete pending payment

  10. Complete payment button

    User will be directed to the detailed receipt to proceed with the payment as mentioned in Proceed for payments section.

Users Service portal

NCheck Bio Attendance Cloud/On-premises server control panel for user allows reviewing user specific data for each user. Following operations are available for users

  1. Manage user account

  2. User event logs

  3. Roster and schedules

  4. Leaves and holidays

  5. User reports

  6. User settings

Manage user account

Select the user icon in the navigation bar.

_images/image451.PNG

Figure 253 User management view

  1. Username

  2. User profile image

  3. User email address

  4. Account type

  5. My account button

    Refer Manage user details section for more details

  6. Login options

  7. Sign out

Manage user details

_images/image453.PNG

Figure 254 Manage user details

  1. Browse button

    Select the user image

  2. First name

  3. Last name

  4. Employee code

  5. Email

  6. Username

  7. Address line 1

  8. Address line 2

  9. City

  10. Country

  11. State

  12. Zip code

  13. Telephone

  14. Update button

    Update button will be disabled if the mandatory fields are empty or Validation errors exist. Table 52 is showing error messages could be occurred on updating user details.

  15. Close button

Table 52 Error messages of manage user details

Error code

Error message

3001

Mobile/telephone number is not valid for the selected country/region.

3002

Invalid email address.

User event logs

Event logs allow monitoring user attendances. User event log view as follow.

_images/image457.PNG

Figure 255 User event logs view of web control panel

  1. Refresh data button

  2. Event logs filters

  3. Calendar date quick view

  4. Calendar view

  5. Event logs view

  6. Event log quick view

Event logs filters

Filter user event logs as follows.

_images/image459.PNG

Figure 256 User event log filters view

  1. Select shifts

    Filter events by shifts. Default shift is All shifts.

  2. Show only error events

    Filter check-ins without check-outs and check-outs without check-ins.

  3. Group events

    1. Event time: Events will be displayed according to the check-in/checkout time in the day.

    2. Shift time: Events will be displayed based on the shift start time and shift end time.

Calendar view

Calendar view shows following details.

_images/image461.PNG

Figure 257 User calendar view

  1. Selected month

  2. No. of missing check-outs

  3. Events recorded with correct check-ins and check-outs sequence.

  4. Number. of missing check-ins

  5. Current date

Calendar date quick view

_images/image463.PNG

Figure 258 Calendar date quick view

  1. Calendar selected date

  2. Select today button

    Select current date from the calendar

Event logs view

_images/image464.PNG

Figure 259 User event logs list view

  1. Table header

  2. Name

  3. User ID

  4. Shift name

  5. Direction and status

    Event type as check-in or check-out

  6. Event time

  7. Event time zone

  8. Location

    Longitude and latitude coordinates of the event location.

  9. Address

    Address of the event location

  10. Selected event log

    Selected event log detail are shown in Event log quick view

  11. Table paging options

Event log quick view

Quick view of the event detail.

_images/image465.PNG

Figure 260 User event log quick view

  1. Event type

    1. Check-in

    2. Check-out

  2. Event location

  3. Event time

  4. Review button

    View event log details. Refer Event log review section for more details.

Event log review

This view present user event log detail view as follows.

_images/image467.PNG

Figure 261 User review event window

  1. Event biometric view

  2. Username

  3. Shift name

  4. Status

  5. Check-in

  6. Check-out

  7. Event date

  8. Event time

  9. Event time zone

  10. Event location

  11. Description

  12. Authentication mode

  13. Face

  14. Iris

  15. Fingerprint

  16. Event recorded type as by admin or online

  17. Show location button

  18. Close button

Roster and schedules

The users able to monitor below details in the rosters and schedules.

_images/image468.PNG

Figure 262 Shift and roster management view of user web control panel

  1. Shifts view

  2. Rosters view

  3. Roster items view

Shifts view

Shift view shows available shifts for user.

_images/image469.PNG

Figure 263 user Shift view

  1. Shift name

  2. Shift start time

  3. Shift end time

Rosters view

All available rosters are showing in this view as follows.

_images/image470.PNG

Figure 264 User rosters view

  1. Roster name

  2. Roster duration

  3. End date

  4. Status

  5. Holidays button

    Refer View holidays section for more details.

  6. Leaves button

    Refer View leaves section for more details.

View holidays

All holidays applicable for organization can be viewed here.

_images/image471.PNG

Figure 265 User holidays view

  1. Yearly view

  2. Report view

  3. Close button

Yearly view

Yearly view of holidays as follows.

_images/image473.PNG

Figure 266 User holidays yearly view

  1. Calendar view

  2. Holiday table of user service portal

Holiday table of user service portal

Holiday table presents all holiday details as follows.

_images/image475.PNG

Figure 267 Holiday table view

  1. Table header

  2. Date of holidays

  3. Description

  4. Table paging options

Report view

Report view of the holidays as follows

_images/image477.PNG

Figure 268 User holiday report view

  1. Date filter

  2. Holiday table of user service portal

View leaves

All leaves applied by the user can be seen here.

_images/image479.PNG

Figure 269 User leaves view

  1. Calendar view of user service portal

  2. Report view of user service portal

  3. Apply for a leave button

    Refer section for more details.

  4. Close button

Calendar view of user service portal

Calendar view of the user leaves as follows.

_images/image481.PNG

Figure 270 User holidays calendar view

  1. Calendar

  2. No. Of leaves applied by the user

  3. Leaves table of user service portal

Leaves table of user service portal

Leave table presents all user leaves details in a table as follows.

_images/image483.PNG

Figure 271 Leaves table view

  1. Table header

  2. Username

  3. Leave start date

  4. Leave end date

  5. Leave type

    Refer Configure leave type section for more details

  6. Table paging options

Report view of user service portal

Report view of leaves as follows.

_images/image485.PNG

Figure 272 User holidays report view

  1. Date filter

  2. Leaves table of user service portal

Request leaves

User can apply a leave request to get the approval from NCheck Bio Attendance administrator.

_images/image487.PNG

Figure 273 Request leaves view

  1. Leave start date

  2. Leave end date

  3. No. of days

    Number of leaves should be applied between start date and end date deprecating holidays.

  4. Leave type

    Leave type from the configured leave types as mentioned in  Configure leave type section.

  5. Send request button

    Table 53 is showing error messages could be appeared.

  6. Close button

Table 53 Error messages of request leaves

Error code

Error message

2031

You already have applied the leave(s) for start date – end date.

2032

Could not exceed the available number of leaves for {leave type name} leave type.

Roster items view

_images/image489.PNG

Figure 274 User roster items view

  1. Current month

  2. Weeks view

    Filter roster items by shift

  3. Week view

  4. Roster item view of user service portal

Roster item view of user service portal

Roster item view is showing following details.

_images/image490.PNG

Figure 275 Roster item user view

  1. Shift details

    1. Shift start time

    2. Shift end time

    3. Shift name

  2. User group name

Leaves and holidays

This view allows to view user leaves, holidays and apply leaves.

_images/image491.PNG

Figure 276 Leaves and holiday management view of user service portal

  1. Apply/edit leave

  2. Leave table view

  3. Holiday table view

  4. Selected date view

  5. Summery view of selected leave

  6. Calendar view

Apply/edit leave

User allow to apply for a leave as below.

_images/image493.PNG

Figure 277 Request a leave dialogue view

  1. Start date

    Leave start date

  2. End date

    End date of the leave

  3. Request reason

  4. Leave type

    Leave type as Casual, Medical, Annual or custom leave type defined by the administrator.

  5. Send request button

    Send the leave request for Approval. Once the leave is approved or rejected, user will be get notified as shown in

  6. Cancel button

    Cancel the Request a leave dialogue.

_images/image495.PNG

Figure 278 Leave approval notification

Leave table view

Leave table shows leaves applied by the user for the selected date in the Calendar view .

_images/image497.PNG

Figure 279 Leaves table view of user service portal

  1. Start date

    Leave start date

  2. End date

    Leave end date

  3. No of day

    No of days leave applied

  4. Leave type

    Leave type as Casual, Medical, Annual, or custom leave type created by the administrator.

  5. Approval status

    Approval status as Requested, Approved or Rejected.

  6. Operation

    1. Edit leave

      Refer Apply/edit leave section for more details.

    2. Delete leave

      Delete the leaves

  7. Table options

Holiday table view

Holiday table show holidays available for the selected date in the Calendar view .

_images/image499.PNG

Figure 280 Holiday table view of user service portal

  1. Date

  2. Description

  3. Table options

Selected date view

The details of the date are shown as selected leave from the Leave table view or holiday from the Holiday table view .

_images/image260.PNG

Figure 281 Selected date view

  1. Date

    The date of the selected date from the Calendar view or date of the selected leave from the Leave table view or date of the selected holiday form the Holiday table view .

  2. Day

  3. Select today button

    Select the current date form the Calendar view

  4. Holiday name

    This will appears if a holiday selected from the Holiday table view .

Summery view of selected leave

Selected holiday view shows the details of the selected leave from the Leave table view as follows.

_images/image501.PNG

Figure 282 Summery view of selected leave

  1. Leave period

    Start and end date of the leave with number of days

  2. Approval status of the leave

    Approval status as Requested, Approved or Rejected.

  3. View button

    Refer section for more details.

Leave details

Leve details view shows leave details as below.

_images/image503.PNG

Figure 283 Leave details view

  1. Status

    tatus as Approved or Rejected

  2. Requested days

    The period leaves requested.

  3. Approved days

    The period leaves approved.

  4. Leave type

    Leave type as Casual, Medical or Annual

  5. Policy

    Leave policy as

    1. Normal

    2. Restricted

      User is now allowed to check-in or check-out while on leave

  6. Requested reason

  7. Approve/reject comment

    Reason for the approval or rejection from the administrator

  8. Calendar view shows approved leave period

  9. Close button

    Close Leave details dialogue view

Calendar view

Calendar view shows leave and holidays for the user as below.

_images/image505.PNG

Figure 284 Calendar view

  1. Selected month

  2. Navigate button to previous month

  3. Navigate button to next month

  4. User leave

  5. Holiday

  6. Current date

  7. Selected date

User reports

_images/image506.PNG
  1. Report type

  2. Export user reports

  3. Report settings of user service portal

  4. Filter by shift

  5. Report table

  6. Refresh button

    Refresh report after applying report settings.

Report types of user service portal

  1. Total work hour report of user service portal

  2. Productivity report of user service portal

  3. Event detail report of user service portal

Total work hour report of user service portal

The Total work hours report provides work hours details for a selected date range. That details can be calculated by daily, weekly, monthly basis. The important parameters are

  1. Date

  2. Name

  3. Employee code

  4. Productive work hours (HPS)

  5. Overtime hours

  6. First check-in

  7. Last check-out

  8. In-out hours

  9. Shift work hours (HS)

  10. Work hours

Productivity report of user service portal

Productivity report is generated for a selected time period with user/employee productivity parameters as follows.

  1. First check-in

  2. Last check-out

  3. Work hours

  4. Break hours

  5. Late arrival

  6. Late departure

  7. Early arrival

  8. Early departure

  9. Overtime hours

  10. Productive hours (HP)

  11. Unproductive hours

  12. Efficiency

Event detail report of user service portal

Event details represent all users/employees event details information as follows.

  1. Name

  2. ID

  3. Shift name

  4. Shift start

    Start time of the shift.

  5. Direction and status

    Event type as check-in or check-out.

  6. Time

  7. Event time

  8. Time zone

    Time zone difference in hours with respective to UTC.

  9. Location

    Longitude and Latitude coordinates of the event location.

Report settings of user service portal

_images/image507.PNG
  1. Report calculation strategy

    Change the calculation based on Daily, Weekly or Monthly basis.

  2. Time filter

    Show time ranges in Hours format or Hours and minutes format.

  3. Date range

    This filter is not available for user detail report. The date range is changing according to the Report calculate strategy filter.

    1. Report calculate strategy as daily

      The report can be generating in months. The custom range can be enabled in days selecting Custom date range setting.

    2. Report calculate strategy as weekly

      The report can be generated in weeks. The custom range can be in weeks enabled selecting Custom date range setting.

    3. Report calculate strategy as monthly

      The report can be generated in years. The custom range can be enabled in months selecting Custom date range setting.

Export user reports

Export data in PDF and CSV formats. Available options are,

  1. Export all data as PDF

    Export complete report as a PDF.

  2. Export all data as CSV

    Export complete report as a CSV.

  3. Export visible data as PDF

    Export currently visible data in the report as a PDF.

  4. Export visible data as CSV

    Export currently visible data in the report

User settings

Select display language for web

Available languages are English and Chinese.

Common functions

Client registering view

Before record attendances in NCheck Bio Attendance Clients for Windows, Android and IOS applications, applications should be registered with a user or user group in the NCheck Bio Attendance server using a registration code. The registration window as follow.

_images/image509.PNG
  1. Device registration code

  2. Copy to clipboard

    Copy device registration code to clipboard

  3. Device registration code as a QR code

    Scan QR code from the client device.

  4. Remove button

    Remove current registration code to regenerate new code.

  5. Email button

    Email registration code to user/user group. Table 54 is showing the possible error messages when email registration token.

  6. Link to download NCheck Bio Attendance clients for Android, IOS and Windows

Table 54 Error messages of registration view

Error code

Error message

2035

Failed to email registration token.

Location restrictions

Location restrictions can be applied for selected user/user group in order to bound check-in/checkout events to area. Location restrictions view as follows,

_images/image511.PNG
  1. Number of location restrictions applied for user/user group

  2. Location restrictions table

  3. Add new button

    Add location restriction. Refer section for more details.

Location restriction table

This view shows all location restrictions and operations as follows

_images/image513.PNG
  1. Restriction name

  2. Address where the restriction applied

  3. Options

    1. Edit location restriction

    2. Delete location restriction

Edit location restriction

Edit existing location restriction as follows.

_images/image515.PNG
  1. Restriction name

  2. Description

  3. Address where the restriction applies

  4. Latitude

    only 5 decimal places are allowed.

  5. Longitude

    only 5 decimal places are allowed.

  6. radius

  7. Allow bypass

    Check this option to allow user to bypass the location restriction as mentioned in section

  8. Update button

    Update button will be disabled if the mandatory fields are empty or Validation errors exit. Table 55 showing error messages could be appeared when updating location restrictions.

  9. Cancel button

Table 55 Error messages of add new location restrictions

Error code

Error message

3011

Only 5 decimal places are allowed in latitude and longitude values.

Add location restriction

New location restriction can be added as follow

_images/image517.PNG
  1. 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.

  2. 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.

  3. Add new location restriction

    Refer Add location restriction section for more details.

Add new location restriction

This view allows to add new location restriction as follows.

_images/image518.PNG

Figure 285 Add new location restriction view

  1. Restriction name

  2. Description

  3. Address where the restriction applies

  4. Latitude

  5. Longitude

  6. radius

  7. Allow bypass

    Check this option to allow user to bypass the location restriction as mentioned in section

  8. Update button

    Update button will be disabled if the mandatory fields are empty or Validation errors exit. Table 56 shows error messages could be appeared when updating location restrictions

  9. Cancel button

Table 56 Error messages of add new location restriction

Error code

Error message

3011

Only 5 decimal places are allowed in latitude and longitude values.

Import and Export information

NCheck Bio Attendance user information can be export as a zip file with selected information. The zip file hierarchy as showing in Figure 286 . User biometric data is not allowed to export NCheck Bio Attendance allows to import all user information as zip file in the hierarchy as shown in Figure 286 . In addition to that it can import user information in CSV files.

Note

All exporting information is encrypting using AES 256 encryption method with given password to enhance the security of the exported information. Windows default zip extractor is not supporting to extract exported zip file. You must use third party tool which supported AES 256 encryption method to extract exported zip file.

_images/image519.PNG

Figure 286 Import/Export zip file folder hierarchy

Note

Thumbnail and biometric cannot be exported.

  1. Modality

    1. Face

    2. Finger

    3. Iris

  2. Data-id

    Unique ID to add multiple biometric data in single modality

    1. emp0234_face_1.jpg, emp0213_face_2.jpg, emp0435_face_3.jpg

    2. emp0234_finger_1.jpg, emp0213_finger_2.jpg, emp0435_finger_3.jpg

  3. Information as CSV

Table 57 Import/export csv files

Information

CSV file name

User profile information

PersonData.csv

User/user group location restrictions information

  1. PersonLocationRestrictionData.csv

  2. GroupLocationRestrictionData.csv

User group information

GroupData.csv

User group memberships information

MembershipData.csv

Shifts information

TaskData.csv

Rosters information

RosterData.csv

Roster items information

RosterItemData.csv

Holidays information

HolidayData.csv

Leaves information

LeaveData.csv

Event logs information

EventLogData.csv

Following restrictions/limitations have been applied to import export data

  1. Folders and images should follow the exact naming convention.

  2. There can be only one image for customer profile in path ‘Thumbnail/Customer/’.

  3. For each person, there can be only one profile image in path ‘Thumbnail/Person/’.

  4. For each user group, there can be only one profile image in path ‘Thumbnail/UserGroup/’.

  5. Customer profile image should contain the customer name and each person or group profile image should contain the relevant employee code or group code.

  6. Biometric images should be included in the path ‘Biometric/Image’ and templates should be included in the path ‘Biometric/Template’.

  7. Biometric image/template file name should be in ‘<employeecode>_<modality>_<dataid>’ format.

  8. Images can be in jpg or png format. Providing the extension is not mandatory.

  9. 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.

  10. The file naming conventions is mandatory when importing files.

User thumbnails

User thumbnails can be imported as jpg, png format in a zip file according to the file structure as showen in Import and Export information section. Unlike other information administrator are feels free to import all user thumbnails with any other file import.

Note

User thumbnails cannot be exported.

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.

User profile information

_images/image520.PNG
  1. First name

    This is mandatory information.

  2. Last name

    This is mandatory information.

  3. Employee code

    This is mandatory information.

  4. Email

  5. primary telephone

  6. Address1

    Address line 1

  7. Address2

    Address line 2

  8. City

  9. Country

  10. State province region

  11. Zip or postal code

  12. Created at

    MM/dd/yyyy h:mm: ss a format is required.

User group information

  1. Group code

    This is a mandatory field. Group code should be unique.

    _images/image521.PNG
  2. Description

  3. Created at

    MM/dd/yyyy h:mm:ss a format is required.

User/user group location restrictions information

_images/image522.PNG
  1. Name

    This is mandatory information

  2. Description

  3. Address

  4. Created at

    This is mandatory information. MM/dd/yyyy h:mm: ss a format should be applied.

  5. Allow bypass

  6. Employee code

    This is mandatory information when importing users. Otherwise, this field should be empty.

  7. Group code

    This is mandatory information when importing user groups. Otherwise, this field should be empty.

  8. Radius

  9. Latitude

    This is mandatory information.

  10. Longitude

    This is mandatory information.

User group memberships information

  1. Start date

    MM/dd/yyyy h:mm: ss a format is required.

    _images/image524.PNG
  2. End date

    MM/dd/yyyy h:mm: ss a format is required.

  3. Created at

    MM/dd/yyyy h:mm: ss a format is required.

  4. Group code

  5. Employee Code

Shifts information

_images/image525.PNG
  1. Name

    Shift name.

  2. description

  3. Start time second

    Shift start time

  4. Checkin start

    The timestamp for the check-in start time to prevent early check-ins.

  5. Checkin end

    The timestamp for the check-in end time to prevent late check-ins.

  6. End time second

    The timestamp for shift end time

  7. Checkout starts

    Tht timestamp for the checkout start time to prevent early checkouts.

  8. Checkout snd

    Tht timestamp for the checkout end time to prevent late checkouts.

  9. Work hours

    The number of work hours user should cover in the shift.

  10. OT star

    The timestamp for overtime start.

  11. OT end

    The timestamp for overtime end.

  12. Restrict checkin

    If this is true, checkin start and checkin end restrictions will be applied.

  13. Restrict checkouts

    If this is true, checkout start and checkout end restrictions will be applied.

  14. Restrict OT

    If this is true, OT start and OT end restrictions will be applied.

  15. Max OT

    Maximum overtime overs permitted.

Rosters information

_images/image527.PNG
  1. Roster name

  2. Start date

    Start date of the roster.

  3. End date

    End date of the roster.

  4. Deleted date

    This should be empty.

  5. Created date

    Specify the date for the roster create.

  6. Roster type

  7. Repetition

Roster items information

_images/image528.PNG
  1. Created at

    Created date for the roster item

  2. Deleted date

  3. Day number

  4. Employee code

  5. Group code

  6. Roster name

  7. Name

    Name of the shift

Holidays information

_images/image529.PNG
  1. Description

    Description of the holiday

  2. Date

    Date of the holiday

  3. Created at

    Created date in the server

Leaves information

_images/image530.PNG
  1. Start Date

    Leave start day

  2. End date

    Leave end day

  3. Created at

    Leave created date in the NCheck Bio Attendance server

  4. leave type

  5. Employee code

Event logs information

_images/image531.PNG
  1. Checkin latitude

    Latitude of the check-in location

  2. Checkin longitude

    Latitude of the check-in location

  3. Checkin address

    Address of the check-in location

  4. Checkin description

    Description of the checkin

  5. Checkout latitude

    Latitude of the checkout location

  6. Checkout longitude

    Latitude of the checkout location

  7. Checkout address

    Address of the checkout location

  8. Checkout description

    Description of the checkout

  9. Employee code

  10. Task name

    Shift name

  11. Checkin time

    Date and time of the check-in time

  12. Checkout time

    Date and time of the checkout time

  13. Shift start

    Date and time of the Shift start

  14. OT start

  15. Shift span second

  16. OT span second

  17. OT enabled

  18. Limit OT

  19. Checkin time zone

    Checkin time zone in seconds.

  20. Checkout time zone

    Checkout time zone in seconds.

  21. Work hours

    Work hours in seconds

  22. maxOT

Select import location

This view allows to browse files In the local file system for operations in NCheck Bio Attendance system.

_images/image533.PNG
  1. Select the import location file

  2. Password protection

    Select this check box to enter the password if the file is encrypted.

  3. File password

    Enter the encrypted password

  4. Execute button

    Execute button will be disabled if the mandatory fields are empty or Validation errors exist. Table 58 is showing error message could appeared when import files.

  5. Close button

Table 58 Error messages of data import

Error code

Error message

1003

Unable to connect with the FTP server {server name}

2046

Invalid FTP file path

2047

Invalid FTP username or password

3013

Data import failed. Invalid password.

4003

Unidentified error occurred during data import. Please contact administrator or NCheck Bio Attendance support for more details.

Import from local file system

Choose the zip/csv file from the local file system

Import from FTP

This view allows to configure FTP location to import files for operations in NCheck Bio Attendance system.

_images/image535.PNG

Figure 287 FTP server location settings view

  1. FTP host address

  2. File path in the file system

  3. Check this if the FTP access credentials is required

  4. FTP Username

  5. FTP password

Select export location

Note

Encrypted files cannot be open via Microsoft Windows default extractor. You may use any third-party software which support encrypted files extraction.

_images/image537.PNG
  1. Export option

  2. File password

    The password must have at least 6 character and one digit/

  3. Confirm password

  4. Execute button

    Execute button will be disabled if the mandatory fields are empty or Validation errors exist. Table 59 is showing the error message could appeared on import files.

  5. Close button

Table 59 Error messages of export files

Error code

Error message

1003

Unable to connect with the FTP server {server name}

3003

Password does not match.

3004

Password must contain at least 6 characters with one number.

2046

Invalid FTP file path

2047

Invalid FTP username or password

4004

Unidentified error occurred during data export. Please contact administrator or NCheck Bio Attendance support for more details.

Download exported files

Download file to the local file system.

Save to FTP location

This view allows to set FTP location details for file save operations in NCheck Bio Attendance server

_images/image539.PNG

Figure 288 FTP server location configuration for save exported files

  1. FTP host address

  2. File path in the file system

  3. Check this if the FTP access credentials is required

  4. FTP Username

  5. FTP password

Report parameters

All report parameter can be explained using following figure.

_images/image540.PNG

First check-in

First check-in time within the shift

Last check-out

Last check in time within the shift

Work hours

Total summation of time differences between consecutive check-ins and check-outs.

In-out hours

Time difference between First check-in and Last check-out .

Productive hours (HP)

According to the figure, productive hours can be identified as

_images/image543.PNG

According to the Figure this can be defined

_images/image544.PNG

Shift work hours (HS)

Minimum from Work hours and Shift hours.

_images/image545.PNG

Productive work hours (HPS)

Minimum from Productive hours (HP) and Shift work hours (HS)

Unproductive hours

_images/image547.PNG

Overtime hours

Overtime hours can be defined as

_images/image548.PNG

Break hours

Total differences between check-in’s and check-outs of consecutive events in hours.

_images/image549.PNG

Late arrival

Time difference between shift start and the first check-in when first check-in occurs after the shift start time.

Late departure

Time difference between shift end and the last check-out when last check-out occurs after the shift end time.

Early arrival

Time difference between shift start and the first check-in when first check-in occurs before the shift start time.

Early departure

Time difference between shift end and the last check-out when last check-out occurs before the shift end time.

Efficiency

The ratio between Productive hours (HP) and work time defined for the particular shift.

Event logs count

Number of events for the particular user/employee for the selected date range.

Roster item count

Number of roster items assigned for the particular user/employee for the selected date range.

Number of Leaves

Number of leaves approved for particular user for the selected date range.

Number of holidays

Number of holidays of the organization in the selected date range.

Replacements

Depending on the organization requirement such as handle the work load, manage absentees, additional employee(s) can be added to a specific roster item as mentioned in Add additional staff section. This parameter shows number of additional user(s)/employee(s) replaced for the user/employee in such cases.

Table options

The following options are available in tables using over the NCheck Bio Attendance control panel.

_images/image551.PNG

Figure 289 Control panel table view

  1. Table header

  2. Table paging options

Table header

_images/image553.PNG

Figure 290 Figure . Table header column view

  1. Table column

  2. Column sorting order as mentioned in Table 60

  3. Table menu

  4. Column search

    This field is used to filter the column content.

Table 60 Table column sorting options

Icon

Soring order

None

No sorting will be applied for the particular column

_images/image555.PNG

Columns will be sorted in ascending order

_images/image557.PNG

Columns will be sorted in descending order

Table menu

Over the NCheck Bio Attendance control panel, list of data is representing using data tables. Following features are available in the data table.

_images/image559.PNG

Figure 291 . Table menu view

  1. Save state

    Save the applied filters and columns in the browser cache.

  2. Clear all filters

    Clear applied filters from the browser cache.

  3. Columns

    All table columns.

  4. Visible columns

  5. Hidden columns

Table paging options

Table paging options allowed to prevent retrieving and loading large number of data to the table at once. These options are important to handle large data within the system without affecting the performance of the system.

_images/image563.PNG

Figure 292 Figure . Table paging view

  1. Go to the first page

  2. Go to the previous page

  3. Current page number

  4. Number of pages

  5. Go to the next page

  6. Go to the last page

  7. Number of items for a page

    The available options are 20, 50 100.

  8. Index of the first row in the page

  9. Index of the last item in the page

  10. Number of items in the page

Control panel settings

Administrator allows to configure below mentioned settings in the NCheck Bio Attendance Cloud/On-premises server.

  1. General setting list

  2. Client settings list

  3. Biometric setting list

  4. Web interface setting list

General setting list

Default shift start time

The start time of the for the default shift. Default is 00.00.00.

Default shift end time

The end time of the default shift. Default is 23.59.59.

Day start time

Time to start working/office hours. Default is 00.00.00.

Week start date

Week start day of the organization. Default is Monday.

Month start date

Month start day of the organization. Default is 1st day of the month.

Date format

Date format for the control panel and reports. Default is yyyy-MM-dd.

Time format

The time format for the Control panel and reports. Default is HH:mm:ss.

Default shift selection behavior

This option control default shift selection. The default is Allow when other shifts available. Available options are

  1. Don’t allow

    Not allowed to select default shift.

  2. Allow when no shifts available

    Allow using default shift when custom shifts are not available.

  3. Allow when other shifts available

    Allow using default shift when custom shifts available.

Auto checkout at the end of the shift

Enable this option to auto checkout user at the end of the shift automatically. This setting has disabled by default.

Notify check-in attempts on restricted leave

When this setting is applied, administrator gets email or control panel notification if a user who are on restricted (leave policy) leave tries to check-in.

Unidentified event log count to keep

Number of maximum unidentified event logs to keep in the system. Older event logs will be deleted if the maximum event log count is exceeded. Set -1 to disable this setting.

External resource URL

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://<server ip>:<port>/resources/ncheck.image?resource_name”.

Client settings list

Result dialogue timeout

Timeout for check-in/checkout result dialogue. The default value is 5 seconds.

Enable licensing

NCheck Bio Attendance client application is allowed to use premium features. This setting has been disabled by default.

Show work time on clients

The display worked time in result dialogue after check-in or check-out events. This setting has been enabled by default.

Offline operation mode

Enable to record attendance in NCheck Bio Attendance Standard clients when the internet service is not available. This setting has been disabled by default.

Manuel event selection

Enabling this setting, user able to select the event check-in or check-out before recorded.

Automatically synchronize offline data

Synchronize the offline data automatically with the NCheck Bio Attendance server when Enable offline mode setting is enabled. This setting has been enabled by default.

Offline data synchronize interval

Data synchronize interval when the Offline data synchronize interval setting is enabled. The default synchronize interval is minutes.

Allow automatic peripheral enabling of new clients

If this setting is enabled, the peripherals in the registered devices will be enabled automatically. This setting has been enabled by default.

Reset offline client password

Reset password for the control panel login in NCheck Bio Attendance Standard clients when the offline mode is enabled. Client password is empty by default.

Duplicate event timeout

The time interval between consecutive attendances record to prevent duplicate record in seconds. Default is 3 seconds.

Event log image size

Size of the biometric image when recording attendance. The biometric image is sending to the NCheck Bio Attendance server for user identification. Time took to record attendance can be depended on the size of the image. According to the selected size, image will be compressed without changing the aspect ratio. Default image size is Medium. The available image sizes are

  1. Small

    The images will be compressed to 224*224.

  2. Medium

    The images will be compressed to 512*512.

  3. Original

    The original image will be uploaded.

Note

The recommended event log image size is Medium.

KIOSK mode operation (For Microsoft Windows clients)

Enable this to open NCheck Bio Attendance clients for Windows in the full-screen mode. This setting has been disabled by default.

KIOSK mode exit code

Exit code from the KIOSK mode for NCheck Bio Attendance Lite for Android can be given here. Exit code is empty by default.

Allow predefined location

This setting allows to add location for NCheck Bio Attendance client devices in order to record attendance with particular location if the device location services is not available.

Self-enroll templates

If this setting is enabled, NCheck Bio Attendance Lite for Android registered for a user allows to enroll face template during attendance recording if no template has enrolled for a user. Refer  Face capturing in lite client  section for more details.

Hat detection feature

This setting allows to record attendance events if the user wears a hat. If the hat detection feature is enabled, attendance events will be recorded when the hat detection score from the client is greater than the Hat detection threshold . Hat detection feature available for NCheck Bio Attendance Standard clients only.

Hat detection threshold

This setting is available in NCheck Bio Attendance Standard clients when the Hat detection feature setting has enabled. Administrator can set the hat detection threshold. Attendance event will be recorded if the hat detection score from the NCheck Bio Attendance Standard clients lager than hat detection threshold.

Use in-built biometric verification on personal clients

If this setting is enabled, attendance events can be recorded in Android and IOS Lite clients using the authentication utilities available with Android and IOS devices such as fingerprint scanner for Android devices and Face ID and Touch ID features with IOS devices.

Guard application support

To enable guard application support, this this setting must be enabled first. Otherwise, Guard application registration and other functionalities will be restricted.

Hide user list on windows client

Enable this setting to hide the Windows user result views from the Windows Standard and Lite clients.

Mask detection

This setting can be used to detect user face with a mask. Before enable face mask detection, make sure that you have selected the “Detect face mask” setting under the “Face quality” setting in biometric setting. Once the mask detection is set, NCheck Bio Attendance clients will calculate the mask detection score to perform the operations based on “Mask detection threshold” according to the selected mask detection option as below. The following settings are available for mask detection

  1. Do not detect

    Select this option to identify face without face mask.

  2. Detect

    Select this option to identify face with face mask. The detection will be indicated in the clients as follows

    Table 61 Indicators for Detect mask detection option

    Indicator of Windows Standard client

    Indicator of Android Standard client

    Mask detection score >= Mask detection threshold

    _images/image565.PNG
    _images/image567.PNG

    Mask detection score < Mask detection threshold

    _images/image569.PNG
    _images/image571.PNG
  3. 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

    Table 62 Indicators for Required mask detection option

    Indicator of Windows Standard client

    Indicator of Android Standard client

    Mask detection score >= Mask detection threshold

    _images/image565.PNG
    _images/image567.PNG

    Mask detection score < Mask detection threshold

    _images/image573.PNG
    _images/image575.PNG
Mask detection threshold

Decrease the value, if a user face with a face mask is not identified as mentioned in “Mask detection” settings. Make sure that you have selected the “Detect face mask” setting under the “Face quality” setting in biometric setting

Biometric setting list

Allow without biometrics

This feature allows to record user attendance from NCheck Bio Attendance Lite clients simply selecting a button as mentioned in Main view for non-biometrics capture section. This setting has been disabled by default.

Manual face selection

This allows to select users for check-in/checkout when the multi-face capturing mode (Refer Lite client section for more details about multi face mode) is enabled in the NCheck Bio Attendance Lite client devices. This setting has been enabled by default.

Face liveness mode

Liveness can be used to differentiate live faces from nonlive faces to prevents buddy punching. Face liveness mode is None by default. Available options are

  1. Passive

    In this mode, the user should hold his head still for a few seconds.

    _images/image577.PNG

    Figure 293 Android Standard client in passive liveness mode

  2. Active

    In this mode, the user should follow the commands on the screen by moving his head or blinking eyes.

    _images/image581.PNG

    Figure 294 Windows Standard client in active liveness mode

    _images/image585.PNG

    Figure 295 Android Standard client in active liveness mode

  3. Passive and active

    Both passive and active mode above is combined for better face recognition result.

  4. Simple

    In this mode, the user should follow the commands on the screen and turn face time to time. It is simplified version of Active liveness recognition.

    _images/image589.PNG

    Figure 296 Windows Standard client in simple liveness mode

    _images/image591.PNG

    Figure 297 Android Standard client in simple liveness mode

  5. Custom

    In this mode, it is required to turn head to four directions (up, down, left, right) in a random order (follow up points are same as Active mode).

    _images/image595.PNG

    Figure 298 Windows Standard client in custom liveness mode

    _images/image597.PNG

    Figure 299 Android Standard client in custom liveness mode

  6. None

    In this mode, the face liveness check is not performed.

Refer Face capturing in Standard client section for more details about record attendances using liveness settings in NCheck Bio Attendance Standard clients.

Face liveness threshold

The value which controls the requirements for 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.

Recognition threshold

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.

Verification threshold

Increase the value if higher verification accuracy is required. Note that good image quality is required for a higher accuracy during face verification. Default verification threshold value is 36.

Enrollment threshold

Start with a higher enrollment accuracy if the system is intended to be used with a larger crowd. Default enrollment threshold value is 48.

Face confidence

Use higher face confidence if good image quality is available. Default face confidence value is 40.

Face quality

Increase the value if the same user identified differently from time to time. By increasing the value, the system is forced to ignore low quality face images. Default face quality value is 40. Detect faces with mask sub setting has been introduced with face quality setting to enables face capturing waring face masks. Refer Detect faces with mask setting for more details.

Detect faces with mask

Neurotechnology Biometric algorithms can recognize faces even the person wearing a mask. In an environment where most people wear face masks (e. g.: Hospitals) this setting will easily identify employees To enable this feature, check the checkbox “Detect faces with mask” under Face Quality setting.

Note

By enabling this setting, face quality threshold is set to 0 and you cannot change it without disabling mask mode

Fingerprint quality

Increase the value if the same user identified differently from time to time. By increasing the value, the system is forced to ignore low quality finger scans. Default fingerprint quality value is 40.

Iris quality

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.

High-speed face detection

High speed face detection when the face biometric is used. This setting has been disabled by default.

Web interface setting list

Dashboard refresh interval

Dashboard refresh interval can be set in minutes to refresh the Dashboard to display recent attendance overview. The default refreshing interval is 2 minutes.

Show meridian in time

Enable the toggle button to show AM/PM with the time. This setting has been disabled by default.

Report export PDF font

User must select appropriate font from this setting to export report successfully according the selected control panel language. The available fonts are

  1. Roboto (Latin)

    Default font to export pdf report. Select this language to export report in any western European language.

  2. Simsun (Chinese, Latin)

    Select this font to export report in Chinese language.

  3. Ek Mukta (Hindi, Latin

    Select this font to export report in Hindi language.

Event log location map provider

Select map provider to check the map representation of users event logs as mentioned in Map view section. Available map providers are

  1. Google maps

  2. Baidu maps

Map API key

Add map API key to enable map representation of users event logs according the selected map provider in Event log location map provider setting.