NCheck Bio Attendance control panel

NCheck Bio Attendance control panel is used to manage NCheck Bio Attendance control system of the server. NCheck Bio Attendance Control Panel can be accessed from,

Access NCheck Bio Attendance control panel

NCheck Bio Attendance control panel role management

Following users can login 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 an e-mail.

Administrator

Administrator is allowed to access all features in the control panel as mentioned in Administrator’s Control Panel section.

Group Administrator

Group administrators are allowed access user management, user group management, event logs and reports for users in the assigned user groups.

The administration auditor

Administration auditor is allowed to monitor the control panel.

Group administrator auditor

Group administrator auditor is allowed to 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.

Log into NCheck Bio Attendance control panel

Log into Cloud server control panel

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

  2. Enter your username and password

login window

Figure 46 NCheck Bio Attendance Cloud server login page

Reset password

  1. Select click here button next to “Forgot password” in the login view.

  2. Enter the email address

  3. Select reCaptcha

  4. Link to reset password will be sent to your email after clicking the continue button.

Reset password

Figure 49 Reset password on NCheck Bio Attendance Cloud server

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

Figure 54 NCheck Bio Attendance Cloud server control panel

  1. Organization logo

  2. Organization name

  3. Help

    NCheck Bio Attendance documentaion will 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.

User menu

Figure 55 NCheck Bio Attendance server admin menu

Administrator account

Select My account in the user menu. Following options available Administrator account window.

Update company information

Administrator allows updating company information and logo before record attendance.

Administrator account-information

Figure 56 NCheck Bio Attendance organization information window

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,

Dashboard

Figure 61 NCheck Bio Attendance Cloud server dashboard

  1. Quick access

  2. Employees and devices summary

  3. Recent users

  4. Leaves and holidays

  5. Date and time

  6. Plan and subscription statistics

    plan statistics

    Figure 62 NCheck Bio Attendance Cloud server dashboard plan and subscription statistics

    1. Plan

      Plan name and plan code is showing here. Accrording to the above image paln name is Plan 50 and plan code is plan50.

    2. Plan statistics

      Following details are showing here.

      • Number of existing users

      • Number of users available to add

      • Percentage of the existing users

Quick access

  1. Add employee

  2. Fix attendance

    This option redirect the admin to the eventlog page to fix the employees missing checkin/checkout events.

  3. Register device

    This option redirect the admin to register NCheck Bio Attendance client application for a user group.

  4. Dashboard refresh status

    Dahboard refresh can be set by the administrator. Refer General settings for more details.

Quick access

Figure 63 Quick access view point of the dashboard

Employees and devices summary

Employees status summary

Number of Employee checkin/checkout in current day.

Devices summary

Number of personal and group registered device upto date.

Dashboard statistics

Figure 64 Employee and device statistics view of the dashboard

Recent users

Recent event of each users will be displayed in the Recent Users table.

Recent user events

Figure 65 Recent user list view of the dashboard

Leaves and holidays

All employee leaves and holidays for the particular month are showing in this section.

  1. Number of leaves for the particular day if available

  2. The day is highlighted as the holiday with the holiday description if available

  3. Leaves and holidays for statistics for the day. Hold the mouse pointer on the particular day until statistics appears.

Leaves and Holidays

Figure 66 Leaves and holiday view of the dashboard

Manage Users

User management

Figure 67 User management view of the NCheck Bio Attendance server control panel

The following options are available in this view.

  1. Add users

  2. Advanced options

  3. Search users

    Filter user from the user table

  4. Users table

    User table represents all users enrolled to the NCheck Bio Attendance server with detail as below.

    • Employee code

    • First name

    • Last name

    • phone

    • Created time

      Date and time of the user enrolled

    • Modified date

      Last modified date of the user

    • Admin

      user role in the NCheck Bio Attendance system.

    • Active

      Blocked users are known as inactive users.

  5. User quick view

  6. User specific settings

User quick view

This section allows to control all user specific functions when recording attendance.

User quick view

Figure 68 NCheck Bio Attendance server User quick view

  1. Unregister device

  2. Show events for the selected user

  3. Add biometrics

    Refer User biometrics section for more details.

  4. Edit user

    • Select the user in the users table.

    • Select the edit button.

  5. Change password

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

    Change password

    Figure 69 Password change dialogue

    Note

    Change password option is not available for NCheck Bio Attendance Cloud server.

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

  7. Export

    Selected user information can be exported as follows.

    Export user information

    Figure 70 Custom export dialogue

    Refer Import and Export information section for more details.

  8. Register NCheck Bio Attendance clients

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

  9. 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 User quick view section.

Add users

Administrator allows to add new users to the NCheck Bio Attendance system using Add users view.

  • Select Add button.

    Table 10 Add new users - NCheck Bio Attendance Cloud/On-premises

    NCheck Bio Attendance Cloud server

    Add new user

    Figure 71 Add new user - NCheck Bio Attendance Cloud server

    NCheck Bio Attendance On-premises server

    Add new user

    Figure 72 Add new user - NCheck Bio Attendance On-premises server

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.

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

  • Select the Unidentified image button

    unidentified images

    Figure 73 Choose from unidentified images dialogue

