NCheck Bio Attendance control panel

NCheck Control panel is used to manage NCheck Bio Attendance attendance control system. NCheck Control Panel can be accessed.

  • Web browser

  • NCheck Bio Attendance Control panel available in NCheck Bio Attendance standard or lite client

Note

This is a windows application with embedded browser control

Log in to NCheck Control Panel

NCheck Control panel can be accessed using the server URL. Server URL should be follow below format.

https://<server>:port

  • Server – Server name or IP address

  • Port – Server running TCP port

Once connected, the server prompts for authentication.

login

Note

Server by default uses a self-signed key certificate. When a self-signed certificate is used, the browser will present you a warning. You need to bypass this warning and enter the web site.

Security warning

Following users can log in to the Control Panel using their user name and password. Control panel functions are differentiated according to the role of the user. the user name is usually e-mail.

  • Administrator

    Administrator has the full access for the NCheck Bio Attendance control panel.

  • Group Administrator

    Group adminstrator allows accessing user management, user group management, event logs and reports for users in the assigned user groups.

  • The administration auditor

    Administration auditor has access to monitor the control panel.

  • Group administrator auditor

    Group administrator allows accessing monitor user management, user group management, event logs and reports for users in the assigned user groups.

  • User

    Users are allowed to monitor the user details, rosters and schedules, event logs and reports such as work hours, Productivity and event details. Refer Users Control Panel section for more details.

Administrator’s Control Panel

The administrator control panel has full control over the NCheck Bio Attendance server account, So it’s recommended to give the access for only authorized person(s) to manage the account. NCheck Bio Attendance Control panel provides the following features:

server control panel
  1. Organization logo

  2. Organization name

  3. Help

    NCheck Bio Attendance documentaion will be open

  4. Notifications

  5. Manage Administrator account

  6. Control panel menu

Manage Administrator account

Select the user menu icon in the navigation bar. Following options are available in the user menu.

Download |product| for Android application

Administrator account

Select My account in the user menu. Following options available Administrator account window. backup NCheck Bio Attendance server database securely and restore back in the NCheck Bio Attendance server.

Update company information

Administrator allows updating company information and logo before record attendance.

Administrator account-informaion

Login options

Login options window allows doing the following operations.

Switch between roles

A single user can be assigned multiple roles(as an example administrator and a user). The current user profile is highlighted in red color. To change the role,

  • Select the role need to be switched

  • Select the Switch button.

Change password

All roles are allowed to reset the password in the Change password section. Password should consist of one digit and six characters.

Change profile picture

Select any photo to update as the profile picture for the selected role.

Sign out from the control panel

Select the sign out option to sign out from the control panel.

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,

  • Users in/out summary

  • Device status summary

Dashboard statistics

The summary also includes the last active user details. The most recent event of the users will be displayed in the Recent Users table.

Recent user events

Manage Users

User management

The following options are available in this view.

  1. Add users

  2. Advanced options

    • Restore deleted users

  3. Users table

  4. User quick view

  5. Show events for the selected user

  6. Add biometrics

    Refer User biometrics for more details.

  7. Edit user

  8. Change password

  9. Block/Unblock user

  10. Register NCheck Bio Attendance clients

    Refer Register NCheck Bio Attendance Clients section to register NCheck Bio Attendance clients.

  11. Remove User

  12. Manage location restrictions for user

  13. Search users

  14. Import and export

    Following options are available in import and export

    • Import users

    • Export users

    • Import location restrictions

    • Export location restrictions

      User import

    For more details refer Import and Export information section.

Add users

New users can be added using the below methods.

Add a new user

  • Select Add button.

    Add new user
    • First name, last name and employee code are mandatory.

    • Upload user profile image from a file.

      • Select the Browse button and upload the picture.

    • Upload user profile image from the unidentified image

      • Select the Unidentified image button

        unidentified images
    • The user name can be added to enable users to access NCheck Bio Attendance control panel. Once the user name added, the passwrod can be added as mentioned in Change user password section.

Note

Name, Last name and employee code fields are mandatory. If your organization is not using a code to identify users uniquely, you can just add some random numbers/text using the Generate button.

Import users details

Refer Import files section for more details.

Edit user

  • Select the user in the users table.

  • Select the edit button.

Change user password

After assigning as password as mentioned in Add a new user section, the password should be added.

unidentified images

Note

Password must consist of one digit and 6 characters.

Block/Unblock user

  • Select the user in the users table

  • Select the Block/Unblock option to block or reverse the blocking of the user.

  • Select the OK button to confirm blocking.

User biometrics

Users face, fingerprint and iris biometrics are used to identify and verify the user to record attendances.

Important

Before record user attendances, bimetric(s) should be enrolled in the NCheck Bio Attendance Server unless the allow without biometric setting is not available as mentioned in the Biometric settings of the Group settings to record attendances without biometrics.

Enroll biometric for the selected user

Biometrics can be enrolled as below.

  • Add Biometrics

  • NCheck Bio Attendance client applications

Add Biometrics

Select Biometrics button.

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

