Skip to main content

Match Rule types

Suggest edit Updated on November 10, 2021

This tables shows most of the standard match rules applied to common application web and Windows objects.

Note: Most match rules are named based on the object's property used for matching.

Match ruleMatched objectDescriptions
Native Control Name Match Rule.NET objects

Used along with the .NET Class Name and Window Text match rule to match .NET application objects such as windows, buttons, text boxes, check boxes, and so on. The main property for this match rule is:

ControlName – Gets or sets the .NET Control Name for the match rule. For example, the CRM Login button has .NET Control Name: btnLogin.

Control Type Match Rule.NET objects

Used along with the .NET Class Name and Window Text match rule to match .NET application objects such as windows, buttons, text boxes, check boxes, and so on. The main property for this match rule is:

Control – Gets or sets the .NET Control Type for the match rule.

Virtual Class Name Match Rule.NET objects

Used to match .NET objects based on the classname. The main property for this match rule is:

DotNetClassName – Gets or sets the Class Name for the match rule. For example, the CRM Login button uses this match rule with the DotNetClassName of "BUTTON”.

Virtual ID Match RuleWindows objects

Default match rule used along with the Window Class Name and Window Text match rule to match Microsoft Windows application objects such as Windows, buttons, text boxes, check boxes, and so on. This match rule is used by Studio if a dialog ID is assigned to the target (other than the hWnd value). The main property for this match rule is:

ControlId – Gets or sets the dialog ID for the match rule. For example, ControlID for the M+button in the Calc.exe is "116”.

Virtual Class Name Match RuleWindows objects Used to match Windows objects based on their ClassName property.
Sequence Match RuleWindows objects Used to match windows controls based on the order in which they are created in the application, as represented by the CreateSequence property.
Size Match RuleWeb input controlsUsed to match input type web objects based on the Size property.
Text Match RuleWindows objects

The Window Text Match Rule is the default match rule used to match window objects: main application Windows as well as MDI Child Windows. The main properties of this match rule are:

IgnoreCase – Boolean. The default is False. Set to True of the window title text can appear in either upper- or lowercase.

Mode: Default Simple – Text matched literally. Regex mode indicates that the Text property contains Regex syntax. Other modes include StartsWith, EndsWith, Wildcard, IsNotSimple, DoesNotContain, DoesNotStartWith, DoesNotEndWith, IsNotRegex, and IsNotWildcard. The Wildcard mode supports the use of an asterisk to specify variable parts of words.

Text – Text used by the match rule to match the text that is displayed in the title bar of the window. For the sample CRM.exe application, the Login Window Text is Login.

Culture – You can set a culture that is used for text comparisons. By default, the match rule will use the local user’s culture. You can, however, set this property to a specific culture or an invariant culture used for comparisons.

Anchor Name Match RuleHTML links Used to match links based on the Name property of the link.
Anchor Target Match Rule HTML links Used to match links based on the Target property.
Attribute Value Match Rule Web objects Used to match web objects based on the value of a property which you designate in the Attribute property of the match rule. For example, to match based on the OuterText of a link, select this match rule and set the Attribute property to OuterText. Next specify the text corresponding to the OuterText in the Text property of the match rule.
Base Window Class Match Rule Windows objects Used when the Control ID or Control Name (.NET) and Window Text match rules do not uniquely identify any of the following targets:
  • Buttons
  • Check boxes
  • Group boxes
  • Radio buttons
Control Children Match Rule Any object

Used to the target object is based on matching another, related object.

Label Match RuleJava

Lets you match a control based on a label near it. This match rule has four properties it uses to match:

Location – Where the label is relative to the text box; to its left or its right, and so on.

SearchLabelsOnly – Change this to False if you want to match the text box based on a nearby control, such as a button.

Text – The text of the label you are using to match the text box.

Tolerance – The size of the gap between the label and text box.

For example, suppose an empty text box has a label to the right of it with text Firstname. You should interrogate both the control you want to match (the empty text box) and also the control you are using to match it (the Firstname label). This makes sure all necessary class files will be included in the deployment package.

This match rule only tries to match controls that have targets created. Java only creates targets for those controls which have class files included in the deployment package. For best results, interrogate the control you are trying to use in the LabelMatchRule or VirtualControlLabelMatchRule.

Document Title Match Rule Web pages

Used to match webpages based on the Title property for the page. You can broaden the match by modifying the Text parameter for the match rule.

Element ID Match Rule Web objects

A web developer can assign ID to elements and then insert them into the document tree for quicker querying of the DOM. This is the fastest way of matching for Studio, however, one of the biggest issues is when the developer of the web application did not assign unique IDs or leaves them blank.

  • If you delete an ElementID match rule, make sure the UseElementId property for that object is set to False.
  • When you use the Element ID match rule, it should be the only match rule added to that object.