Capturing barcode/RFID

Table 11 Capturing barcode/RFID

NCheck Bio Attendance Lite/Standard for Android

  • Select Barcode/RFID buttons

  • Scan Barcode via device camera/Put the RFID tag on the devide

NCheck Bio Attendance Lite/Standard for Windows

  • Select Barcode/RFID buttons

  • Scan Barcode/RFID from barcode/RFID reader

Note

To scan RFID from Android, make sure that your device compatible with scanning RFID. To scan Barcode/RFID in Windows, external Barcode/RFID scanners should be connected with NCheck Bio Attendance client.

Import/export users

Import users

User management

Figure 74 Import users data

Export users

User management

Figure 75 Export users data

Note

This export options is not available for NCheck Bio Attendance Cloud server.

Restore deleted users

User management

Figure 76 Restore deleted users

  • Select the user from the table to restore

  • Select Restore button

  • Change the user details in the Recover user dialogue if neccessary

  • Select Recover button

User biometrics

Users face, fingerprint and iris biometrics can be enrolled in this section in order to record attendance.

Important

Before record user attendances, biometric(s) should be enrolled in the NCheck Bio Attendance Server.

Enroll biometric for the selected user

Biometrics can be enrolled as below.

Add Biometrics

Select Biometrics button.

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

  1. Enroll from file

  2. Enroll from history

Add/update biometric for selected user

Figure 77 Biometric data dialogue

Enroll from 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.

Enroll from history

The face, fingerpint and iris images, unable to identify the user while recording attendace, are kept in NCheck Bio Attendance server. These biometric images can be enrolled for users in order to record attendance.

In the Select from history window,

  • Date range

    Biometrics 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

Figure 78 Select biometrics from history window

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 dialogue for clients

Figure 79 Biometric enrollment from NCheck Bio Attendance client applications

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.

Assign Biometrics
  1. Select the user to add biometric

  2. Select Add biometrics button

  3. In Assign user Biometrics dialogue

    1. Select the biometric type from options

      • Upload face biometric

      • Upload fingerprint biometric

      • Upload iris biometric

    2. Select the choosen option

    3. Select the image file to be uploaded as the selection option above

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 is showing in Figure 80,

User group

NCheck Bio Attendance user group management

  1. Add user groups

    • Click Add button.

      Add user group

      Figure 81 Add new user group

    Note

    Group code should be unique.

  2. Advanced options

  3. Search

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

  4. User groups table

    User groups table represents all groups of users in the organizations. All users group is the default user group with all users. Users group table consist with below details.

    • Group code

      This should be unique.

    • Description

    • Created time

      Date and time of the user group created.

    • Modified time

      Last modified date of the user group.

  5. Edit group users

  6. User group quick view

Edit group users

This view allows to add/remove user(s) to the selected user group.

  • Select the user group

    select users for the user group

    Figure 82 User group view of the user group management

  • Select the Edit button in the Attached users section

    Select user(s) for the user groupCode

    Figure 83 Select users for user group dialogue

  1. Select/deselect the users

  2. Select Update user group button

User group quick view

User group quick view disaplay details such as registered devices, number of users in the group and operations such as manage group, group admins, device registration.

  1. Unregister the device

  2. Assign group administrator

  3. Register user group

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

  4. Edit user group

    • Select user group from the user groups table

    • Select the Edit button.

  5. Remove user group

    • Select the user group.

    • select the Delete button.

    User group quick view

    Figure 84 User group quick view

Assign group administrator

Group administrator(s) can be assigned for a user group. The group administrator allows to monitor edit and update users in the user groups.

  1. Select the Group admins button

  2. Select group admins from the window as shown in below

    • Employee code

    • First name

    • Last name

    • Email

    • Selected

      Check this box in order to add user to the user group.

    • 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

    Figure 85 Select group admins dialogue

Import/export user group

Import user group

Import user group data

Figure 86 Import user group data

Export user group

Export user group data

Figure 87 Export user group data

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

  1. Manage Shift

  2. Manage rosters

  3. Manage roster items

    Shift and roster

    Figure 88 Manage shifts and rosters view of NCheck Bio Attendance control panel

Manage Shift

Daily work schedule can be created adding shifts. This allows create shift for specifc start time and end time with restrictions such as work hours should be covered, check-in, check-out and OT hours.

Following operations are allowed with Shifts

  1. Add shifts

  2. Edit shift

  3. Delete shift

  4. Import/export shifts

Shifts

Figure 89 Shifts management view of the shift and rosters management

Add shifts

A shift can be added for specifc start time and end time with with restrictions such as maximum work hours should be covered, check-in, check-out and OT hours

  • Select Add button

    Add shifts

    Figure 90 Add shift dialogue

    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.

