CLIENT APPLICATIONS

NCheck visitor management client application use to register and record visitors who are coming for visit appointments. There are two types of NCheck visitor management clients.

  1. NCheck visitor management Android client

  2. NCheck visitor management Windows client

System requirements

Table 12 NCheck visitor management Client’s requirements

Client

Requirements

Android client

  1. Microsoft Windows 8 or higher operating system

  2. 1GB of disk space

  3. 4GB of RAM

  4. One supported peripheral as mentioned in the in Peripherals section

Windows client

  1. Android phone or tablet running Android 5.1 OS or later version

  2. 2 GB of RAM

  3. USB OTG (USB On the Go) feature if using peripherals as mentioned in the in Peripherals section

Peripherals

NCheck visitor management client applications support following peripherals.

  1. Face

  2. Fingerprint

  3. Iris

  4. Other

Note

NCheck visitor management installer for Windows is installing all necessary drivers to enable face, fingerprint, and iris scanners. But in case if you need additional drivers, you may need to install compatible drivers in the computer. You can download drivers for supportable camera, fingerprint, and iris scanners from scanner driver package.

Face

NCheck visitor management Android client is using cameras available with the device. NCheck visitor management Windows clients support following camera types.

  1. USB cameras

  2. IP cameras

USB cameras

In general, USB cameras working in Windows OS are supported.

IP cameras

Refer Neurotechnology guide for supported cameras section for all supported IP cameras. Refer Preference section for add IP cameras for NCheck visitor management Windows client.

Fingerprint

NCheck visitor management clients support external or internal USB fingerprint scanners. Refer Neurotechnology guide for supported fingerprint scanners and sensors for Windows standard client.

Iris

NCheck visitor management clients support external or internal USB iris scanners. Refer Neurotechnology guide for supported iris scanners for Windows standard client`. <https://www.ncheck.net/supported-scanners-for-ncheck-standalone-version/iris-scanners>`_

Note

By default, iris scanners are disabled for Windows standard client. To enable, unzip necessary iris scanners from the IrisScanners folder in NCheck visitor management installation folder (By default the installation folder is “C:Program FilesNeurotechnologyNCheck visitor management”)

Other

NCheck visitor management supports capturing other authentication data. Data capture is performed by using the following hardware.

Table 13 Hardware requirements for non-biometric identification

Windows client

Android client

RFID

RFID scanners

NFC Support

Barcode

Using built-in camera/barcode scanners

Using built-in camera

Access control

NCheck visitor management clients can trigger external executables with given parameters as mentioned in External executables section.

Supporting Locations

NCheck visitor management uses operating system provided location services to capture the location of attendance events.

Note

For enabling location service from the operating system, please refer location service configuration for the relevant operating system.

Install clients

To install clients,

  1. Download clients

  2. Install clients

Download clients

NCheck visitor management clients application can be downloaded from download page.

Install clients

To install Windows client, refer Install for windows section for more details. To install Android client, refer Install Android clients section for more details. After successful installation, refer Open clients section for more details about opening application.

Open clients

The clients, performs following tasks before starting the application.

Table 14 Client tasks starting application

Task

Sub task

Description

Initialize app

Check permissions

Refer Check permissions section.

Prepare directories

Refer Prepare directories section.

Validate data files

Validate data files used for biometric capturing

Initialize device settings

Check registration status

Check whether the application has registered or not. If not registered application will show registration view as shown in Register clients section.

Initialize data service

The data service used for communicating with NCheck visitor management server is starting

Validate license

Check network

Refer Check network section for more details.

Check license

Refer Purchase NCheck visitor management license section for more details.

Obtain license

Validate the license. If the license validation failed, a valid license should be activated as mentioned in Activate license section.

After completing all tasks, the application main view will be started as mentioned in Main view section.

Check permissions

Note

Permissions are required for Android clients only

