Skip to main content

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

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Test ID and Tour ID for unique identification of UI elements

Updated on August 9, 2017

The Test ID property supports automated testing and enables you to write dependable automated tests against any Pega application. By including this unique identifier in your automated testing, you ensure a higher level of productivity and reliability within your applications.

When you create a control that supports Test ID, the Test ID field is initially blank. You can either enter custom text of your own or click the Generate ID button to have a unique ID created for you. When you save an existing section, any controls that support Test ID but do not have a Test ID will have one automatically generated. You can override these Test IDs with a custom ID at a later time.

Test ID field in the Cell Properties panel

Test ID field in the Cell Properties panel

After the Test ID is generated, you can view your Test ID in HTML. And with the new Live UI tool, you can also view Test IDs at run time for a specific element within the Live UI info panel. For more information, see Using the Live UI tool.

Using the Test ID during product testing gives you the ability to identify your unique string of characters in a simple and consistent manner. For example, you might compare an application's assistive technologies by creating a unique ID called assistive_select that tests the performance of a radio button and a check box control.

Optionally, you can have all controls that support Test IDs in a ruleset updated in bulk.

You can create a guided tour to highlight key features of user forms and portals. The guided tour provides users with information, instructions, or controls in a sequence of pop-up windows called tour stops. For example, you might want to create guided tours that instruct users how to create a case or how to personalize their dashboards. For each UI element where you want to anchor a tour stop, click the Gear icon to open the properties, and enter a Tour ID value.

Both Test IDs and Tour IDs are supported in the following types of controls:

  • Autocomplete
  • Button
  • Check box
  • Date time
  • Drop-down
  • Formatted text
  • Icon
  • Label
  • Link
  • Radio button
  • Text area
  • Text input

Test IDs are supported in the following controls:

  • Grid
  • Hidden text
  • Tree
  • Tree grid

Tour IDs are supported in:

  • Dynamic layouts

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