Compliance Tool Kit
Search
⌃K

User Guide

This guide will help the partners in using the Compliance Took Kit portal.
Below are simple steps to use this portal:
  1. 1.
    The partners using the compliance tool kit should be registered partners in the system.
  2. 2.
    Login into CTK with the same credentials.
  3. 3.
    Create a project of type SBI / SDK.
  4. 4.
    Create a collection by selecting the test cases that you want to test.
  5. 5.
    Provide the necessary details to connect to your device / SDK service.
  6. 6.
    Execute the Test Run by running the collection.
  7. 7.
    For executing each test case, follow the instructions on the screen.
  8. 8.
    Once the entire collection is run, the results of the number of test cases passed or failed will be displayed.
  9. 9.
    You can see all the Test Run details as well. For example, the request sent to SBI, the response received from SBI, validations performed on the response and the result.
  10. 10.
    Test runs previously executed will be available in the Test Run history.
  11. 11.
    More collections can be created as per the test cases required.

Login

The partners using the compliance tool kit should be registered in the system. Registered partners can log in to the compliance tool kit with the same credentials as they used to register themselves into the Partner Management Portal.
The partner needs to enter the registered username or e-mail and password to log in.
CTK login page

Dashboards

Once the partner logs into the compliance tool kit, they can view the Project Dashboard by default and would have the option to view the Biometric Data Dashboard as well.
  • Project: A project is a module that the partner wants to test. For example, if a device partner has developed a new version of their SBI for the fingerprint slap device, then, they can create a project in the compliance tool kit to verify this version of SBI.
CTK Project Dashboard
  • Biometric Data: As a part of the CTK, there is an option for the partner to upload their test data which can be used to verify the partner’s software. Currently, in MOSIP, we can upload test data for an SDK.
CTK Biometric Data

Project dashboard

Below are the possible activities as part of the Project Dashboard.
  • View all the projects on the dashboard
  • Create a new project
  • View a specific project
  • Archive a project
  • Move to the biometric data dashboard
Let us go through each of them in detail.

View projects

Once the partner logs into the compliance tool kit, they can view all the existing projects in the dashboard.
The project dashboard will display the following attributes of a project:
  • Name of the project
  • Project Type
  • Total number of collections in the project
  • Creation date and time of the project
  • Last time a collection in the project was run
  • Status of the last run on the project
CTK Project Dashboard
The filter option in the dashboard will filter based on the name of the project, project type and the creation date and time.
CTK filter

Create a project

  • On the Projects Dashboard, select the +Add Project button.
  • The page will redirect the partner to the ‘Add a new Project’ page as shown below.
CTK create a Project
  • Enter a unique Project Name and select the Project Type. Currently, MOSIP supports only two types of projects: SBI and SDK
  • Based on the project type selected, the partner needs to enter the mandatory configurations before saving the project.
  • When the project type selected is SBI, the partner needs to provide/select the below configurations:
    • Spec Version: MOSIP SBI specification for which the SBI is built
    • Purpose: The purpose of the device
    • Device Type: The type of device
    • Device SubType: The Subtype of the device
Purpose
Device Type
Device SubType
Registration
Iris
Double
Registration
Iris
Single
Registration
Face
Full Face
Authentication
Finger
Single
Authentication
Finger
Touchless
Authentication
Iris
Single
Authentication
Iris
Double
Authentication
Face
Full Face
  • When the project type selected is SDK, the partner needs to provide the below configurations:
    • Base URL: URL where the SDK is deployed
    • Spec Version: MOSIP SDK specification for which the SDK is built
    • Purpose: Purpose of the SDK
    • Test Data: Input data needed for the run
  • Once the data is entered by the partner, they can click on the Save Project button to save the project.
  • Once the project is saved, a successful message is displayed and a popup appears on the screen which when closed redirects the partner to the project dashboard (home).
Possible values for the Purpose attribute in SDK are:
  • Matcher
  • Check Quality
  • Extract Template
  • Convert Format

Download Encryption Key

  • Once the project is created by the partner, they can download the encryption key.
  • Partner can download encryption key for Auth devices.

View a specific project

Details of a specific project can be viewed
  • By clicking on the name of the project, or,
  • By clicking on the option View in the options section of the project row.
Once you click on the above-mentioned link, you will be redirected to the project details page of the specific project.

Move to the biometric data dashboard

  • Click on the Biometric Data button on the projects dashboard screen.
  • The partner will now navigate to the Biometric Test Data screen where they can add multiple biometric test data files.

Biometric data dashboard

Possible activities as a part of the Biometric Data Dashboard are:
  • View all the biometric data collected on the dashboard
  • Upload new biometric data
  • Download biometric data
  • Delete biometric data
  • Move to the project dashboard

View all the biometric data

To view the biometric test data collection, click on Biometric Data on the Dashboard.
The biometric data dashboard should display the below attributes of a biometric data
  • Name of the biometric data
  • Type of data
  • Purpose of the data
  • The file name of the data
  • Creation date and time of the biometric data
Filter in the dashboard should be able to perform filter based on the name of the biometric data, type, purpose and creation date and time.

Upload new biometric data

  • On the Biometric Test Data page, click +Add Biometric data, it redirects the partner to the Upload Biometrics Test Data screen.
  • Provide a unique name for the biometric data
  • Based on the type selected, the partner needs to enter the respective mandatory details before saving the biometric data.
  • When the project type SDK is selected, the partner needs to provide the below details:
    • Purpose: The purpose of the test (SDK test type)
    • Test Data: The test data is to be uploaded as a ZIP
