Property

Descriptions

Return type

AcceptedDomains

Use this property to determine which domains the Universal Web Adapter should recognize. You cannot interrogate any documents you exclude via this filter property, nor will those documents match at run time. The property is a collection of filters, so you can add more than one.

You can filter domains using verbs such as Contains, DoesNotContain, StartsWith, and EndsWith. You can also use full regex features.

Note: The system only considers the domain portion of a document’s path when filtering. The system ignores the scheme (HTTP/HTTPS) and query string (?a=b).

This property is useful for preventing an adapter from processing documents that you do not need to match or interrogate.

Note: If you are running multiple Universal Web Adapters, use the AcceptedDomains property to set up a filter on all the Universal Web Adapters. If you omit domain filtering, two adapters could interrogate, match, and automate the same webpage at the same time.

String

ApplyTimeoutToAllControls

This property, along with the ControlTimeout property, lets you manage time-out intervals for all controls within the adapter. The default is False.

Boolean

BrowserType

Set to Firefox if you are automating a web application using the Firefox browser.  

Set to Chrome if you are automating a web application using the Chrome browser.

Set to Electron if you are automating a web application using the Electron browser. Requires version 19.1.19 or later. For more information, see Automating Electron applications.

String

BrowserStopMethod

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 Universal Web Adapter 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.

String

Context

Indicates the context in which the adapter is loaded. Contexts generally apply to solutions running in a Citrix environment. For more information, see Citrix - Project Items.

String

ControlTimeout

Use this property to specify in milliseconds, the length of the time-out interval for all controls. The default is 30000 (30 seconds). Your entry for this property overrides the Timeout property for interrogated objects within the adapter.

You enable the use of this time-out interval by using the ApplyTimeoutToAllControls property.

Milliseconds

Credentials

This property takes you to the Credential Collection Editor where you can enter credential information that is used by Assisted Sign-On.

DesignTime

Gets a value indicating if the control is a design time control.

Boolean

Extender

Use this property to specify an extender class implemented in a separate DLL for the project. Adapter extender classes implement IAdapterExtender and are able to contribute properties, methods and events to an adapter.

String

FriendlyName

 Enter the name you want the user to see in the Start My Day window.

String

FullName

Gets the fully-qualified name of the adapter item.

String

InvokeRequired

This method applies when the project and adapter are referenced in code by a non-Studio project and is not used in Robot Studio stand-alone projects. For more information on referencing Robot Studio projects see the Robotic Automation product page.

Boolean

InDesign

Gets a value indicating if the control is in design mode.

Boolean

IsRunning

Gets a value that indicates whether the application is running.

Boolean

IsStartStoppable

This property controls how the Robot Studio project reacts when the adapter application has been stopped and then restarted. (For example, the user closed the application and then restarted it.) Your options are:

True – If the application is stopped and then restarted while the project is running, Robot Studio hooks 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 does not attempt to hook the application. The controls within the application are no longer matched and therefore the project's automations/event monitoring which uses 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.

Boolean

IsStopping

Indicates whether the application is in the process of stopping. The IsStopping property returns a True value from the time the Stop method is called until the application is finished stopping.

Boolean

IsSuspended

Gets a value that indicates whether the adapter application execution is suspended.

Boolean

JavaInvoketimeout

Use this property when you are automating Java applications or applets. Enter the number of milliseconds you want the system to wait for the Java UI to respond before timing out.

Note: if you set this option to zero (0), the system will wait forever.

Milliseconds

MonitoredEvents

Note: This option is used with functionality which will be included in a future release.

Use this property to specify the target types and corresponding events for which event notifications are generated. Browse this property to open the Configure Monitored Events dialog for selection of the target types and events associated with each selected target type for which notifications are generated. For more information, see the Events topic.

SelectedEvents

MonitorEventsMode

Note: This option is used with functionality which will be included in a future release.

Use this property to specify the types of application controls for which event notifications are generated. Your options are:

None – No event notifications are generated for the adapter.

All Controls – Event notifications are generated for any application control matching the selected target types and corresponding events. For this mode, you do not need to interrogate individual controls in the application. It is only necessary to interrogate the main application window to allow Robot Studio to integrate the application, and complete the MonitoredEvents property to select the controls (target types) and corresponding events for which event notifications will be generated.

For more information, see the Events topic.

Interrogated Controls – Event notifications are generated only for controls which have been interrogated at design time.  For this mode, you must interrogate the application's controls for which you want to generate event notifications and then use the MonitoredEvents property to select the controls (target types) and corresponding events for which event notifications will be generated.

Note: The Interrogated Controls option, which only sends events for InterrogatedControls, is not applicable to web adapters.

String

Name

Use this property to get or set the name assigned to the adapter.

String

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.”:

Robot not ready. Cannot access applications.

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

Boolean

ReasonRobotNotReady

Use this property to display a message that describes why the robot could not perform the work.

String

StartMethod

Use 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.

There are three scenarios which can occur when you start the Chrome Universal Web Adapter:

• If you set the StartMethod property to Start, when a Chrome Universal Web Adapter starts a new Chrome window is displayed and goes to the page you specified in the StartPage property. If Chrome was not running, the system starts it.

• If you set the StartMethod property to MonitorAll, the adapter starts, but no new Chrome windows or tabs are created, nor is Chrome started.

• If Chrome is already running when you start the adapter, the adapter processes all top-level documents, based on the way you set up the AcceptedDomains property.

If you set the adapter to Start, it will not stop until all Chrome processes are closed.

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.

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

String

StartMyDayControls

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

• OrganizeApplication

• OrganizeDesktop

• 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.

String

StartOnProjectStart

Sets whether or not the adapter should start when the project runs. For more information, see  StartMethod Property and StartOnProjectStart.

