[//]: # "---"
[//]: # "title: Name Matching Evaluation"
[//]: # "description: Name Matching Evaluation"
[//]: # "path: /documentation/name-matching"
[//]: # "---"

The **Name Matching Evaluation** module allows you to evaluate the accuracy and consistency of your Responder’s name matching logic across personal and business account types in line with EPC Name Matching guidelines.

By creating a test plan, you can **validate whether the Responder's system is handling close matches correctly** based on its **configured Levenshtein Distance thresholds**. This ensures that the matching behaviour aligns with the responder’s own configuration and complies with EPC VOP standards. After analysing the test results, you can choose to **refine your matching logic** to better align with industry best practices or **retain your existing implementation** if it already meets your requirements.

This module allows users to assess the **accuracy and completeness** of their name matching algorithm by comparing it against **widely accepted industry standards**. It tests for various matching techniques, including:

- **Levenshtein Distance**
- **Data cleansing** (e.g., removing special characters, business descriptors, honorifics)
- **Truncated or partial names**
- And other common name-matching scenarios

#### Create the Test Plan

1. Navigate to **Name Matching Evaluation** from the sidebar.
2. Click **Create Test Request**.

<img src="/docs/media/nameMatching/step1.jpg">

3. Enter a unique name for the test plan.
4. The **Test Plan field** is pre-filled as _VOP_NAME_MATCHING_.
5. Enter the endpoint for your Responder service.
6. Add a description for the test plan.
7. Under the Accounts section, select the account types of your Responder supports:

<img src="/docs/media/nameMatching/step2.jpg">

<ol type="a" style="padding-left:60px; position: relative; top: -10px; margin:0">
 <li>Personal</li>
 <li>Business</li>
</ol>

You may select one or both, depending on your system’s capabilities.

8. Under **Levenshtein Distance Settings**, specify thresholds that define how tolerant your system is to character-level differences between names. These thresholds for names in your name matching algorithm implementation

<ol type="a" style="padding-left:60px; position: relative; top: -10px; margin:0">
 <li>Personal Accounts
 <ol type="I" style="padding-left:60px;">
 <li>Set threshold for Last Name</li>
 <li>Set threshold for First Name</li>
 </ol>
 </li>
 <li>Business Accounts
 <ol type="I" style="padding-left:60px;">
 <li>Set threshold for Business Name</li>
 </ol>
 </li>
</ol>

9. If you want to automate the test execution:

<ol type="a" style="padding-left:60px; position: relative; top: -10px; margin:0">
 <li>Toggle Schedule Test Plan</li>
 <li>Configure the desired schedule interval</li>
</ol>

<img src="/docs/media/nameMatching/step3.jpg">

10. Once you’ve configured the test plan:

<ol type="a" style="padding-left:60px; position: relative; top: -10px; margin:0">
 <li>Click Run Test Plan to execute the test immediately (if no schedule is set). If you've enabled scheduling, the Run Test Plan button is replaced with Schedule Test Plan, allowing you to automate test execution at a defined frequency and time.></li>
 <li>Click Saveto store the test configuration for future use</li>
</ol>

#### Filter Test Plans

You can quickly find test plans using the **search** and **filter** functionality:

<img src="/docs/media/nameMatching/step4.jpg">

- **Search by Test ID or Name** using the search bar.
- Filter by **Test Result** (Passed, Failed, Pending, NA).
- Filter by **Date** using the date picker.
- Click **Clear** to reset all filters and view the complete list.

View Test Plan Report

You can **view the test plan report** by clicking the **eye icon** next to any test entry in the summary table.

<img src="/docs/media/nameMatching/step5.jpg">

This will open the **Test Details page**, which serves as the report dashboard for that specific test plan.

<img src="/docs/media/nameMatching/step6.jpg">

The Test Details page includes the following details about the test plan:

- **Test Analytics**: A visual donut chart summarizing the count of tests that passed, failed, or were skipped.
- **Test Metadata**: Key details like Test ID, Name, Description, Type (e.g., Sanity), and associated Services.
- **Execution Details**: Includes start and end timestamps for test execution.

**Available Actions:**

- **Clone Test Plan**: Duplicate the test plan for quick re-execution with the same configuration.

<img src="/docs/media/nameMatching/step7.jpg">

- **Download Report**: Download the report.

<img src="/docs/media/nameMatching/step8.jpg">

- **View Full Report**: Navigate to a detailed breakdown of each test case, including request/response payloads and validation results.

<img src="/docs/media/nameMatching/step9.jpg">

- **Scheduler Configuration**: Schedule **Test Plan** to run automatically at recurring intervals.

<img src="/docs/media/nameMatching/step10.jpg">

- **Delete Test Plan**: Remove the test plan from the system if it’s no longer needed.

<img src="/docs/media/nameMatching/step11.jpg">

#### Managing Scheduled Jobs

The **Scheduled Jobs** section displays all tests that have been configured to run later, either once or on a recurring basis.

<img src="/docs/media/nameMatching/step12.jpg">

When you schedule a test, it is automatically added to this list. Each job entry includes key details like **Test ID, Name, Frequency, Next Scheduled Time, and Status**.

<img src="/docs/media/nameMatching/step13.jpg">

From this section, you can:

- **Enable or disable** jobs using the toggle switch.
- **Edit** job details such as test configuration, name, or frequency using the edit icon.

Getting Started

Service Management

Conformance Validation

General