Add/update biometric for selected user
  • From a file:

    • Select biometric upload type from

      • upload face image

      • upload fingerprint

      • upload iris image

    • Select selection to upload the biometric image from your file system.

  • Select Enroll from history button:

    In the Select from history window,

    Date range: Bimoetrcis will be retrieved within the selected date range.
    Closely matching biometrics: NCheck Bio Attendance server will filter out the closely matching biometrics for the user from history.
    Filter by device: Filter out the biometrics matching for the device.
    Filter by user group: Biometrics used to enroll for the selected user group.
    Add/update biometric from history :align: center
NCheck Bio Attendance 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.

  • NCheck Bio Attendance Lite for Windows, Android and IOS

    To enroll face biometrics.

  • NCheck Bio Attendance Standard for Windows and Android

    To enroll face, fingerprint and iris biometrics.

To enroll biometrics using the NCheck Bio Attendance client applications,

  • login to the NCheck Bio Attendance server control panel from the NCheck Bio Attendance client application.

  • In the server control panel, go to the user management section.

  • Click Biometric button.

    • Choose biometric type from capture face, capture fingerprint or capture iris (Only capture face is available for the NCheck Bio Attendance Lite clients).

    • NCheck Bio Attendance client application will open a view to capture the selected biometric.

    • Once the biometric captures, it will upload as biometric templates.

Biometric dialog for clients

Important

Administrator privilege is required to enroll biometric via the NCheck Bio Attendance client applications. NCheck Bio Attendance Lite clients allows to upload face biometrics only.

Manage location restrictions for user

Refer Location restrictions section for more details.

Remove User

  • Select the user from the users table.

  • select the Remove button.

Note

If the user has relevant attendance records, the user can’t be deleted from the system. In such cases, Block option can be used as mentioned in Block/Unblock user section.

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, User group view as follows,

User group
  1. Add new user group

  2. Import and export

    Import and export allows to

    • Import user groups

    • Export user groups

    • Import user group memberships

    • Export user group memberships

    • Import location restrictions

    • Export location restrictions

    Import user group informations

    Refer Import and Export information for more details.

  3. Search

    Filter user groups in the user groups table by group code and description.

  4. User groups table

  5. Manage users in a user group

  6. User group quick view

  7. Assign group administrators

  8. Register clients

  9. Edit user group

  10. Remove user group

  11. Manage Location restrictions for user group

  12. Group settings

Add user groups

Add new user group

  • Click Add button.

    Add user group

Note

Group code should be unique.

Import user group details

Refer Import files section for more details.

Edit user group

  • Select user group from the user groups table

  • Select the Edit button.

Manage users in a user group

Add/remove users

  • Select the user group.

    select users for the user group
  • Select the Edit button in the Attached users section

    Select user(s) for the user group
  1. Select/deselect the users.

Import user group memenrship details

Refer Import files section for more details.

Assign group administrators

Group administrator(s) can be assigned from the available users in the user group. Group admins are privileged to

  • Manage users

  • Manage location restrictions

  • Register devices to the user group

To select the user group administrator,

  • Select the Group admins button

  • Select group admins from the window.

    • Permission

      • Read-only permission

        Group admins allow viewing all information in a particular user group.

      • Read and Write permission

        Group admins allow to view and change the particular user group.

    Add group admins

Register clients

Refer Register NCheck Bio Attendance Clients section to register NCheck Bio Attendance clients.

Manage Location restrictions for user group

Refer Location restrictions section for more details.

Group settings

The administrator or group administrators able to select settings for selected user group. To add setting for the user group,

  • Add a group setting

    • Select a user group

    • Select the Group Settings tab in the Group specific settings

    • Select the group setting

    • Select the Change button

  • remove a group setting

    Select the delete button of the particular setting.

User group registration
  • Available group settings

    • License enabled

      NCheck Bio Attendance client application is allowed to use premium features.

    • Allow without biometrics

      This allows to checkin/checkout without bimetrics.

    • Face liveness mode

      Liveness is used to differentiate live faces from none live faces. This prevents perform employee events using face images instead of living faces. Available options are

      • Passive

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

      • Active

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

      • Passive and active

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

      • Simple

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

      • 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)

      • None

        In this mode, face liveness check is not performed.

    • Face liveness threshold

      The value which controls the requirements for face liveness. The greater this value is the more strict rules are applied when deciding if the face is live. The default value is 50.

    • Manuel face selection

      This allows to select users for check-in/checkout when the multi-face capturing mode is enabled in the client device.

    • Result dialog timeout

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

    • Enable offline mode

      This enables the client application to operate in offline without accessing the internt.

    • Show work hour dialog in client

      Show work hour information after the successful checkout.

    • Reset offline client password

      Reset offline password when the offline mode is enabled.

Note

Group settings don’t available for All users group.

Remove user group

  • Select the user group.

  • select the Delete button.

Manage Shifts and Rosters

Work schedule of the users/user groups in the organization can be managed in this section. Shift and roster management allows to Administrator to

Manage Shift

Work hours can be assigned to a user/user group using the shifts. Following operations are allowed with Shifts

Shifts
  1. Import/export shifts:

    • Import shifts

    • Export shifts

      Import/export shift
  2. Edit shift

  3. Delete shift

Add shifts