Edit shift

  • Select the shift.

  • Select the edit button.

Delete shift

  • Select the shift

  • Select Delete button

Import/export shifts

Import shifts
Import shifts information

Figure 91 Import shifts information

Export shifts
Export shift informaion

Figure 92 Export shift informaion

Manage rosters

Rosters are specific duration in weeks to plan the organizational activites in certain time periods.

Rosters

Figure 93 Roster management view of the shifts and rosters managment

Add roster

A roster can be added for a certain time period in weeks for a specific time period or without no end date.

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

  • Select New roster button in the roster.

    Add new roster

    Figure 94 Add roster dialogue

    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.

Edit roster

  • Select the roster

  • Select the Edit button

Delete roster

  • Select the roster

  • Select the Delete button

Import/export rosters

Import rosters
Import rosters

Figure 95 Import rosters information

Export rosters
Export rosters

Figure 96 Export rosters information

Manage holidays

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

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

  1. Add new

  2. Import/export holidays

  3. Calendar

    Calendar is showing holidays for each year.

  4. Delete

    Delete holiday.

  5. Report for holidays

Manage holidays Yearly view

Figure 97 Holidays management dialogue of the roster management

Add holiday

  • Select Add new button

  • In Add holiday dialogue as shown in Figure 98,

    • Date

      The date is mandatory. Date of the holiday.

    • Description

      Description for the holiday.

Add holiday

Figure 98 Add holidays dialogue

Import/export holidays

Import holidays
Import holidays

Figure 99 Import holidays information

Export holidays
Export holidays

Figure 100 Export holidays information

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 dialogue as shown in Figure 101 .

    Manage holidays report view

    Figure 101 Report view of the holidays dialogue

    1. From

      Range start day

    2. To

      Range end date

Manage Leaves

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

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

  1. Add new

    Add a new leave to the selected employee as menitoned in Add leave.

  1. Import/export leaves

  2. Calendar

    The calendar allows selecting a date to show the leaves.

  3. Delete

    Delete the selected leave.

  4. Report for leaves

Manage leaves

Figure 102 Leave management dialogue

Add leave

  • select the Add new button.

  • In the Add leave window as shown in Figure 103,

    Add leave

    Figure 103 Add leave dialogue

    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/export leaves

Import leaves
Import leaves

Figure 104 Import leaves information

Export leaves
Export leaves

Figure 105 Export leaves informaion

Report for leaves

Users leave can be viewed as a report.

  • Select the Report view tab in the Leaves dialogue as Figure 106

    Leaves report view

    Figure 106 Report view of the leave management dialogue

    1. From

      Range start day

    2. To

      Range end date

Manage roster items

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

This view allows to,

Roster view

Figure 107 Manage roster items view in the shifts and rosters management

  1. Select current week

  2. Add option

  3. Filter roster items by shift name

  4. Filter by roster items by user/user group name

  5. Roster item

    1. Shift start and end time

    2. Shift name

    3. Assigned users(s)/user group(s) for roster item

    4. Add additional staff

    5. Delete roster item

      Roster item

      Figure 108 Roster item

Add roster item

This dialogue allows to add new roster item in selected day for a user or user group assigning a shift.

  • Select Add button

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

    Roster view

    Figure 109 Add roster item dialogue

    • 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

Depeding on the organization requirement such as handle the work load, manage absentees, additional employee(s) can be added to a specific 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

    Figure 110 Assign additional employees dialogue

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

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 devices

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

Manage devices

Figure 111 Device management view of NCheck Bio Attendance On-premises server control panel

  1. configuration

    Manage peripheral configuration as mentioned in Manage peripheral configuration section.

  2. Advanced

  3. Search

    Search the device from the device and API list.

  4. Device and API list

    Below details are included in the list.

    1. Description of the device/API

    2. Application

      NCheck Bio Attendance client name. This is empty for the API.

    3. Blocked

      Whether the device is blocked or unblocked.

    4. Last Access

      Last access date and time of the device.

    5. Assigned to

      NCheck Bio Attendance client/API registration mode either the user or user group.

    6. Licensed

      Whether the device is a Licensed or unlicensed device.

    7. Created date

      Device regsitered date to the system.

  5. Quick view for the selected device or API

  6. Peripheral view

    Show the available peripheral for the selected device. Manage peripherals section for more details.

  7. Device specific settings

    • Enable licensing

      Enable this option to get access for the premium feature of the NCheck Bio Attendance, if you have a paid subscription.

    • Allow predefined location

      Enable this option to record attendance from the predefined location, if the location services are not available in the device.

Quick view for the selected device or API

Quick view for the selected device or API allows manage registered device/API specific settings.

Manage devices

