Web application properties
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:
Properties
Property | Description |
AcceptedDomains | The list of domains that this application accepts. Click the More menu to add domains. An empty list means that all domains are accepted. |
BrowserType | Set to the browser you are using to automate the web application.
Choices are:
|
BrowserStartMethod | Use the StartMethod property to define how the Path application
is started. Your options are:
Stopping the project stops all application instances with which Robot Studio is interacting. |
BrowserStopMethod | Use this property to determine what stops in the browser when the adapter stops. You can choose from these options:
|
StartOnProjectStart | Sets whether or not the application should start when the project runs. |
StartPage | The URL for the web application. |
Credentials | Set the application credentials for assisted sign-on. Click the More menu to open the Credential Collection Editor and add credential properties. |
FriendlyName | The friendly name of the application that displays for users in StartMyDay. |
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. |
ReadyForRobotWork | 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.”:
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. |
AdditionalArgument | The additional command-line arguments to pass to the browser. |
AdvancedConfiguration | Advanced options that should only be used when directed by Support. |
ApplyTimeoutToAllControls | Specifies if the ControlTimeout value should be used for all controls. |
ControlTimeout | Specifies the amount of time in milliseconds to wait before timing out, if ApplyTimeoutToAllControls is set to True. |
EdgeConfiguration | The Edge-specific configuration properties. |
ElectronConfiguration | The Electron-specific configuration properties. Click the plus
menu to define the Path, TargetPath, and WorkingDirectory
properties:
|
EnableRuntimeSelfHealing | If X-ray Vision is disabled, it does not assigne PegaIDs to new controls and disables attribute change detection at runtime. |
EnableX-rayVision | 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. |
FullName | Gets the fully qualified name of the application or control. |
IsStartStoppable | 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
|
ReasonAdapterNotReady | Use this property to display a message that describes why the robot could not perform the work. |
Sensitive | Set to true if this control has sensitive values that should be masked in design blocks and logs. For more information, see Sensitive data. |
StartMyDayControls | Indicates which controls are used by the StartMyDay component to locate the application using the following methods:
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. |
StartTimeout | Sets the interval, in milliseconds, that the adapter waits for the application to start before Robot Studio issues a timeout message. |
UniqueId | Indicates the unique identifier of the adapter object. |
UnmatchOnZeroLocationAndSize | Sets whether the adapter should unmatch controls that have zero height and width and are at postion 0,0. |
Previous topic General Web properties, methods, and events Next topic General Web component properties