Add new shift
  • Select Add button

    Add shifts
    1. Shift name

      Name for the shift.

    2. Description

    3. Shift start

      Shift start time.

    4. Shift end

      Shift end time.

    5. Work hours

      Work hours user should cover within the shift.

    6. Restrict checkins

      Prevent user check-ins in the selected time interval.

    7. Restrict checkouts

      Prevent user checkouts in the selected time interval.

    8. Restrict overtime hours

      Prevent overtime hours in the selected time interval.

    9. Maximum overtime hours

      Maximum overtime hours user allows in the shift.

Import shifts details

Refer Import files section for more details.

Edit shift

  • Select the shift.

  • Select the edit button.

Delete shift

  • Select the shift

  • Select Delete button

Manage rosters

The roster is a specific date range to assign shifts. Roster management allows to

Rosters
  1. Import and Export: This allows to

    • Import rosters

    • Export rosters

    • Import roster items

    • Export roster items

    Import roster Export roster

  2. Edit roster

  3. Delete roster

Add roster

Add new roster

Roster view pane shows all available rosters, To add new roster,

  • Select New roster button in the roster.

    Add new roster
    1. Name

      This will be the roster name. It is not editable once you created the roster.

    2. Repetition

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

    3. Start date

      Roster starting date. 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 will end on the specified date and thereafter you won’t be able to add roster items to it.

Import rosters details

Refer Import files section for more details.

Edit roster

  • Select the roster

  • Select the Edit button

Delete roster

  • Select the roster

  • Select the Delete button

Manage roster items

After configuring rosters and shifts, administrator able to create a work plan, adding roster items for each day. Administrator allows to,

Add roster item

Add new roster item
  • Select Add button

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

    Roster view
    • Date

      The date for the Roster item.

    • Shift

      Shift name for the roster item.

    • User/User group

      Assign a particular user or user group.

Add additional staff

Additional user(s) can be assigned for the roster item. To add additional staff,

  • Select Add button

  • Select Additional staff button from the list (Optional - Select + button in the particular roster item).

    Roster view
    • Date

      The date for the Roster item.

    • Shift

      Shift name for the roster item.

    • Additional staff

      You can add the user(s) for the roster item.

Import roster items details

Refer Import files section for more details.

Delete roster item

In order to delete roster item, all available user, user group and additional staff should be deleted. To delete user, user group or additional staff

  • Select the delete button in each roster item

Manage holidays

Select Holidays button in the roster. Holidays within the organization can be managed using holiday management. The available options are,

  • Add holiday

  • Export holidays

    Refer Export files section for more details.

  • :ref:` Report for holidays`

    Manage holidays Yearly view
    1. Add new

      Add a new holiday

    2. Import and Export

      • Import holidays

      • Export holidays

        Export roster items
    3. Calendar

      Calendar is showing holidays for each year.

    4. Delete

      Delete holiday.

Add holiday

Add a new holiday
  • Select Add new button

  • In Add holiday window,

    • Date

      The date is mandatory. Date of the holiday.

    • Description

      Description for the holiday.

      Add holiday
Import holidays details

Refer Import files section for more details.

Report for holidays

This can be used to generate the report of holidays for a given date range.

  • Select the Report view tab in the holidays window.

    Manage holidays report view
    1. From

      Range start day

    2. To

      Range end date

Manage Leaves

Select Leave management button in the roster. Leaves for users can be managed using the leave management. This allows to,

  • Add leave

  • Export leaves

    Refer Export files section for more details.

  • Report for leaves

    Manage leaves
    1. Add new

      Add a new leave to the selected employee.

    2. Import and Export

      • Import leaves

      • Export leaves

      Import/export leaves
    3. Calendar

      The calendar allows selecting a date to show the leaves.

    4. Delete

      Delete the selected leave.

Add leave

Add new leave
  • select the Add new button.

  • In the Add leave window

    Add leave
    1. Select user

      Name of the user

    2. Start date

      Leave start day

    3. End date

      Leave end day

    4. Leave type

      leave type as casual, medical, vacation or mission

Import leaves details

Refer Import files section for more details

Report for leaves

Users leave can be viewed as a report.

  • Select the Report view tab in the Leaves windows

    Leaves report view
    1. From

      Range start day

    2. To

      Range end date

Manage devices

Device management page allows managing all NCheck Bio Attendance client devices registered with the NCheck Bio Attendance server. Administrator allows to,

Edit device

  • Select the device from the device and API list

  • Select the Edit button in the device quick view pane.

  • In the Edit device window

    Manage devices
    • Device code

      Device code can not be changed.

    • Description

      Description for the device.

Edit API

  • Select API from the device and API list

  • Select the Edit button in the device quick view pane.

  • In the Edit API window

    Manage devices
    • Device code

      Device code can not be changed.

    • Description

      This is a mandatory field. Description for the API

    • password

      This is a mandatory field.

Re-register device

Device registration code can be generated to re-register the device for the user or user group. To re-register device,

  • Select the device

  • Select the Re-register button in the device quick view

  • In the Re-register window

    • Select user/user group name

    • Select the Generate button

      Add/edit peripheral configuration

Block/Unblock device

The device could be blocked,

  • If the Automatic registration setting is disabled in the particular user group

    Refer Group settings section in the manage user group.

  • If the Enable automatic device registration setting is disabled for user/user group

    Refer Device related settings section in the settings.

  • If the selected device is blocked by the administrator

    Using the Block feature in the device management

In order to block/unblock device,

  • Select the device

  • Select the block/unblock button in the device quick view