Element Index Match Rule Web objects

Used to match web objects based on their relative position on a web page, in relation to other elements of the same type. The first web object of a type on a form has an index of zero (0), the second has an index of one (1), and so on.

If a control is defined within a TableSection, then the element index is relative to other elements of the same type contained in the same TableSection.

Note: The Element Index match rule relies on the parent control being matched. Therefore, it cannot be used with the Control Children match rule since the parent is not matched.

Element Inner Text Match Rule Web objects Used to match web objects based on the value of the InnerText property.
Element Path Match Rule Web objects Used to match web objects based on the Element Path which is a string array containing the HTML codes surrounding the object.
Form Action Match Rule Web forms Used to match HTML forms based on the Action property of the form.
Form Method Match Rule Web forms Used to match HTML forms based on the Method property of the form.
Form Name Match Rule Web forms Used to match HTML forms based on the Name property of the form.
Form Target Match Rule Web forms Used to match HTML forms based on the Target property of the form.
Image Button Alternate Text Match Rule Web buttons Used to match web buttons based on the Alternate Text property. For more information, see Match Rule Editor.
Image Button Source Match Rule Web buttons Used to match web buttons based on the URL for the source image for the button.
Input Index Match Rule Web input controls Used to match Input type web objects based on their relative position on a web form. The first Input web object on a form has an index of zero (0), the second Input on a form has an index of one (1), and so on.
Input Name Match Rule Web input controls Used to match input type web objects based on the HTML Name property.
Input Size Match Rule Web input controls Used to match input type web objects based on the Size property.
Input Text Match Rule Web input controls Used to match input type web objects based on the input Value property.
Input Type Match Rule Web input controls Used to match input type web objects based on the Type property. For example, for a text box, the Type is Text and therefore the Input Type match rule will match on a Type value of Text for the text box.
Menu Item ID Match Rule Windows menu options Used to match menu options based on the MenuItemID property.
Menu Item Path Match Rule Windows menu options Used to match menu options based on the Path property. For example: View/Comments Ctrl+M.
MFC Window Class Name Match Rule Windows objects

Default match rule used to match applications which MFC classes. Matching is based on the MFC Class as identified by the AFX parameter:

AfxStyle – A number which represents the class name. For example, 8 (for the ClarifyCRM-Clear Support window).

Position Match Rule Windows objects Used to match Windows application objects based on the Left property (X) and the Top property (Y) within the application.
Process Name Match Rule Process objects Used to match processes based on the Process Name as listed in Task Manager.
Process Command Line Match Rule Process objects Used with Java applications. Lets you select a process based on the attributes with which the process is launched.
Table Border Match Rule HTML tables Used to match HTML tables based on Border property value.
Table Cell Column Index Match Rule HTML table cells Used to match cells in HTML tables based on the column index value of the cell.
Table Cell Height Match Rule HTML table cells Used to match cells in HTML tables based on the height of the cell.
Table Cell Padding Match Rule HTML tables Used to match HTML tables based on the CellPadding property.
Table Cell Row Column Match Rule HTML table cells Used to match cells in HTML tables based on the index of the cell's row and the index of the cell’s column.
Table Cell Row Index Match Rule HTML table cells Used to match cells in HTML tables based on the index of the cell's row.
Table Cell Spacing Match Rule HTML tables Used to match HTML tables based on the CellSpacing property value.
Table Cell Width Match Rule HTML table cells Used to match cells in HTML tables based on the width of the cell.
Table Height Match Rule HTML tables Used to match HTML tables based on the Height property value.
Table Schema Match Rule HTML tables Used to match HTML tables based on the schema.
Table Section Row Match Rule Web objects, HTML tables, HTML table cells Used to match HTML elements contained in a row within a table designed by the HTML Table Designer. This match rule is created when interrogating a control that is contained within a Table Section.
Table Width Match Rule HTML tables Used to match HTML tables based on the Width property value.
Tool Bar Button ID Match Rule Windows toolbar buttons Used to match a button target based on the button ID.
URI Match Rule Web objects Used to match the URI of a webpage.
Window Class Name Match Rule Windows controls

Used to match Microsoft Windows application objects such as text boxes, buttons and so on. The main property for this match rule is:

ClassName – Gets or sets the Class Name for the Match Rule. Example Class Name for Calc.exe in scientific mode is "SciCalc”.

Window Create Sequence Match Rule Windows objects Used to match windows controls based on the order in which they are created in the application, as represented by the CreateSequence property.
Window Style Match Rule Windows objects

Default match rule used along with the Window Class Name match rule to match Microsoft Windows controls – not otherwise specified (such as Control objects). The main property for this match rule is:

Type – Gets or sets the Window Style for the match rule. The options are: Child, Form, Dialog, MDI Child.

Did you find this content helpful? YesNo

Have a question? Get answers now.

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

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us