In Android application, the permissions need to be granted to ensure privacy and security of the device data. NCheck visitor management Android clients requires following permissions.

  1. Google play licensing check

    Google Play offers a licensing service that lets you enforce licensing policies for applications that you publish on Google Play. With Google Play Licensing, your application can query Google Play at run time to obtain the licensing status for the current user, then allow or disallow further use as appropriate. Android permission “com.android.vending.CHECK_LICENSE: is using

  2. Access location

    NCheck visitor management Android client is using device location details such as GPS coordinates and address when recording attendance. This requires “android.permission.ACCESS_FINE_LOCATION” permission.

  3. Network information

    This requires “android.permission.ACCESS_NETWORK_STATE” permission. NCheck visitor management Android clients are using network information to check the network available in the device for communication.

  4. Access interment

    This requires “android.permission.INTERNET” permission. Android clients requires Internet to

    1. Communicate with remote NCheck visitor management server.

    2. License operations as mentioned in Purchase NCheck visitor management license section.

    3. To log application and device data in remote logging service(Firebase)

  5. Access Wi-Fi information

    In mobile services Wi-Fi is frequently used to access internet. Android client uses device Wi-Fi information to check the network connectivity and indicate to user. “android.permission.ACCESS_WIFI_STATE” and “android.permission.CHANGE_WIFI_STATE” permissions are required

  6. Access camera

    “android.permission.CAMERA” permission is required. NCheck visitor management Android client is using camera for

    1. Face capture

      Record visitor capturing face biometrics, Enroll face(s) to visitor.

    2. Barcode capture

      Capture visitor pass as barcode for attendance recording and appointment creation, Capture device token,

  7. Access storage

    “android.permission.WRITE_EXTERNAL_STORAGE” permission is required. NCheck visitor management Android client uses application specific external storage to keep following data.

    1. Diagnostic data

      App generated log files to check application working status.

    2. License files

      NCheck visitor management Android client activated license details.

  8. Capture RFID

    NCheck visitor management Android client is capturing RFID to record attendance and appointment creation. “android.permission.NFC” permission is required.

  9. Access device power management tools

    To wake up device when record attendance and create appointments. “android.permission.WAKE_LOCK” permission is required.

  10. Receive application boot completed

    Start the client automatically when device has restarted. This requires “ndroid.permission.RECEIVE_BOOT_COMPLETED” permission.

Prepare directories

Following directories are using:

  1. Log directory

    Keep application specific logs to keep information about application status while using. If any problem happens, we are requesting these logs to investigate the problem.

  2. License directory

    Keep license specific data such as license mode, license text.

Check network

When the application start client application is checking the valid license availability in the device. This requires a network connection as mentioned in Purchase NCheck visitor management license section. Before license check, client check network availability with the device. if the network is not available, client will hold until the network available checking the network connectivity periodically as shown below.

Table 15 NCheck visitor management Client network check view

Client

Network View

Windows client

Android client
_images/image643.PNG

Figure 304 Android client network check

Register clients

NCheck visitor management Clients can be used with following modes.

  1. NCheck visitor management Cloud

  2. NCheck visitor management server installed on-premises.

The registration process configures the application to work with one of the above two modes. Accessing registration can be done as the following ways.

  1. Application will prompt you the registration dialogue when application start in case it is not registered.

  2. Once the device is unregistered as mentioned in the unregister section.

Registration views are shown below.

Table 16 Clients registration views

Registration ode

Client

View

Cloud

Windows
_images/image645.PNG

Figure 305 Windows client registration view on cloud mode

Android
_images/image647.PNG

Figure 306 Android client registration view on cloud mode

On-premises

Windows
_images/image649.PNG

Figure 307 Windows client registration view on on-premises mode

Android
_images/image651.PNG

Figure 308 Android client registration view on on-premises mode

  1. Server URL

  2. Search server button

    Select this option to detect server URL. This option works if the server and client work in the same network.

  3. Registration token

  4. Scan barcode button

    Instead of entering registration token, users can scan barcode in Android client.

  5. Register button

    If the server has signed with the untrusted certificate, you will be asked to accept self-signed certificate as mentioned in SSL Certificate validation section. Once certificate accepted, it will perform all tasks ac mentioned in Open clients section again.

  6. Cancel button

Registration token

To register clients a registration token is required. Refer Device registration section for more details about generating registration token.

SSL Certificate validation

To start the NCheck visitor management server, a valid SSL certificate must be added as mentioned in Server section. If any SSL certificate validation error occurred, you will be prompted the validation error as below.

Table 17 Certificate validation error dialogue

Client

Self-signed certificate prompt

Windows
_images/image653.PNG

Figure 309 Certificate validation error dialog for Windows client

Android
_images/image655.PNG

Figure 310 Certificate validation error dialog for Android client

  1. Title of the SSL certificate validation error dialogue

  2. Error message

  3. Actions

  4. Continue button

  5. Cancel button

License activation

License activation should be performed,

  1. In application start either no license activated or activated license has expired

  2. Open License manager from Main menu.

Refer License and activation section for more details.

Note

Android client will be asked to force close the application either the license activated over the existing one or deactivated license.

Main view