Figure 112 Quick view of the device of NCheck Bio Attendance server

  1. Device imformation

    1. The operating system of the device

    2. The version of the operating system

    3. Hardware ID

      Unique number to indentify devices.

    4. Assigned customer

      Assigned cutomer name.

    5. Nework ID

    6. Assigned group

      User group name, if the device registerd for a user group.

  2. Edit device/Edit API

  3. Re-register device

  4. Block/Unblock device/API

    The device could be blocked,

    In order to block/unblock device,

    • Select the device

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

    To block/unblock API,

    • Select the API

    • Select block/unblock button in the quick view

  5. Unregister device/API

    Unregister devices and APIs.

    • Select the device/API

    • Select the Unregister button in the device quick view

  6. Settings

    The series of settings can be applied to selected device in the device table.

    Refer Device/API settings section for more details

Device/API settings

_images/control_panel_device_settings.PNG
  1. Device settings list

  2. Change buton to add selected setting

  3. Added device settings

    • Settings can be removed using Remove button for each settings

To add settings,

  1. Select the group setting from the list

  2. Select Change button

  3. Added settings can be visible under added device settings list.

Available device settings are,

  1. Enable licensing

  2. Allow without biometrics

  3. Face liveness mode

  4. Face liveness threshold

  5. Manual face selection

  6. Result dialogue timeout

  7. Offline operation mode

  8. Show work time on clients

  9. Reset offline client password

  10. Automatically synchronize offline data

  11. Offline data synchronize interval

Edit device

This dialogue allows edit the device description.

  • Select the device from the device and API list

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

  • In the Edit device dialogue as shown in Figure 114

    Manage devices

    Figure 114 Edit device dialogue

    • Device code

      Device code can not be changed.

    • Description

      Description for the device.

Edit API

This dialogue allows to changed the API description and password.

  • Select API from the device and API list

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

  • In the Edit API dialogue as shown in Figure 115

    Manage devices

    Figure 115 Edit API dilaog

    • 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 dialogue as shown in Figure 116

    • Select user/user group name

    • Select the Generate button

      Add/edit peripheral configuration

      Figure 116 Re-register device dialogue

Generate API access credentials

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.

To generate credentials,

  • Select the Advanced button

  • select the Generate API access credentials option

  • In the API credential dialogue as shown in Figure 117

    • Select user group

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

    • Description

      This is a mandatory field.

    • API access

      API access role as Admin. or Admin.audit to apply restrictions for API’s as mentioned in Access restrictions section.

    • Select the Create button to generate access credentials

      API credintial dialogue

      Figure 117 API credentials dialogue

Note

Refer NCheck Bio Attendance API guide for more details.

Manage peripherals

Note

Manage peripheral features are not available for NCheck Bio Attendance Cloud server.

NCheck Bio Attendance server is showing all available peripherals with the selected devices in the device table. Once the device is registered and NCheck Bio Attendance client device, NCheck Bio Attendance On-premises server is identifying all available peripherals with the device such as camera, finger print, iris, keyboard, RFID and barcode automatically.

The peripheral view as follows,

Manage peripherals

Figure 118 Peripheral view of the device management

  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 according to the availability with the NCheck Bio Attendance client.

Important

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

Edit peripheral

This dialogue allows to change the peripheral name and peripheral configuration settings.

  • Select the peripheral form the peripheral table

  • Select the Edit button

    Add/edit peripheral configuration

    Figure 119 Edit peripheral dialogue

    • Peripheral code

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

    • 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

Note

Manage peripheral configuration features are not available for NCheck Bio Attendance Cloud server.

Peripheral configuration can be applied to customize the peripheral when record attendences such as event type, trigger external executable, user authentication. The default peripheral configuration is applying acros all peripherals if the custom peripheral configuration is not available.

To manage peripheral configuration,

  • Select the Configuration button

    In the Edit peripheral configuration dialogue is showing in Figure 120,

Add new peripheral configuration

  • Select Add button

  • In Add new configuration dialogue as shown in Figure 121,

    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

      Figure 121 Add new configuration view in the Edit peripheral configuration dialogue

Authentication mode

Authentication mode can be applied to enhance the user idenification preventing buddy punching.

  • 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 as Figure 122.

    Manage peripheral configuration

    Figure 122 Combination of user id peripheral with biometric peripheral in verification mode

  • None

    Attendances are not recording when the authentication mode is none.

External executables

This settings can be used to trigger a external devices using third party API in case such as open a door after successfull check-in/check-out.

External executables

Figure 123 Add external executable view in the edit peripheral configuration dialogue

  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

    • time stamp

    • user reference

    • user name

    • shift code

    • location

Manage Event logs

Event logs are allowed the administrator to add,edit, delete and review all event logs recorded within the organization.

Event log

