Config Search Dashboard Tool

The Config Search Dashboard tool enables Creators to locate specific configuration values in their applications and modules. These values may include a Property ID of a Panel component or the Canvas Label Text of a Decisions component. More precisely, the tool facilitates searches in JSON values.

This functionality is particularly useful when updating values shared across multiple applications and modules. By submitting a search request, the tool generates a comprehensive list of all module components containing the specified value. The resulting report serves as a checklist, streamlining the update process and eliminating the need to manually inspect each module.

Accessing the Config Search Tool

To access the Config Search Dashboard tool, navigate to your environment, click on Resources, and select UDLC Toolkit:

A static image displaying the Resources section of the UDesigner to access the UDLC Toolkit.

Under the Build and Test section of the UDLC Toolkit, locate the Search Config tool and click on the Use this tool button:

A static image displaying the Config Search Tool option in the UDLC Toolkit.

Submitting a Config Search Request

To initiate a search, select the location to query. The available options include:

Specific Applications: Displays the Applications drop-down menu, letting you select one or more applications in your environment.
Specific Modules: Displays the Modules drop-down menu, letting you select one or more modules in your environment.

Search Scope

The Config Search Dashboard tool exclusively searches JSON values associated with components. These values typically represent data manually entered during component configuration. The tool does not support searches for system settings or submission data.

Examples of searchable values include:

Property IDs
Labels
Email addresses
Input values
Output values
URLs

Entering Search Values

You can enter one or more values in the search field. When entering multiple values, they must be separated by a line break. Doing so ensures that all values are organized into a single, structured list.

Here’s an example of searching for Label Text values:

First Name
Last Name
Email Address

The image below shows you how to format your values:

After making your selections, click Submit and OK in the pop-up modal. Another pop-up modal displays your Request Number. This value is an internal ticket number so Unqork can track the request.

Viewing Your Config Search Report

After submitting a request, you'll receive an email with an attached spreadsheet called Config Search {your-environment} {timestamp in UTC}.xlsx. This spreadsheet is your search report.

To view your report:

Click the attachment's link in the email.
Check your Downloads folder for the .xlsx file.
Open the file in Microsoft Excel or Google Drive.

When you open the spreadsheet, you'll see three tabs at the bottom of the worksheet:

Index
Summary
customSearch

Here's an example of a typical Config Search Report:

Let's look at the information you'll receive from each tab.

Index Tab

Summary Tab

customSearch Tab

This tab gives you details of the customSearch operation the tool runs on your applications and modules. These are the columns you'll see in this tab:

Attribute	Description
Test	The test the tool ran. It'll always be `customSearch`.
Severity	The test's severity. For the `customSearch` test, the severity is Informational.
Test Description	A brief description of what the test does.
Action Item	Here you'll find more search suggestions if the test did not return the information you wanted. Following these suggestions ensures you're using the Config Search tool correctly.
Overview	A general description of the test and its purpose.
Columns Explanation	The specific operation of the tool and the format you'll see in the customSearch tab for the values you searched. In the example image above, the test runs a reference (`_REF`) operation. This operation looks for a match between the values you entered and the ones in your environment. The result is either a Boolean of true or false.

The Summary tab provides the number of times the test found a match. The three columns displayed are:

Test
Severity
Results Count

This tab displays the most details of your search. Here you'll see all the applications, modules, and components included in your searched value(s). You'll see the following columns in this tab:

Attribute	Description
Application ID	The unique identifier of the application whose value(s) matched your search.
Application Name	The unique name of that application.
Module ID	The unique identifier of the module whose value(s) matched your search.
Module Name	The unique name of that module.
Label	The Label Text or Canvas Label Text of the module's component.
Component	A module's component whose value(s) matched your search.
_REF	The value you searched. Each value has its own column. If a match exists for that value, a Boolean of true displays for each matching application and module. The format you'll see in the column heading is the following: `/{VALUE-SEARCHED}/_REF`.
Modified time (UTC)	The timestamp of the last change made to the application or module. Time is measured in UTC (Coordinated Universal Time).
Ancestors	The ancestors of the module's component.