Lead list filter

Configure lead list filters through JSON.

How to (for web app)

Log in to Vymo web app.
Go to Module Settings.
Select a module for which you want configure or edit lead list.
Navigate voListDashboardMappings > expand voListDashboardMappings > columnMappings.

Set appropriate values for the given keys to configure lead list columns and filters.

{
  "type": "vo-system-column",
  "disabled": false,
  "order": null,
  "title": "Regions",
  "visible": false,
  "sortable": true,
  "group": "1",
  "export": false,
  "columnType": "region",
  "field": "regions",
  "queryField": null,
 "filter": true
}

Click Save. You see a message that the changes are now saved as a draft.
In the message box, click Go To Release Management so that you can move the changes permanently to the live configuration.
Click Create a UAT release. Specify the release details and make sure to enter your own email ID because that's where you receive a one-time password (OTP) to continue with the process. Click Proceed.
Enter the OTP you received in the email, and click Submit. Wait for a while till you see a confirmation message saying the process is complete.
To see the changes, log out and log in again.

Configure through Global Settings (Alternative way)

Log in to Vymo web app.
Go to Global Settings > Custom Configuration > additionalconfigs.
Expand additionalconfigs > dashboard_configs > leads > columns. If you don't find these attributes under dashboard configs then create them
Collapse each object of the list to access further keys. If you don't find any keys then add the following attributes.
- The disabled key determines the enabling and disabling of the field. Set it to true to disable it and false to enable it.
- The title key determines the field on lead list filter.
- The filter key determines the visibility of the field on the filter panel. Set the filter key to true under each object to enable the field on filter panel. To disable, set it to false.
- The visible key determines the visibility of the field on the columns of lead list page and not the lead list filter panel. Set the value of visible key to true or false based on your requirements.
```
{
  "disabled": false,
  "title": "Regions",
  "visible": false,
  "sortable": true,
 "group": "1",
 "export": false,
 "type": "region",
 "field": "regions",
"filter": true
}
```
Click Save. You see a message that the changes are now saved as a draft.
In the message box, click Go To Release Management so that you can move the changes permanently to the live configuration.
Click Create a UAT release. Specify the release details and make sure to enter your own email ID because that's where you receive a one-time password (OTP) to continue with the process. Click Proceed.
Enter the OTP you received in the email, and click Submit. Wait for a while till you see a confirmation message saying the process is complete.
To see the changes, log out and log in again.

Results (for web app)

Log in to Vymo web app
Go to Leads > Leads List.
Check if the column changes appear on the lead list page.
Click the filter button located on the top right to check the changes made.

lead list

How to (for mobile app)

Log in to Vymo web app.
Go to Global Settings > Custom Configuration > additionalconfigs.
Expand additionalconfigs > leads_list_filters_v2.
If you don't find leads_list_filtersv2, add it.
Add objects under leads_list_filtersv2 key.
For each object, add the following parameters. If the following parameters already exist, set their values according to your requirements.
- The code key is unique identifier to the filter.
- The hint key determines the field name on filter.
- The queryExprKey key used for query purpose.
```
{
  "type": "text",
  "code": "name",
  "hint": "Lead Name",
  "queryExprKey": "inputs_map.name",
  "data_type": "text"
}
```
Click Save. You see a message that the changes are now saved as a draft.
In the message box, click Go To Release Management so that you can move the changes permanently to the live configuration.
Click Create a UAT release. Specify the release details and make sure to enter your own email ID because that's where you receive a one-time password (OTP) to continue with the process. Click Proceed.
Enter the OTP you received in the email, and click Submit. Wait for a while till you see a confirmation message saying the process is complete.
To see the changes, log out and log in again.

Results (for mobile app)

Log in to Vymo mobile app
Go to leads card.
Click the filter icon located on top right to see the results.

Lead list filter for mobile

Note

If you cannot locate JSON objects under additionalconfigs, create them.