Block/Unblock API

  • Select the API

  • Select block/unblock button in the quick view

Unregister device

  • Select the device

  • Select the Unregister button in the device quick view

Unregister API

  • Select the API

  • Select the Unregister button in the quick view

Generate API access credentials

NCheck Bio Attendance server has given the API access for user groups to access user, biometric, event data to use in third party applications. To generate credentials,

  • Select the Advanced button

  • select the Generate API access credentials option

  • In the API credential dialog

    • Select user group

      This is a mandatory field. Select the user group to give the API access.

    • Description

      This is a mandatory field.

    • Select the Create button to generate access credentials

      API credintial dialog

Note

Refer NCheck Bio Attendance API guide for more details.

Manage peripherals

NCheck Bio Attendance server is showing all available peripherals with the registered devices. Supporting peripherals are,

  • User id

    Identify user by

    • Entering user code

    • Scanning barcode

    • Scanning RFID

  • Camera

    To capture the face image.

  • Fingerprint

    To capture the fingerprint image.

  • Iris

    To capture the iris image.

Administrator allows to

Manage peripherals
  1. Edit peripheral

  2. Enable/Disable peripheral

  3. Connected/ Disconnected status

    All built-in peripherals(such as keyboard and camera, barcode, RFID in Android devices) always available as Connected peripherals. Otherwise, once the external biometric device(such as camera, fingerprint and iris scanners) connected to NCheck Bio Attendance client, will be shown as peripheral and update as connected or disconnected accroding to the availability with the NCheck Bio Attendance client.

Important

Please refer System requirements guide to select compatible biometric devices with NCheck Bio Attendance clients.

Edit peripheral

  • Select the peripheral form the peripheral table

  • Select the Edit button

    Add/edit peripheral configuration
    • Peripheral code

      This field can not be edited. This is a unique code to identify the peripheral.

    • Peripheral type

      This is not available for biometric peripheral. user id, Barcode or RFID can be selected in order to identify users with the user id.

    • Name

      This is a mandatory field. Name of the selected peripheral

    • Peripheral configuration

      Peripheral configuration to apply settings for the peripheral when record attendances. Refer Manage peripheral configuration section for more details about the peripheral configuration.

Enable/Disable peripheral

  • Select the peripheral form the peripheral table.

  • Select the Enable/Disable button.

Manage peripheral configuration

The default peripheral configuration is applying acros all devices if the custom peripheral configuration is not present. To manage peripheral configuration,

  • Select the Configuration button

    Edit peripheral configuration window allows to

Add new peripheral configuration

  • Select Add button

  • In Add new configuration window,

    1. Name

      Name of the configuration. This is a mandatory field.

    2. Description

    3. Authentication mode

      Refer Authentication mode section.

    4. External executables

      Refer External executables section

    5. Event

      • Check-in: Trigger configuration on check-in events

      • Check-out: Trigger configuration on checkout events

      • Any event: Trigger on check-in and checkout events

      Manage peripheral configuration
Authentication mode
  • Identification

    User can record attendance using any user id peripherals such as

    • User code

    • Barcode

    • RFID

    or biometric peripherals such as

    • Face

    • Fingerprint

    • Iris

  • Verification

    Verification mode can be applied to one user id peripheral with the biometric peripheral in order to record attendance with the high accuracy.

    Manage peripheral configuration
  • None

    Attendances are not recording when the authentication mode is none.

External executables

Peripherals can be configured to communicate with the external devices using third party API.

External executables
  1. Add button

    Add a new external executable.

  2. Executable path

  3. Trigger on

    • Any: Trigger when record check-in or checkout event

    • Check-in: Trigger when record check-in event

    • Check-out: Trigger when record checkout event

    • Unidentified: Trigger when the record is not identified as check-in or checkout

  4. Parameter

    Following parameters can be passed to the device for device side operations.

    • event

    • sequence id

    • timestamp

    • user reference

    • user name

    • shift code

    • location

Management Event log

Evelt logs are allowed the administrator to

Event log
  1. Refresh button

    Refresh all event log data

  2. Re-evaluate button

  3. Add from offline button

  4. Add button

    Add a new event.

  5. Event filters

    Refer Users attendances section.

  6. A quick view of the selected data from Calendar

    Event log
    1. Select today button

      Select the current date from the calendar.

    2. Day start time

      Day start time as defined in the General settings settings

  7. Quick view for the selected event

    Event log
    1. Event type as Check-in or Check-out

    2. User name

    3. Event time

    4. Edit button

      Edit the event

    5. Delete button

      Delete the event

    6. Import and Export events

      • Import events

      • Export events

      Import/export events
  8. Calendar

    Event log
    1. Error

      The number of error events in the particular day showing in red color with error event count. Error events are

      • Checkin events with missing checkouts

      • Checkout events with missing check-ins

    2. OK

      All events are properly recorded without error events is showing in green color.

    3. Current day

      Current day is showing in yellow color with incomplete event count.

  9. List

    All events for the selected date display as a list in the event table.

  10. Map

    Recent event location of each user is showing on a map. Refer Monitor users recent event on the map section for more details.

Users attendances