Figure 124 Event logs management view of NCheck Bio Attendance control panel

  1. Refersh all event logs

  2. Re-evaluate

    Select this button to re-evaluate all the eventlogs

  3. Add event logs

    • Select Add button.

    • In the Add event dialogue,

      Import users data

      Figure 125 Add new event dialogue of NCheck Bio Attendance server

      1. User name

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

      2. Status

        Event type as Check-in or Check-out

      3. Select date

        Select the event date.

      4. Select time

        Set the event time.

      5. Time zone

        The browser time zone is selected by default.

      6. Shift

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

      7. Shift date

      8. Description

  4. Event filters

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

    Event logs filters

    Figure 126 Filters of the event logs management

    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.

  5. A quick view of the selected date from calendar

    Event log

    Figure 127 Quick view of the calendar for selected date in the event logs management

    1. Select today button

      Select the current date from the calendar.

    2. Day start time

      Time to start working hours. Default is 00.00.00.

  6. Quick view for the selected event

    Event log

    Figure 128 Quick view of the selected event in event logs management

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

    2. User name

    3. Event time

    4. Edit button

      in the Edit event dialogue as shown in Figure 129,

      1. Show the event location in the google map

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

      Import users data

      Figure 129 Edit event dialogue of NCheck Bio Attendance server

    5. Delete button

      • Select the event for the event table

      • select the Delete button

      • Accept the change from the confirmation dialogue

  7. Calendar

    Event log

    Figure 130 Calendar view of the event logs management

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

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

  9. Map

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

  10. Import/export event logs

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: Selected event is showing in yellow color

Add event

Figure 131 Recently recorded events map view

Import/export event logs

Import event logs

Import event logs

Figure 132 Import event logs information

Export event logs

Export event logs

Figure 133 Export event logs information

Reports

Report page provides a set of standard reports on employee time attendance. Reports allow to Generate reports, Export reports and Schedule export

Report

Figure 134 Report view of NCheck Bio Attendance control panel

  1. Report tabs

    Navigate through reports.

  2. Export data

    Refer Export reports for more details.

  3. Schedule report

  4. Report settings

    Report settings

    Figure 135 Settings view of the Reports

    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

      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 Custom date range setting.

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

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

      Note

      This filter is not available for user detail report.

  5. Report filters

    Report filters

    Figure 136 Filters view of the reports

    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 work hours details for a selected date range. That details can be calculated by daily, weekly, monthly basis. The important parameters are

Work hour summary report

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

Productivity report

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

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

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

  • Name

  • ID

  • Shift name

  • Shift start

    Start time of the shift.

  • Direction and status

    Event type as check-in or check-out.

  • Time

    Event time

  • Time zone

    Time zone difference in hours with respective to UTC.

  • Location

    Longitude and Latitude cordinates of the event location.

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,

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 export

Schedule export option allows to

  • Send reports for the selected users daily weekly or monthly basis

  • Backup report in a FTP for daily, weekly or monthly

Schedule report

Figure 137 Schedule export dialogue of NCheck Bio Attendance server

  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 recepient from name

    Enter the recepient(s) name instead of emails.

  5. recipients

    Emaile address of the recepient(s).

  6. Backup to FTP server

    1. FTP host address

    2. File path in the file system

    3. Check this if the access credentials is required

    4. FTP User name

    5. FTP password

    backup to FTP

    Figure 138 Backup reports to FTP

  7. Send time

    Time to send the report.

  8. Send date

    Date to send the report.

  9. Frequency

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

  10. Save the changes

    Save the changes in fields.

  11. Close

    Close the schedule export dialogue.

Admin Tasks

Admin tasks allows to import and export as cvs file(s).

Admin tsaks

Figure 143 Admin tasks view of the NCheck Bio Attendance Cloud server control panel

Import and export data

Import data

Export data

Figure 150 Export view of the admin tasks

Export data

Import data

Figure 151 Import view of the admin tasks

Subscription

Note

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

Subscription page allows to choose a plan, purchase licesnes, settle payments and review payment statistics of the NCheck Bio Attendance Cloud server account.

Subscription view

