Skip to main content

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

Web application properties

Updated on October 19, 2022

Web applications have the following properties that can be defined to control how an application works with Pega Robot Studio.

You can access design properties from the Property Grid or in the Application tab of the Application Designer, as shown in the following figure:

Web application properties
Application Designer highlighting Web application properties.


AcceptedDomainsThe list of domains that this application accepts. Click the More menu to add domains. An empty list means that all domains are accepted.
BrowserTypeSet to the browser you are using to automate the web application. Choices are:
  • Chrome
  • Edge
  • Electron
BrowserStartMethodUse the StartMethod property to define how the Path application is started. Your options are:
  • Start: With this option, starting the adapter causes Robot Studio to launch and hook the application defined by the Path property.
  • MonitorAll: MonitorAll is used with the Windows adapter and when automating Electron applications.

Stopping the project stops all application instances with which Robot Studio is interacting.


Use this property to determine what stops in the browser when the adapter stops. You can choose from these options:

  • LeaveRunning: Do not stop any documents, just stop the adapter. Typically, this option is not used.
  • StopBrowser: Shut down the browser entirely. Keep in mind that if you have more than one web application running and you stop the browser, the other adapters will have all of their documents destroyed.
  • StopMatchedDocuments: Stop all documents which the adapter has matched to web page controls.
  • StopTrackedDocuments (default): Stop all documents that the adapter has processed. If you have not set up the AcceptedDomains property, this is equivalent to StopBrowser, since the adapter processes all documents, regardless of whether they matched.
StartOnProjectStartSets whether or not the application should start when the project runs.
StartPageThe URL for the web application.
CredentialsSet the application credentials for assisted sign-on. Click the More menu to open the Credential Collection Editor and add credential properties.
FriendlyNameThe friendly name of the application that displays for users in StartMyDay.

Use this property to specify how this adapter participates in Start My Day functionality. For instance, choose Automatic if you want the adapter to start automatically or Manual if you want the user to start the adapter. The default is None, which indicates the adapter does not participate in Start My Day functionality.

When you choose Automatic or Manual, the StartOnProjectStart property is updated to reflect your choice.


Use this property to control whether an RPA robot receives new work from Robot Manager. If set to True, which is the default, the property indicates that the application is loaded, logged into, and ready for the robot to begin its work.

The heartbeat messages from the robot communicate a Ready/NotReady status to Robot Manager.

If an application fails when processing robot work assignments, change its ReadyForRobotWork value to False and use the ReasonRobotNotReady property to describe the failure.

For example, in Robot Manager you would see a message similar to the following example if ReadyForRobotWork is set to False and ReasonRobotNotReady is set to “Cannot access applications.”:

Robot not ready. Cannot access applications.

If at least one application in the loaded solution is set to not ready, then the robot is not ready and does not request new work assignments from Robot Manager.

AdditionalArgumentThe additional command-line arguments to pass to the browser.
AdvancedConfigurationAdvanced options that should only be used when directed by Support.
ApplyTimeoutToAllControlsSpecifies if the ControlTimeout value should be used for all controls.
ControlTimeoutSpecifies the amount of time in milliseconds to wait before timing out, if ApplyTimeoutToAllControls is set to True.
EdgeConfigurationThe Edge-specific configuration properties.
ElectronConfigurationThe Electron-specific configuration properties. Click the plus menu to define the Path, TargetPath, and WorkingDirectory properties:
  • Path: Full path to Electron application executable or process/script that launches it.
  • Folder: File folder expanded at runtime.
  • ResolvePath: Resolves the fully qualified path of the application. If application path is part of the system environmental path, then the Path property is auto-completed.
  • TargetPath: Full path to the Electron application process that gets launched. Use this when the application process is started by a separate process or script defined in Path property.
  • WorkingDirectory: The directory used to launch the Path property.
EnableRuntimeSelfHealingIf X-ray Vision is disabled, it does not assigne PegaIDs to new controls and disables attribute change detection at runtime.

Set this property to True to enable the X-ray Vision feature. (The default is True.)

X-ray Vision automatically identifies controls in the application that you are automating. As you interrogate an application, if new controls become available when you navigate through the application, or a screen change makes new controls appear, Robot Studio adds the new controls to the X-ray database file and assigns a PegaId to each control.

This numeric PegaId serves as the match rule for the control in your automation. For more information, see X-ray Vision.

FullNameGets the fully qualified name of the application or control.

Controls how the project reacts when the application has been stopped and then restarted, such as when the user closes the application and then restarts it. Your options are:ul

  • True: If the application is stopped and then restarted while the project is running, Robot Studio will hook the application again so that automations or event monitoring can continue.
  • False: If the application is stopped and then restarted while the project is running, Robot Studio will not attempt to hook the application. The controls within the application will no longer be matched and therefore the project's automations/event monitoring that use the application's controls will fail. The adapter's Start method will not restart the application. You must stop and start the project for Robot Studio to hook the application again.
ReasonAdapterNotReadyUse this property to display a message that describes why the robot could not perform the work.
SensitiveSet to true if this control has sensitive values that should be masked in design blocks and logs. For more information, see Sensitive data.

Indicates which controls are used by the StartMyDay component to locate the application using the following methods:

  • OrganizeApplication
  • GetApplicationPositionAndSize
  • SetApplicationPositionAndSize

The system lists eligible interrogated controls in the Collection dialog. Select all windows, web pages, or screens that are required to locate the application for the StartMyDay component.

Note: If there is no matching StartMyDayControl available when an Organizing method is called, the application is not affected.

StartTimeoutSets the interval, in milliseconds, that the adapter waits for the application to start before Robot Studio issues a timeout message.
UniqueIdIndicates the unique identifier of the adapter object.
UnmatchOnZeroLocationAndSizeSets whether the adapter should unmatch controls that have zero height and width and are at postion 0,0.

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