Attendances are displaying in the event table according to the selected filters

  1. Select shift

    Filter by selected shift.

  2. Select user group

    Filter by selected user group.

  3. Select user

    Filter by the selected user.

  4. Show only error events

    If this is true, events,

    • Checkin events with missing checkout events

    • Checkout events with missing check-in events

    will be displayed

  5. Group events

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

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

Event log

Add events

Add new event

  • Select Add button.

  • In the Add event window,

    • User name

      Name of the user to add an event. This is a mandatory field.

    • Shift

      Select the shift. The Default shift is the default value.

    • Status

      Event type as Check-in or Check-out

    • Select date

      Select the event date.

    • Select time

      Set the event time.

    • Time zone

      The browser time zone is selected by default.

    • Description

      Add event

Import events details

Refer Import files section for more details

Edit event

  • Select the event

  • Select``Edit`` button

  • in the Edit event window

    1. Show the event location in the google map

    2. Peripheral type and device name used to record the event
      Import users data

Delete event

  • Select the event for the event table

  • select the Delete button

  • Accept the change from the confirmation dialog

Monitor users recent event on the map

The event map is showing the location of users 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.

  • Checkin event: Check-in events are showing in green color

  • Checkout event: Checkout events are showing in red color

  • Selected event: The selected event is showing in yellow color

Add event

Reports

Report page provides a set of standard reports on employee time attendance. Reports allow to

Report
  1. Report tabs

    Navigate trough reports.

  2. Export data

    Refer Export reports for more details.

  3. Schedule report

  4. Report settings

    Report settings
    1. Report calculation strategy

      Change the calculation based on

      • Daily

      • Weekly

      • Monthly basis.

      This filter available in

      • Total work hour

      • Work hour summary

      • Productivity report

    2. time filter

      Show time ranges in

      • Hours format

      • Hours and minutes format

      This filter only available

      • Total work hour report

      • Work hour summary report

      • Productivity report

      • Arrival report and departure report

    3. Work hour summary report types

      Show Work hour summary report in

      • Work hours

      • Overtime hours

      • Shift hours

      • Shift work hours

      • Productive hours

      • productive work hours

    4. Date range

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

      • Report calculate strategy as daily

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

      • Report calculate strategy as weekly

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

      • Report calculate strategy as monthly

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

  5. Report filters

    Report filters
    1. Shifts filter

      Filter report by shift.

    2. User groups filter

      Filter report by user group.

    3. User name filter

      Filter report by user.

  6. Reload

    Reload the report to generate data as the applied filters.

Generate reports

Report types

The available reports are,

Total work hour report

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

Work hour summary report

This report provides employee working details in daily, weekly or monthly basis.

Productivity report

Productivity report is generated for a selected time period. Fields in the report are calculated as follows.

  • First check-in

    First checked in time.

  • Last checkout

    Last checked out time.

  • Work hours

    The total difference between check-in and check-out events.

  • Break hours

    Total difference between check-in and check-out events.

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

  • Overtime hours

    The difference between actual work hours’ user has spent in the office and work time defined for the particular shift.

  • Productive hours

    Work hours without early arrival and late departure.

  • Unproductive hours

    The sum of Late arrival and departure excluding overtime.

  • Efficiency

    The ratio between productive hours and work time defined for the particular shift.

User detail report

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

  • User code

  • First name

  • Last name

  • Status

  • Address

  • City

  • Email

  • Country

  • Zip/postal code

  • State

  • phone number

Event details

Shows all events in a given date range.

Arrival and Departure report

Arrival and departure report contains 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 particular employee (Shift name, start and end time)

  • Early arrival and early departures

  • Late arrivals and Late departures

  • First check-in and last check-out times

  • Number of events, roster items, additional assignments, leaves, replacements and holidays

  • Employee’s personal information

Export reports

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

  • Export all data as PDF

    Export complete report as a PDF.

  • Export all data as CSV

    Export complete report as a CSV.

  • Export visible data as PDF

    Export currently visible data in the report as a PDF.

  • Export visible data as CSV

    Export currently visible data in the report as a CSV.

Schedule reports

This allows to schedule the reports to send for the recipients in specific time intervals.

  1. Report start date

    The start date for the report generation.

  2. Report end date

    The end date for the report generation.

  3. Calculated by

    Calculation as daily, weekly or monthly basis.

  4. Find recipients from employees

    Select employees to send the reports.

  5. recipients

    Email addresses to send the reports.

  6. Send time

    Time to send the report.

  7. Send date

    Date to send the report.

  8. Frequency

    Select a specific time interval from daily, weekly and monthly to send emails.

  9. Save the changes

    Save the changes in fields.

  10. Close

    Close the SCHEDULE EXPORT dialog.

    Schedule report

Settings

NCheck Bio Attendance control panel settings are

General settings

General settings
  1. Default shift start time

    The start time of the for the default shift.

  2. Default shift end time

    The end time of the default shift

  3. Day start time

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

  4. Week start date

    Week start day of the organization. Default is Monday.

  5. Month start date

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

  6. Date format

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

  7. Time format

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

  8. Dashboard refresh interval

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

  9. Show meridian in time

    Enable the toggle button to show AM/PM with the time. This toggle is disabled in default.

Biometric settings