Client main view could be either Attendance view or Registration view according to the mode( Attendance mode / Registration mode ) selected when generate registration token as mentioned in Device registration section.

Table 18 Clients main view

Client

Main view

Windows client
_images/image657.PNG

Figure 311 Main view of Windows client

Android client
_images/image659.PNG

Figure 312 Main view of Android client

  1. Menu button

    Refer Main menu section.

  2. Visitor interaction view

  3. Language

    Language of the Windows client. Available languages are:

    1. English

    2. Chinese

    3. Thai

    4. Spanish

Attendance view

Table 19 Attendance view

Client

Main view

Windows client
_images/image661.PNG

Figure 313 Attendance view of Android client

Android client
_images/image663.PNG

Figure 314 Attendance view of Android client

  1. Status bar

    Refer Status bar section for more details.

  2. Date and time

    Show the current time and date.

  3. Attendance capture

Attendance capture

Attendance capture is where the visitor attendance captures. Attendance view has following views.

  1. Attendance capture view

  2. Feedback view

Attendance capture view

Attendance capture view is capturing visitor events. Using either visitor biometrics or id data. Attendance capture views have been shown below.

Table 20 Attendance capture view

Client

Attendance capture view

Windows client

Android client
_images/image665.PNG

  1. Capturing area

  2. Face rectangle

    When capturing faces, the boundaries of the faces is showing using face rectangle.

  3. Mask detection indicator

    Mask detection indicator is showing in the view according to the Mask detection setting can be applied from either web control panel Client settings or Device settings section.

  4. Camera capturing settings

    Refer Table 21 for more details.

  5. Peripherals view

    Peripheral view is showing available peripherals to capture as configured in Biometric authentication section. Refer Peripherals section for more details about peripherals.

Table 21 Camera capture settings

Client

Settings

Settings view

Windows client

  1. Rotate angle

  2. Mirror

  3. Resolution

    Change capturing resolutions for selected camera from available
_images/image666.PNG

Figure 315 Camera capture settings of Windows client

Android client

  1. Change resolution setting

    Change capturing resolutions for selected camera from available.

  2. Change camera

    Switch camera between front and back cameras
_images/image668.PNG

Figure 316 Resolution dialog of Android camera capture settings
Feedback view

Feedback view is the result dialog which shows to the visitor after recording event successfully. The feedback view can be configured as mentioned in Custom visitor feedback view section when Add/edit/clone schedule Custom feedback view can be provided based on customer requirements as an extension. Refer Use extension section for more details about extension. The default feedback view is shown below.

Table 22 Default feedback views

Client

Default feedback view

Windows client
_images/image670.PNG

Figure 317 Windows client feedback view

Android client
_images/image672.PNG

Figure 318 Android client feedback view

  1. Schedule name

  2. Schedule location

  3. Visitor thumbnail

  4. Welcome/Goodbye status.

  5. Visitor first name and last name

  6. Event time

  7. Appointment starts time.

  8. Appointment end time

  9. Appointment button

    Open visitor appointment quick access view as mentioned in Appointment overview section to update appointment. Appointment button is visible when the attendant mode has enabled as mentioned in Login section.

  10. Close button

Status bar

Table 23 Status bar views

Client

Status bar view

Windows client
_images/image674.PNG

Figure 319 Status bar view of Windows client

Android client
_images/image676.PNG

Figure 320 Status bar view of Android client

  1. Network availability

  2. License status indicator

    Shows the current license obtaining status as licensed, trial or expired.

  3. Server indicator for cloud, on-premises, and standalone mode.

Table 24 Server indicators for Clients

Mode

Windows client Indicator

Android client

Cloud
_images/image678.PNG
_images/image679.PNG

On-premises
_images/image680.PNG
_images/image681.PNG

  1. Server and port

    URL and port of the connected server in cloud, on-premises, or standalone mode

  2. Schedule location

  3. Customer name

  4. Connectivity status with the server indicator in cloud and on-premises mode as shown below.

    Table 25 Online/Offline statuses of Standard clients

    Status

    Description

    Android standard client

    Windows standard client

    Online

    Connected with the server
    _images/image682.PNG
    _images/image683.PNG

    Offline

    Cannot connected with the server
    _images/image684.PNG
    _images/image685.PNG

Registration view

Registration view can be configured using either registration token generated for Registration mode as mentioned in Device registration section or Client mode setting in Device settings sections. NCheck visitor management has provided default registration pages. Customer can request custom registration pages and add to the system using NCheck visitor management extension. Refer Use extension section for more details. NCheck visitor management default registration page layout contains following details.