Figure 153 Subscription view of NCheck Bio Attendance Cloud server

  1. Plan statistics

    Plan statistics

    Figure 154 plan statistics of NCheck Bio Attendance Cloud server

    • Plan code

    • Plan started date

    • Rate

      Price per month in euros

    • User limit

      Maximum number of user limits of the plan.

    • Credit period

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

    • Paid to

      The plan has been purchased for this date.

    • Remaining usage

      Remaining usage of the plan for the existing balance.

    • Due date

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

    • Balance

      Balance for the current date.

    • Change plan

    • NCheck Bio Attendance Cloud server plan history

  2. License statistics

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

    License statistics

    Figure 155 License statistics of NCheck Bio Attendance Cloud server

    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 licesnes out of maximum number of licenses.

  3. Outstanding summary

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

    Outstanding summary

    Figure 156 Outstanding summary of NCheck Bio Attendance Cloud server subscription

    • Licenses/plans

      NCheck Bio Attendance Cloud server plans and clients license names with rate is showing in this columns.

    • Start at

      Start date of the Licenses/plans.

    • Expire at

      Expiring date of the Licenses/plans.

    • Paid to

      Until which date administrator made the payment.

    • Usage

      Duration between plan start date and expired date/current date.

    • Total

      Total amount for the usage.

    • View and pay bill

    • Schedule payments

  4. Payments summary

    Payments summary is showing below details. Selected payment details will be shown in payment quick view details.

    • Payment date

    • Bill date

    • Total amount

    • Status

      • Completed

        Successfully Completed payments.

      • Pending

        pending payments.

  5. Payment quick view

    Details of the selected payment in Payments table is showing as below.

    Table 13 Admin operations logs views

    Payment completed

    Payment completed

    Figure 157 Quick view of payment completed

    Payment pending

    Payment pending

    Figure 158 Quick view of payment pending

    1. Payment status

    2. Billed date

    3. Total amount

    4. Plan usage summary

      • item

        Plan name

      • From

        Plan started date

      • To

        Plan expired/changed date

      • Rate

        Price for month in Euros(€)

      • Total amount for the Usage in Euros(€)

    5. License usage

      • item

        License Code

      • From

        Plan started date

      • To

        Plan expired/changed date

      • Rate

        Price for month in Euro(€)

      • Total amount for the Usage in Euro(€)

      • Total amount for the Usage in Euro

    6. Show invoice button

      Open payment invoice.

    7. Detailed receipt button

      Open the detailed receipt as showing in view and pay bill section.

    8. Delete button

      Delete payment request.

    9. Complete` payment button

      Proceed to the payment receipt to complete the payments.

Change plan

CHange plan

Figure 159 Change the plan of NCheck Bio Attendance Cloud server

NCheck Bio Attendance Cloud server plan history

Plan history

Plan history

Figure 160 Plan history of NCheck Bio Attendance Cloud server

  1. Start at

    Plan started date.

  2. Expired at

    Plan expired/changed date.

  3. Code

    Plan code as Free, PLAN20, PLAN50, PLAN100, or Custom.

  4. Description

  5. Rate

    Plane price per month in Euros.

License history

License history off the client devices are shwoing in below table

License history

Figure 161 Licesne history of NCheck Bio Attendance Cloud server

  1. Created at

    License created date.

  2. Expired at

    License expiration day.

  3. Code

    License codes

  4. Modified at

Blocked history

Blocked history of the NCheck Bio Attendance Cloud server account is showing as below.

License history

Figure 162 Blocked history of NCheck Bio Attendance Cloud server

  1. Blocked at

    Account blocked date

  2. Blocked reason

    Reason for the blocking

  3. Unblocked at

    Unblocked date of the account

  4. Unblocked reason

  5. Plane name

View and pay bill

  1. Select View and pay bill button

  2. In the bill draft dialogue

    1. Export the bill draft as PDF

    2. Set the date to pay upto date

    3. Bill draft

    4. proceed button to proceed to the payment reciept

    5. Cancel button to cancel the dialogue

    View and pay bill

    Figure 163 View and pay bill of NCheck Bio Attendance Cloud server subscription

    If the payment reciept is already created, It will show the dialogue as below.

    1. Payment reference number

    2. Export the bill draft as PDF

    3. Bill draft

    4. Delete button to delete the payment reciept

    5. proceed button to proceed to the payment reciept

    6. Cancel button to cancel the dialogue

    View and pay created bill

    Figure 164 View and pay bill created bill of NCheck Bio Attendance Cloud server subscription

  3. Select proceed button for payment receipt dialogue

    In this step, incomplete payment will be created.

    1. Export payment receipt as a PDF

    2. Payment receipt

    3. Pay bill button to proceed to the payment

    4. Close the payment receipt

    Payment receipt

    Figure 165 Payment receipt of NCheck Bio Attendance Cloud server subscription

  4. Select Pay bill button to proceed to the payment

  5. Select confirm button in the confirm your payment dialogue

  6. You will directed to the paypal payment gateway to make the payment. Once the payment success, you will be redirected to the NCheck Bio Attendance Cloud server

Schedule payments

  1. Select Manage schedule payment button

  2. in the Manage paypal subscription status dialogue

    • Select Subscribe and schedule button to proceed

    User control panel

    Figure 166 Manage paypal subscription status of NCheck Bio Attendance Cloud server

  • if a payment schedule is already created

    1. Select Activate button to proceed

    2. Select Cancel payment schedule button to cancel the payment schedule

    User control panel

    Figure 167 Manage schedule of NCheck Bio Attendance Cloud server

  1. Select Subscribe and schedule button. You will be directed to the paypal login.

  2. Proceed through the paypal to schedule payments.

  3. Once you have subcribed successfully, you will be redirect to the NCheck Bio Attendance Cloud server

Users Control Panel

NCheck Bio Attendance Cloud/On-premises server control panel for user allows reviewing user specific data for each user. User control panel is shown in Figure 168.

User control panel

Figure 168 NCheck Bio Attendance control panel view for users

  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

Figure 169 User menu of the NCheck Bio Attendance control panel

Manage user details

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

update user

Figure 170 Manage user informations dialogue

User login options

Select Login options button. Following operations are available in the login option dialogue as shown in Figure 171.

  • 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

Figure 171 Login options dialogue

User event logs

Event logs allow monitoring user attendances. Event logs view is shown in Figure 172.

user event logs

Figure 172 User event logs management view of the NCheck Bio Attendance control panel

  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

    Figure 173 Calendar of the event logs management

    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.

The rosters and schedules view as follows.

Rosters and schedules

Figure 174 User roster and schedules view of the NCheck Bio Attendance control panel

  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. Roster items

Holidays

  • Select Holiday button in the Roster view.

  • The Holidays dialogue appears as shown in Figure 175. There are two views in this window

    • Yearly view

      User can view applied holidays for the selected year.

      Holidays yealry view

      Figure 175 Holidays dialogue of the user

      1. Calendar

      2. Holiday list

    • Report view

      User can see applied holidays for a specified date range.

      Holidays report view

      Figure 176 Report view of the holidays dialogue

      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 Leaves dialogue appears as shown in Figure 177. 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

      Figure 177 Leaves dialogue of the user

      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

      Figure 178 Report view of the leaves dialogue

      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 is shown in Figure 179

Roster item

Figure 179 Roster item view of the roster

  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

Figure 180 User report view of the NCheck Bio Attendance control panel

  1. Report types

    • Total work hour report

    • Productivity report

    • Event details report

  2. Export user reports

  3. Report settings

    User report settings

    Figure 181 Settings view of the report

    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 Custom date range setting.

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

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

  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

Figure 182 User settings view of NCheck Bio Attendance control panel

Users allow changing the control panel language using this setting.

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 dialogue as shown in Figure 183,

    Register device

    Figure 183 NCheck Bio Attendance device registration

    1. Device registration code

    2. Copy the registration code to clipboard

    3. To generate a new registration code,

      • Select the Remove button

      • Select the Generate button

    4. Email device registraion code

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

Location restrictions

Location restrictions can be applied for selected user/user group in order to bound check-in/checkout events to a particular area.

Location restriction view allows to

Location restrictions view as follows,

User specific settings

Figure 184 Location restrictions view

  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

    Figure 185 Select location restrictions from history dialogue

    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

      Figure 186 Location restriction form view

      • 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 dialogue as shown in Figure 187,

    Select location from history

    Figure 187 Edit location restriction dialogue

    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 dialogue

Import/Export location restrictions

The location restriction information for user/user group can be imported/exported as CSV file. Please refer

Import and Export information

Required data can be imported/exported in CSV file{s) includes in the ZIP file. Hierarchy of the zip file as below.

Listing 1 File import exoprt structure
   Zipfile/
     |
     |--Thumbnail/
     |     |--Customer/
     |     |       |--<customername>.jpg
     |     |--Person/
     |     |       |--<employeecode>.jpg
     |     |--UserGroup/
     |             |--<groupcode>.jpg
     |--Biometric/
     |     |--Image/
     |             |--<employeecode>_<modality>_<dataid>.jpg
     |             |--<employeecode>_<modality>_<dataid>.png
     |     |--Template/
     |             |--<employeecode>_<modality>_<dataid>.dat
     |             |--<employeecode>_<modality>_<dataid>.dat
     |--Other information as CSV
     |-- ...

Note

Thumbnail and biometric can not be exported.

Important

  • Folders and images should follow the exact naming convention.

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

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

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

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

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

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

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

  • Other import data files (CSV files) can also be included in the same zip file.

To Import data,

  • Select import button

  • Select required information from the list to be import

  • Select import location from the Import data dialogue.

    Refer Select import location section.

To export data,

  • Select Export button

  • Select required information from the list to be import

  • Select the export location from the Export data dialogue.

    Refer Select export location section.

User thumbnails

User thumbnails can be imported as jpg, png format in a zip file according to the file structure as showing in Listing 1. Unlike other information administrator are feels free to import all user thumbnails with any other file import.

Note

User thumbnails can not be exported.

User biometrics and template files

User biometrics and templates data can be imported as zip file as showing in Listing 1.

Note

User biometrics can not be exported.

User profile information

  • 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

Figure 188 CSV template for import users

Note

This feature is not available in the NCheck Bio Attendance On-premises server.

User group information

  • 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

Figure 189 CSV template for import user groups

User/user group location restrictions information

  • Name

This is a mandatory information. * 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

Figure 190 CSV template for import users and user groups

User group memberships information

  • 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

    Figure 191 CSV template for import user group memberships

Shifts information

  • 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

Figure 192 CSV template for import shifts

Important

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

Rosters information

  • 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

Figure 193 CSV template for import rosters

Important

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

Roster items information

  • createdAt

    Created date for the roster item

  • deletedDate

  • dayNumber

  • employeeCode

  • groupCode

  • rosterName

  • Name

    Name of the shift

Import roster items template

Figure 194 CSV template for import roster items

Holidays information

  • description

    Description of the holiday

  • date

    Date of the holiday

  • createdAt

    Created date in the NCheck Bio Attendance server

Import holidays

Figure 195 CSV template for import holidays

Important

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

Leaves information

  • 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

    Figure 196 CSV template for import leaves

Important

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

Event logs information

  • 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

Figure 197 CSV template for import events

Select import location

Information files can be imported as follows

To import,

  • Select the Import button.

Import from the local file system
  • In the Import data dialogue as shown in Figure 198,

    • 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

    Figure 198 Import data dialogue to import from local file system

Import from FTP server location
  • In the Import data dialogue as shown in Figure 199,

    • 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

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

      • File Password

        Enter the password encrypted password.

    Import data from FTP

    Figure 199 Import data dialogue to import from FTP location

Note

The selected file should be followed the structure as mentioned in the Import and Export information section.

Select export location

Files can be exported as follows

  • Select the file export location. Therer are two options available to select.

    1. Download exported files

      Refer Download exported files section for more details.

    2. Save to FTP location

      Refer Save to FTP location section for more details.

  • File password

    Exporting file should be encrypted using a password. The password should be consisted wuith one digit and six characters.

  • Select the Export button

Important

Excrypted files can not be open via Microsoft Windows default extracter. You may use any thired party softare which support encrypted files extraction.

Download exported files
  • The Export data dialogue has shown in Figure 200,

    Export data to local

    Figure 200 Export data dialogue for download to local file system

Save to FTP location
  • In the Export data dialogue as shown in Figure 201,

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

    Export data to FTP

    Figure 201 Export data dialogue for download to FTP location

Report parameters

All report parameter can be explained using following figure.

Work hours calculation

First checkin

First checkin time within the shift

Last checkout

Last checkin time within the shift

Work hours

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

Work hours calculation

In-out hours

Time difference between first check-in and last check-out.

In-out hours calculation

Productive hours(HP)

According to the figure, productive hours can be identified as

Productive hours calculation

According to the Figure this can be defined

Productive hours calculation

Shift work hours(HS)

Minimum from work hours and Shift hours.

Shift work hours calculation

Productive work hours(HPS)

Minimum from productive hours and shift work hours

Productive work hours calculation

Unproductive hours

Productive work hours calculation

Overtime hours

Ovetime hours can be defined as

Ovetime hours calculation

Break hours

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

Ovetime hours calculation

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

Depeding 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 particular user/employee in such cases.

Data table functions

Over the NCheck Bio Attendance control panel, list of data are representing using data tables. 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 columns

    Check/uncheck in order to visible/hide columns.

Data table

Figure 202 Data table menu

Control panel settings

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

General settings - NCheck Bio Attendance server

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 behaviour

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

Avialable options are

  • Don’t allow

    Not allowed to select default shift.

  • Allow when no shifts available

    Allow using default shift when custom shifts are not available.

  • Allow when other shifts available

    Allow using default shift when custom shifts available.

Enable/disable 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.

Allow predefined location

Allow predefined location for NCheck Bio Attendance client devices when recording attendances, if the location services are not available.

Note

Allow predefined location setting can be enabled for a particular device as mentioned in the Device/API settings section.

Device settings - NCheck Bio Attendance server

Result dialogue timeout

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

Note

Result dialogue timeout setting can be enabled for a particular device as mentioned in the Device/API settings section.

Enable licensing

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

Note

Enable licensing setting can be enabled for a particular device as mentioned in the Device/API settings section.

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.

Note

Show work time on clients setting can be enabled for a particular device as mentioned in the Device/API settings section.

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.

Note

Offline operation mode setting can be enabled for a particular device as mentioned in the Device/API settings section.

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.

Note

Automatically synchronize offline data setting can be enabled for a particular device as mentioned in the Device/API settings section.

Offline data synchronize interval

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

Note

Offline data synchronize interval setting can be set for a particular device as mentioned in the Device/API settings section.

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.

Note

Allow automatic peripheral enabling of new clients setting can be enabled for a particular device as mentioned in the Device/API settings section.

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.

Note

Reset offline client password setting can be enabled for a particular device as mentioned in the Device/API settings section.

Duplicate event timeout

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

Eventlog 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. Default image size is Medium.

The available image sizes are

  • Small

  • Medium

  • Original

Note

The recommended biometric 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 can be given here. Exit code is empty by default.

Biometric settings - NCheck Bio Attendance server

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 bee disabled by default.

Note

Allow without biometrics setting can be enabled for a particular device as mentioned in the Device/API settings section.

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 bee enabled by default.

Note

Manual face selection setting can be enabled for a particular device as mentioned in the Device/API settings section.

Face liveness mode

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

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

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

Note

Face liveness mode setting can be set for a particular device as mentioned in the Device/API settings section.

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. Default face liveness threshold value is 50.

Note

Face liveness threshold setting can be enabled for a particular device as mentioned in the Device/API settings section.

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.

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 fingerpirnt quality value is 40.

High-speed face detection

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

Web interface settings - NCheck Bio Attendance server

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.

Show meridian in time

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

Language settings

Select the preferred language for NCheck Bio Attendance control panel.Default language is English

Available languages are

  • English

  • Chinese