General settings
  1. Allow without biometrics

    Enable this to record attendance without biometrics using user id

    • Entering user

    • Barcode

    • RFID

  2. Manual face selection

    Enable manual face selection in the NCheck Bio Attendance client applications, when record attendance in user group mode without face biometrics.

  3. Face liveness mode

    Liveness is used to differentiate live faces from none live faces. This prevents record attendaces using face images instead of living faces. Available options are

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

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

    • Passive and active: Both passive and active mode above are combined for better face recognition result.

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

    • 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).

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

  4. Face liveness threshold

    The value which controls the requirements for face liveness. The greater this value is the more strict rules are applied when deciding if the face is live. The default value is 50.

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

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

  7. Enrollment threshold

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

  8. Face confidence

    Use higher face confidence if good image quality is available.

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

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

  11. High-speed face detection

Web interface settings

General settings
  • Language settings

    Select the preferred language for|product| control panel.

Admin Tasks

Following operations are avialable for the Adminstrator.

Admin tsaks

Database Backup - server

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

Database backup

Backup database

Save backup in a local folder
  • Select Local folder option

    • File path

      Database backup location.

    • Password

      Password to encrypt the database. Password should consist of one digit and six characters.

    • Backup event logs

      Uncheck this option to backup all user attendances with the database.

    • Backup eventlogs from

      All attendance records from this date onward will be backup. The default date is the current date.

      Backup database in a local folder
Save backup in a FTP location
  • Select FTP location

    • FTP host

      URL of the FTP.

    • File path

      File path in the FTP.

    • Need username and password to access FTP location

      Select this checkbox if access credintials are required to access the FTP.

      • User name

        User name for the FTP

      • Password

        FTP passowrd

    • Password

      Password to encrypt the database. Password should consist of one digit and six characters.

    • Backup event logs

      Uncheck this option to backup all user attendances with the database.

    • Backup eventlogs from

      All attendance records from this date onward will be backup. The default date is the current date.

    Backup database in the FTP

Schedule backup

Schedule backup in a local folder
  • Select Local folder option

    • File path

      Database backup location.

    • Password

      Password to encrypt the database. Password should consist of one digit and six characters.

    • Backup event logs

      Uncheck this option to backup all user attendances with the database.

    • Backup eventlogs from

      All attendance records from this date onward will be backup. The default date is the current date.

    • Schedule date

      Bacup schedule date.

    • Backup Frequency

      Backup the database from the Schedule date as

      • Daily

      • Weekly

      • Monthly

    Schedule database in a local folder
Schedule backup in a FTP location
  • Select FTP location option

    • FTP host

      URL of the FTP.

    • File path

      File path in the FTP.

    • Need username and password to access FTP location

      Select this checkbox if access credintials are required to access the FTP.

      • User name

        User name for the FTP

      • Password

        FTP passowrd

    • Password

      Password to encrypt the database. Password should consist of one digit and six characters.

    • Backup event logs

      Uncheck this option to backup all user attendances with the database.

    • Backup eventlogs from

      All attendance records from this date onward will be backup. The default date is the current date.

    • Schedule date

      Bacup schedule date.

    • Backup Frequency

      Backup the database from the Schedule date as

      • Daily

      • Weekly

      • Monthly

    Schedule database in the FTP

Re-extract templates

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

  • Select Re-Enroll button and select OK from the confirmation message.

  • Select show previous jobs option to view previous extraction jobs.

Re-extractions support

Import and export data

Export data

Adminstrator allows to export required information by selecting the each option. The more information about export data available in the Export data section.

To export,

  • Select Start export button

  • Follow the steps as mentioned in Exporting files section.

Export data

Import data

Refer Import files section for more details about Import data.

Import data

Common functions

Register NCheck Bio Attendance Clients

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

To register,

  • Select the user or user group from users or user groups table

  • Select the Register devices button

  • In the Register device window,

    Register device
    • Available registration code can be used with the window open.

    • To generate a new registration code,

      • Select the Remove button

      • Select the Generate button

Location restrictions

Location restrictions can be applied to limit user or user group check-in/checkout events to a particular area.

Location restriction view allows to

Location restrictions view as follows,

User specific settings
  1. Number of location restrictions applied for user/user group

  2. Edit location restriction

  3. Delete location restriction

  4. Add new button to Add new location restriction

Add new location restriction

  • Select Add new button.

    Select location from history
    1. Add 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. Location restriction form

      Location restriction from
      • Name

        This is a mandatory field.

      • Description

      • Address

        Address of the restricted location.

      • Latitude

        Latitude of the restricted location. This is a mandatory field.

      • Longitude

        Longitude of the restricted location. This is a mandatory field.

      • Radius

        The range can be applied in meters to restrict the area from the given location. 100m is the default value.

      • Allow bypass

        The user allows bypassing the location restrictions from the NCheck Bio Attendance client app unchecking this option.

Edit location restriction

  • Select the Edit button to edit the location restriction

  • In Edit location restriction dialog,

    Select location from history
    1. Name

      This is a mandatory field.

    2. Description

    3. Address

      Address of the restricted location.

    4. Latitude

      Latitude of the restricted location. This is a mandatory field.

    5. Longitude

      Longitude of the restricted location. This is a mandatory field.

    6. Radius

      The range can be applied in meters to restrict the area from the given location. 100m is the default value.

    7. Allow bypass

      The user will allow bypassing the location restrictions from the client app unchecking this option