Boolean

StartPage

The URL for the web application.

String

StartTimeout

Sets the number of milliseconds the adapter waits for the application to start before Robot Studio issues a time-out message.

Milliseconds

This

A reference to the adapter object.

String

UniqueId

Indicates the unique identifier of the adapter object.

String

WPFIdleTimeout

Use this property when automating .NET Windows Presentation Foundation (WPF) applications. Here you can set the amount of time before the WPF UI becomes idle and is processed. Set this property to zero (0) to disable the idle timer.

Milliseconds

Methods

Description

Parameters

Return type

ActivateTab

(version 19.1.14 or later)

Sets the control’s tab as the active tab.  Use this method on page-level controls and below. This method activates the tab and sets it as the visible tab.

This method does not bring the browser window to the front.

None

Void

AddBuildReference

This method applies when the project and adapter are referenced in code by a non-Studio project and is not used in Robot Studio stand-alone projects. For more information on referencing Robot Studio projects, see the Robotic Automation product page.

String reference

Void

AddFileReference

Use this method to add a file to use as a reference for the Robot Studio adapter.

String reference

Void

BeginInvoke

This method applies when the project and adapter are referenced in code by a non-Studio project and is not used in Robot Studio stand-alone projects. For more information on referencing Robot Studio projects, see the Robotic Automation product page.

Delegate method, Object[] args

IAsyncResult

ContainsProcess

Use this method to find out if the process ID you specify is being  monitored by the adapter.

int32 processID

Boolean

EndInvoke

This method applies when the project and adapter are referenced in code by a non-Studio project and is not used in Robot Studio stand-alone projects. For more information on referencing Robot Studio projects, see the Robotic Automation product page.

IAsyncResult result

Object

GetSelectedReparented
Window

This method applies when the project and adapter are referenced in code by a non-Studio project and is not used in Robot Studio stand-alone projects. For more information on referencing Robot Studio projects, see the Robotic Automation product page.

None

IntPtr

Invoke

This method applies when the project and adapter are referenced in code by a non-Studio project and is not used in Robot Studio stand-alone projects. For more information on referencing Robot Studio projects, see Creating CSharp to Studio project references.

Delegate method, Object[] args

Object

Navigate
(1 parameter)

Use this method to have the currently focused tab go to the URL that you specify.

Sting URL

Void

Navigate
(1 parameter)

Use this method to have the currently focused tab go to the URI that you specify.

URI URL

Void

Navigate
(2 parameters)

Use this method to open a new  tab and go to the URL that you specify.

String URL, Boolean newWindow

Void

Navigate
(2 parameters)

Use this method to open a new  tab and go to the URI that you specify.

URI URL, Boolean newWindow

Void

Navigate
(2 parameters)

With this method, you have the following options.

• Default – Navigates the currently focused tab to the URL that you specify.

• NewWindow – Opens a new window and goes to the URL that you specify.

• NewTab – Opens a new tab and goes to the URL that you specify.

• NewBackgroundTab – Opens a new tab in the background and goes to the URL that you specify.

String URL, NavigateOption option   

Void

Navigate
(2 parameters)

With this method, you have the following options.

• Default – Navigates the currently focused tab to the URI that you specify.

• NewWindow – Opens a new window and goes to the URI that you specify.

• NewTab – Opens a new tab and goes to the URI that you specify.

• NewBackgroundTab – Opens a new tab in the background and goes to the URI that you specify.

URI URL, NavigateOption option   

Void

RematchChildren

Refreshes matching on all objects under the adapter. Set the detach property to True to unmatch all targets before attempting to rematch.

Boolean detach

Void

ResetState

Resets all component properties to their initial values.

None

Void

SendKeys

(version 19.1.14 or later)

Activates the tab of the control that the method is called on and then sends a key sequence to the control. This method also brings the browser window to the front. Use this method on page-level controls and below.

Only use the SendKeys method for unattended robotic process automations because user intervention could interrupt the key sequence being sent.

When you call the SendKeys method at the page level, the control that currently has focus receives the key sequence.

Note: The address bar cannot have focus (clicked in) when you execute the SendKeys method for the Universal Web Adapter.

For more information, see SendKeys method.

String keys

Void

SetPropertyDescriptor

(version 19.1.90 or later)

Start

Starts the application.

None

Void

Stop

Stops the associated process (and all child processes). Robot Studio uses the adapter's StopMethod property setting to determine how the Stop method is executed.

None

Void

Events

Description

AdapterLostFocus

Occurs whenever focus changes from any of the application windows to another application window (running under a different adapter or any other application on the desktop). Once the event is triggered, a Duration event argument is calculated which tallies the amount of time (in milliseconds) that the application was in focus. Use the AdapterLostFocus event with Robot  Studio's Event's feature in Generic and Custom events projects and/or directly in project automations. You can use the AdapterLostFocus event with Java, Remedy Forms, Oracle Forms, and SAP GUI applications.

Note: When monitoring focus of a web application, the AdapterLostFocus event is not raised when changing or creating browser tabs, such as when running in Internet Explorer 7, since changing tabs does not remove focus from the web adapter. However, if the Windows Live toolbar (prior to version 14) is installed, changing or creating tabs can cause the AdapterLostFocus event to be raised.  

For more information, see Adapter events.

ExceptionThrown

Occurs when an exception is raised by the adapter application.

Occurs when the application state changes between ready and not ready.

RobotNotReadyForWork

Occurs when the ReadyForRobotWork property is set to False to indicate that the robot is not ready to perform work.

Started

Occurs when the application is started.

Starting

Occurs when the application is starting.

Stopped

Occurs when the application exits.

Stopping

Occurs before Stop is called on the application.

Terminated

Occurs when application is terminated.