_images/image686.PNG

Figure 321 Registration page layout

  1. Page header

  2. Page sub header

  3. Back button

    Navigate to previous page.

  4. Reset button

    Reset all the data and go to the start page.

  5. Registration page content area

  6. Current date

  7. Current time

NCheck visitor management registration page can be configured with following pages

  1. Common booking page

  2. Schedule booking page

  3. Overhead display

Common booking page

The common booking page allows to filter and select schedule from the appointment from available a mentioned in Filter schedules section. Once the schedule is selected, the visitor may ask to give certain detail and appointment will be created.

Appointment detail views

While creating an appointment, the following information may ask from visitor.

  1. Visitor pass

  2. Enroll biometrics

  3. Appointment time

  4. Select seats

  5. Visitor details

Visitor pass

Visitor pass view is showing to take and validate visitor pass when pre-printed pass is using according to the selected Visitor pass generation method of Additional settings section .

_images/image688.PNG

Figure 322 Visitor pass view

  1. Schedule quick view

  2. Visitor pass field

  3. Done button

    Validate the entered pass code and proceed to the next view.

  4. Keyboard to enter visitor pass.

  5. Scan

    Scan visitor pass as barcode/RFID as configured in Pass type setting of Add/edit/clone schedule section.

  6. Skip button

    Skip button appears if the “Generate if not available and reuse” option is selected for Pass type setting.

Enroll biometrics

Enroll biometrics when creating appointments for visitor identification. The biometric can be configure as Face, Finger, Iris or None as configured in Biometric collection .

Note

If the Biometric collection setting is none, this view will be skipped.

_images/image690.PNG

Figure 323 Enroll biometrics view

  1. Schedule quick view

  2. Capture instructions

  3. Capture button

    Open capturing view to capture visitor biometrics.

  4. Captured images

    By default 2 images capture to enroll to the visitor when create appointment. Number of maximum biometric images is configurable.

  5. Next button

    Navigate to next detail view.

Note

In simple biometrics and smart access scenarios, the appointment will be created without asking visitor details. once biometric captured.

Appointment time

Select appointment start and end time.

_images/image692.PNG

Figure 324 Appointment time selection view

  1. Schedule quick view

  2. Appointment start and end time

    Select appointment start and end time for the appointment if Allow change appointment time setting has enabled as mentioned in Add/edit/clone schedule section. Default value of the appointment start and end time.

    1. If the Slot time is equal to 0, schedule start and end time.

    2. If the slot time is greater than 0, Selected time slot start, and end time as mentioned in time slot view section.

  3. Break time list view

    Refer Break time list view section for more details..

  4. Time slot view

    Refer Time slots section for more details.

  5. Next button

    Navigate to next detail view.

Select seats

Note

This view is available for the schedules created from Travel and Entertainment scenario.

This view allows to the select seats from seat groups as configured in Seating configuration section section.

_images/image694.PNG

Figure 325 Select seats view

  1. Schedule quick view

  2. Seat selection

  3. Next button

    Procced to Visitor details section.

Visitor details

To enter visitor details and submit the appointment.

_images/image696.PNG

Figure 326 Visitor details view

  1. Captured biometrics details

    Select change button to navigate back to Enroll biometrics .

  2. Appointment detail quick view as shown in Figure 327

    1. Schedule quick view

    2. Appointment starts and end time as selected in Visitor details

    3. Appointment number

  3. Visitor form view

    Refer Visitor form section for more details.

  4. NCheck visitor management terms and conditions

    Accept terms and conditions by click on checkbox.

  5. Submit button

    Submit appointment. Once appointment created it will show the confirmation dialog as shown in Figure 328 .

    _images/image698.PNG

    Figure 327 Appointment detail quick view

_images/image700.PNG

Figure 328 Appointment confirm dialog

Scheduled booking page

Registration view can be configured to show a specific schedule. Therefor visitor can start on Appointment detail views conveniently without selecting the schedule.

Overhead display

The overhead display page is using to show the current appointment numbers of the schedule. It can be configured to the selected schedule. Once configured, the page will appear in the client and start to show the appointment numbers for current in-progress or to be started schedules. Once the Appointment completion status changed as completed, cancelled or back to original, the view will update the appointment number automatically every 10 seconds.

_images/image702.PNG

Figure 329 Overhead display view

  1. Schedule name

  2. Schedule location

  3. Schedule start and end time

  4. Current in-progress appointment number

  5. Next appointment number list

  6. Current date

  7. Current time