Delete location restriction

  • Select the Delete button

  • Select the OK button in the confirmation dialog

Import location restrictions details

Refer Import files section for more details.

Export location restrictions details

Refer Export files section for more details.

Import and Export information

NCheck Bio Attendance control panel allows to import and export information as Microsoft Excel comma separated values(.csv) files.

Import files

Required details for import

Following information should be available with the file in order to import.

Import users
  • First name

    This is mandatory information.

  • Last name

    This is mandatory information.

  • Employee code

    This is mandatory information.

  • Email

  • primary telephone

  • Address1

    Address line 1

  • Address2

    Address line 2

  • City

  • Country

  • stateProvinceRegion

  • zipOrPostalCode

  • createdAt

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

Import users
Import user groups
  • groupCode

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

  • Description

  • createdAt

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

Import user group informations template
Import user/user gorup location restrictions
  • Name

This is a mandatory informaion. * Description * Address * createdAt

MM/dd/yyyy h:mm:ss a format should be applied.

  • allowByPass

  • employeeCode

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

  • groupCode

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

  • radius

  • Latitude

    This is mandatory information.

  • longitude

    This is mandatory information.

User location import template
Import user group memberships
  • startDate

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

  • endDate

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

  • createdAt

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

  • groupCode

  • employeeCode

    Import user group memberships template
Import shifts
  • name

    Shift name.

  • description

  • startTimeSecond

    Shift start time

  • checkinStart

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

  • checkinEnd

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

  • endTimeSecond

    The timestamp for shift end time

  • checkoutStart

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

  • checkoutEnd

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

  • workHours

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

  • otStart

    The timestamp for overtime start.

  • otEnd

    The timestamp for overtime end.

  • restrictCheckin

    If this is true, checkinStart and checkinEnd restrictions will be applied.

  • restrictCheckouts

    If this is true, checkoutStart and checkoutEnd restrictions will be applied.

  • restrictOT

    If this is true, otStart and otEnd restrictions will be applied.

  • maxOt

    Maximum overtime overs permitted.

Import/export shift

Important

All timestamp should be in HH:mm:ss format.

Import rosters
  • rosterName

  • startDate

    Start date of the roster.

  • endDate

    End date of the roster.

  • deletedDate

    This should be empty.

  • createdDate

    Specify the date for the roster create.

  • rosterType

  • repetition

Import roster template

Important

All date time should be MM/dd/yyyy h:mm:ss a format and date format should be MM/dd/yyyy format.

Import roster items
  • createdAt

    Created date for the roster item

  • deletedDate

  • dayNumber

  • employeeCode

  • groupCode

  • rosterName

  • Name

    Name of the shift

Import roster items template
Import holidays
  • description

    Description of the holiday

  • date

    Date of the holiday

  • createdAt

    Created date in the NCheck Bio Attendance server

Import holidays

Important

All date time should be MM/dd/yyyy h:mm:ss a format.

Import leaves
  • startDate

    Leave start day

  • End date

    Leave end day

  • createdAt

    Leave created date in the NCheck Bio Attendance server

  • leave type

  • employeeCode

    Import/export leaves

Important

All date time should be MM/dd/yyyy h:mm:ss a format.

Import events
  • checkinLatitude

    Latitude of the check-in location

  • checkinLongitude

    Latitude of the check-in location

  • checkinAddress

    Address of the check-in location

  • checkinDescription

    Description of the checkin

  • checkoutLatitude

    Latitude of the checkout location

  • checkoutLongitude

    Latitude of the checkout location

  • checkoutAddress

    Address of the checkout location

  • checkoutDescription

    Description of the checkout

  • employeeCode

  • taskName

    Shift name

  • checkinTime

    Date and time of the check-in time

  • checkoutTime

    Date and time of the checkout time

  • shiftStart

    Date and time of the Shift start

  • otStart

  • shiftSpanSecond

  • otSpanSecond

  • otEnabled

  • limitOT

  • checkinTimeZone

    Checkin time zone in seconds.

  • checkoutTimeZone

    Checkout time zone in seconds.

  • workHours

    Work hours in seconds

  • maxOT

Add event
Importing files

Infromation files can be imported as follows

To import,

  • Select the Import button.

Import from the local file system
  • In the Import data window,

    • Choose file

      Select the file from the local file system.

    • Password protection

      Selec this option to give the file password if the file is encrypted.

      • File Password

        Enter the password encrypted password.

    Import data from local
Import from FTP server location
  • In the Import data window,

    • FTP host

      URL of the FTP.

    • File path

      FIle path to upload the exported file to the FTP.

    • Need username and password to access FTP location

      Select this option to give the FTP user name and password if exist

      • User name

        User name for the FTP.

      • Password

        Password for the FTP.

    • Choose file

      Select the file from the local file system.

    • Password protection

      Selec this option to give the file password if the file is encrypted.

      • File Password

        Enter the password encrypted password.

    Import data from FTP

Note

The selected file should be followed the structure as mentioned in the Required details for import section.

Export files

Avaialable information for Export
  • Users

  • User group

  • Location restrictions

    Location restriction applied to user and user groups.

  • User group memberships

    Users attached with user groups.

  • shifts

  • Rosters

  • Roster items

  • holidays

  • Leaves

  • Events