The Test Data section has two options Browse and Download Sample File.
The Browse button will be the file explorer in the system for the partner to select the test data ZIP to be uploaded.
The Download Sample File button will download a blank ZIP file with instructions in the README of the test case so that the partner can prepare and add biometric test data.

Download test data

  • Once the test data is uploaded to the server it can be downloaded by the partner,
    • Clicking on the name of the biometric data in the biometric data, or,
    • Clicking on the Download Zip in the options menu of the biometric data.

Collections

A collection is a group of test cases selected by the partner for a particular project configuration. Inside a project, they can create multiple collections based on their choice of test cases selected. As part of the collection, they can perform the below activities:
  • Create a collection
  • View a collection
  • Run a collection
  • View the run history of a collection
  • Generate report from a run
  • Archive a collection

Create a collection

  • To create a collection for a project:
    • Navigate to the project details page by clicking on the project name or View option in the options list.
    • Click on the Add Collection button and you will be redirected to the Add Collection screen.
  • Enter a unique name for the collection.
  • Select the test cases to be added to the collection
    • The test cases will be displayed in a tabular format with ID, Name, Description and Validator details.
    • Beside every test case, there will be a check box which needs to be selected by the partner.
  • After selecting the test cases, the partner can click on the “Save Collection” button to save the collection.
  • Once a collection is successfully created, there is a success popup shown and the partner is redirected to the Project details page.
  • Once a collection is created it is displayed on the Collection Dashboard which is available on the Project details page.
Few points to note:
  • A collection cannot be saved if no test cases are selected.
  • A collection name cannot be empty, the partner needs to provide a unique collection name before saving the collection.
  • Every collection row in the dashboard has the option to view the name of the collection, the number of test cases selected as a part of the collection, the creation date, the Last Test Run and the Run history of the collection.

View a collection

Once the partner creates a collection, they can view the collection details by clicking on the collection name.

Run an SBI collection

  • Before running a collection in SBI, the partner needs to connect to a device without which they cannot proceed with testing.
  • The partner should click on the Scan Device button in the Collection Dashboard as shown below.
  • This triggers a scan of all the configured ports in the system where the SBI is connected.
  • If any device connected with an SBI is found, the application asks the partner to select an available port and the device for running the test.
  • If any device is not found, an error popup is displayed to the partner with an option to Scan Again.
  • Once the device is selected, the partner can click on the Save button.
  • After the device is selected and saved in memory, the Run button for the collections is enabled.
  • If a device is already scanned and selected before running the collection, the partner can choose to re-scan and select another device for running the test case.
  • If a device is selected, the partner can click on the Run button to run the test case.
  • If the partner selects a Fingerprint Slap device but the collection is for a Double Iris device, then the test case is not executed. The partner will be shown an error message and asked to re-select the correct device. The combination validated here is for Purpose, Device Type and Sub Type as displayed below.
  • If the correct device is selected and the partner initiates the test run, the test case execution should start.
  • During the test run,
    • A progress bar will be shown with the percentage of tests execution completed
    • A timer to show the time elapsed during the execution
    • Option to close or cancel the test run
    • Option to initiate capture for a test case or resume run after completing the operation.
  • The test run also shows,
    • The total test cases getting executed for that run
    • The current test case name
    • Instructions (if any) for the partner to follow
  • Once the test execution is completed, the partner can see,
    • A high-level result with the number of test cases executed- with the number of test cases failed and the number of test cases passed in the run.
  • The partner can also see the time elapsed
  • They can also view the detailed test run report

Run an SDK collection

Before running the SDK collection, the partner can change the Test Data and the Base URL in the project settings
  • Click the Run button of the specific collection.
  • The application now checks if the URL shared by the partner is accessible or not. If not accessible, the application shows an error message to the partner.
  • Once the run initiates with the proper URL, the execution should complete on its own and during the run, the partner can see:
    • A progress bar with the percentage of test execution completed.
    • A timer to show the time elapsed during the execution.
    • Option to close or cancel the test run.
  • Once the test execution is completed, the partner can see:
    • A high-level result with the number of test cases executed- with the number of test cases failed and the number of test cases passed in the run.
    • They can also see the time elapsed.
    • They also have the option to view the detailed Test Run report.
Note: For a test run, the partner can select their data or MOSIP’s default data. But let us assume that the partner chooses their data, but in the ZIP file, they have missed adding data for a particular test case, then the system should take MOSIP’s data for the test case' execution.

View the run history of the collection

The partner after completing a successful test run can view the detailed run by,
  • Clicking on the View Test Run button once the test execution is completed.
  • Clicking on the View Last Test Run option in the options section of the collection as shown below.
Once the partner selects the View Last Test Run option, the application will redirect the partner to display the test run details as shown.
  • Clicking on the Test Run History option in the options section of the collection and then click on the Details button of the test run that they want to view
Once the partner clicks on Details, it redirects the partner to the test details as shown above.
  • On the Test Run details page, the partner can view:
    • Run date
    • Overall run status
    • Total test cases in the collection
    • Test cases passed
    • Test cases failed
The partner will be able to view the details of any test run they wish.
  • On the Test Run details page, the partner can view,
    • List of the test cases in the collection
    • Test case ID
    • Test case Name
    • Status of the test case (Pass or Failed)
    • Option to view details of the test case
  • The details of the test case contain,
    • The request that was sent
    • The response that was received
    • The detailed status of validators that ran in the test case
Previous
Test Report
Next
How to Guides
Last modified 1mo ago