Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Pega search API

Updated on August 25, 2021

Search functionality in Pega Platform provides the option to find specific information within your application. For example, in a healthcare application, you can search for Jones AND vaccine to retrieve results about all people named Jones who received a vaccine.

Each search gadget in Pega Platform uses the pxRetrieveSearchData activity to query the database in search of specific results. You can restrict the search results by customizing several parameters of the activity that the system then uses to invoke the activity.

Domain Specific Language

The search API in Pega Platform uses a specific language, which the system uses to determine what results to retrieve. For example, the pxRetrieveSearchData activity supports boosting settings that prioritize particular words during a search. In a car rental application, you can enter white^2 cars to make the white word more relevant than cars. The system then prioritizes the retrieval of results about white cars.

Search functionality in Pega Platform does not match accented words with unaccented. For example, if you search for santé and sante, the system retrieves different results.

Domain Specific Language (DSL) includes special characters that you can use when searching, for example '-', '_', '!', '@'. However, the system retrieves various results depending on the way you use special characters in the search query. If your query contains special characters that are not escaped, the system may retrieve incorrect results. For example, if you do not escape the slash mark in the 25/02 query, the system may ignore the special character.

Fuzzy search

You can also use fuzziness, which provides the option to include results similar to the results requested. For example, depending on specific parameters, when you search for the word setting, the system displays results that contain the word sitting.

  • Using the search API

    Find the information you need within your application by using the search API. For example, in your banking application, you can customize the pxRetrieveSearchData activity to retrieve all results that include the word overdue, to analyze the list of pending payments.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us