Exporting files

Files can be exported as follows

To export,

  • Select the Export button

Download exported files
  • In the Export data window,

    • File password

      Exporting file should be encrypted using a password. The password should consist of one digit and six characters.

    Export data to local
Save to FTP location
  • In the Export data window,

    • FTP host

      URL of the FTP.

    • File path

      FIle path to upload the exported file to the FTP.

    • Need username and password to access FTP location

      Select this option to give the FTP user name and password if exist

      • User name

        User name for the FTP.

      • Password

        Password for the FTP.

    • File password

      Exporting file should be encrypted using a password. The password should consist of one digit and six characters.

    Export data to FTP

Data table functions of the NCheck Bio Attendance control panel

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

  1. Datatable menu button

  2. Save the current state of the data table

    Save the displaying columns, order of the columns

  3. Clear all applied filters for each column, when the filters are available

  4. Show/hide the columns

    Check/uncheck in order to visible hide columns

Data table

Users Control Panel

NCheck Bio Attendance control panel for user allows reviewing user specific data for each user. User control panel view as follows

Data table
  1. Organization logo

  2. Organization name

  3. Documentation

  4. Notifications

  5. Manage user account

  6. Control panel menu

Manage user account

Select the user icon in the navigation bar. User menu allows to

user menu

Manage user details

This allow for updating user information. Select My account button in the user menu.

update user

User login options

Select Login options button. Following operations are available in the login option window.

  • Switch between roles

    user can switch the role if there are assigned any roles.

  • Change password

    Changed user login password.

Note

The password must consist of one digit and six characters.

update user

User event logs

Event logs allow monitoring user attendances. Event log view as follows

user event logs
  1. Refresh the view

  2. Select shift

    Filter attendances as the selected shift.

  3. Show only error events

    If this setting is checked, Following events will be shown in the event table.

    • Checkin events with missing checkout events

    • Checkout events with missing check-in events

  4. Group events

    • Event time

      Events will be displayed according to the check-in/checkout time in the particular day.

    • Shift time

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

  5. Selected date

  6. Select the current date in the calendar to show events.

  7. Calendar

    Calendar
    1. Error

      The number of error events in the particular day showing in red color with error event count. Error events are

      • Checkin events with missing checkouts

      • Checkout events with missing check-ins

    2. OK

      All events are properly recorded without error events is showing in green color.

    3. Current day

      Current day is showing in yellow color with incomplete event count.

  8. Event quick view

    Event type, time and address are showing in this view

  9. Events table

Roster and schedules

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

The rosters and schedules view as follows.

Rosters and schedules
  1. Rosters

    Assigned rosters for the user are showing in this view.

    • Name

      Roster name

    • Range

      The date range of the roster.

    • Ends on

      The end date of the roster. If no end date specified, the roster will continue.

    • Status

      Using status of the roster.

  2. Shift

    All assigned shifts are showing in this view.

    • Name

      Shift name

    • Start

      Shift start time

    • End

      Shift end time

  3. Holidays

  4. Leaves

  5. Roter items

Holidays

  • Select Holiday button in the Roster view.

  • The Holidays window appears. There are two views in this window

    • Yearly view

      User can see applied holidays for the selected year.

      Holidays yealry view
      1. Calendar

      2. Holiday list

    • Report view

      User can see applied holidays for a specified date range.

      Holidays report view
      1. From

        Date range start date.

      2. To

        Date range end date.

      3. Holiday list

Leaves

  • Select the Leave management button in the Roster view.

  • The Leave management window appears. There are two views in this window

    • Calendar view

      The calendar view is showing the applied leave of the user for a selected month.

      Holidays yealry view
      1. Selected month

      2. Leave applied dates are displayed in yellow color

      3. Leave list

    • Report view

      Report view is showing the applied leaves for the specified date range

      Holidays yealry view
      1. From

        Range start day.

      2. To

        Range end day.

      # Leave list

Roster items

Work schedule of the user for a week has been specified using the roster items. A roster item as follows

Roster item
  1. Shift details

    • Shift name

    • Shift start time

    • Shift end time

  2. user/ user group name

    user or user group name is showing this area.

User reports

User reports are allowed to monitor and export user specific details as

  • Total work hour report

  • Productivity report

  • Event details report

The report view as follows,

User reports
  1. Report types

    • Total work hour report

    • Productivity report

    • Event details report

  2. Export user reports

  3. Report settings

    User report settings
    1. Report calculation strategy

      Change the calculation based on

      • Daily

      • Weekly

      • Monthly basis

    2. time filter

      Show time ranges in

      • Hours format

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

      • Report calculate strategy as daily

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

      • Report calculate strategy as weekly

        Theeport can be generated in weeks. The custom range can be in weeks enabled selecting Custome date range setting.

      • Report calculate strategy as monthly

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

  4. Filter report by the shift

  5. Reload the report to generate data as the applied settings and filters.

Export user reports

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

  • Export all data as PDF

    Export complete report as a PDF.

  • Export all data as CSV

    Export complete report as a CSV.

  • Export visible data as PDF

    Export currently visible data in the report as a PDF.

  • Export visible data as CSV

    Export currently visible data in the report as a CSV.

User settings

The user settings view as follows,

User settings

Users allow changing the control panel language using this setting.