Web Adapter Properties, Methods, and Events

The web adapter has the following properties, methods, and events. You can access design properties from the Properties Grid. Access all other properties, methods, and events directly from Object Explorer or by using the Configure Type option.

 

Properties

Property

Descriptions

Return Type

AddressBarVisible

This property applies to the Address Bar on the Internet Explorer application window running in OpenSpan projects. You can set the property to have the Address Bar displayed (set to True) or not displayed (set to False). The property can be set either at design time (using the Properties Grid) or through an automation while the project is running.

Note: You can also get the value of this property and use it in automations as required by your project.

Boolean

ApplyTimeoutToAllControls

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

Boolean

BrowserBitness

The default is Only32-bit. You can select 32- or 64-bit for target browser, inclusive or exclusive.

String

CloseTimeout

This property is used when the Stop method is called on the adapter and is related to the StopMethod property ForceClose, ForceCloseThenTerminate, and SimulateCloseThenTerminate options. It specifies the amount of time, in milliseconds, OpenSpan waits for the process to exit after the Stop method has been called. The TerminateTimout value applies when the CloseTimeout expires.

After the CloseTimeout expires, OpenSpan tries to terminate the process. The TerminateTimout value sets the amount of time OpenSpan waits for the process to terminate. If this TerminateTimout value is exceeded, the process is most likely hung and OpenSpan leaves the process running. The CloseTimeout and TerminateTimout properties apply to each process monitored by the adapter.

Milliseconds

Context

Indicates the context in which the adapter is loaded. Contexts generally apply to solutions running in a Citrix environment. Click here for more information on Contexts.

String

ControlTimeout

Use this property to specify in milliseconds, the length of the timeout 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 timeout interval via the ApplyTimeoutToAllControls property.

Milliseconds

Credentials

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

 

DesignTime

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

Boolean

EnableMatchInProcess

The default is True. Normally, this property is only set to False if there is a matching problem that needs debugging; this removes the particular matching situation, letting you isolate a matching issue to a particular object or eliminate the possibility that a particular object is causing a matching problem.

For matching to work correctly for some controls, disable the EnableMatchInProcess setting for the web adapter for Siebel Open UI. If this property is enabled, you will see this message in the runtime log:

SiebelOpenUIFactory.CreateTarget: With In-process matching enabled, some OpenUI controls may not match correctly. It is strongly recommended that you change the adapter's 'EnableMatchInProcess' property to false for OpenUI.

Boolean

ExcludedProcesses

Use this property to identify processes that are not required by your project. For more information, see the Excluding Processes for Use in Projects topic.

ProcessList

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

String

FullName

Gets the fully-qualified name of the adapter item.

String

HideApplicationAtRuntime

 

This property determines whether the Internet Explorer window displays while the project and corresponding web application is running. Set this property to True to hide the application during project runtime. If you set this to True on the Properties Grid at design time, you can use the adapter's Show method in an automation to display the application while the project is running. You can also hide the application by calling the adapter's Hide method.

Keep in mind...

  • Matching: Hiding an application effects the matching of interrogated controls within the application. See the UnMatchOnHidden property to understand how hiding an application changes control matching.

  • Reparented Application: This property is not applicable when the Web application is selected to display in the TabbedReparentContainer control. If the web application is selected in the DesignComponentConfiguration property for the TabbedReparentContainer, the application will display even if the HideApplicationAtRuntime property is set to True. Also, you cannot hide the reparented application by calling the Hide method on the adapter.

Boolean

HookChildProcesses

Use this property to specify how OpenSpan interacts with any processes spawned by the adapter application. Set this property to True to OpenSpan to inject into spawned processes thereby enabling interrogation spawned application targets. For more information, see the Using HookChildProcesses topic.

Boolean

IdleTimeout

Sets the amount of time before the application becomes idle.

Milliseconds

IgnoreMainBrowser

This property controls how OpenSpan interacts with the Internet Explorer Browser target. If you set this property to True, OpenSpan ignores the Browser control while the project is running. The Browser events or methods are not applicable for use in automations in this case (with the exception of the base events such as Created and Destroyed).

Keep in mind...

  • Property Use: Only set the IgnoreMainBrowser property to True if the web application freezes while running your project when additional web application windows open, such as Alert Panels.

  • Exceptions: This property only applies to the main (top-level) browser control. If the application contains browser controls within frames, all events and methods for these browsers are hooked by OpenSpan and the browser events/methods are applicable.

Boolean

InvokeRequired

This method applies when the project and adapter are referenced in code by a non-OpenSpan project and is not used in OpenSpan standalone projects. See the OpenSpan Knowledge Base for more information on referencing OpenSpan projects.

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 OpenSpan 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, OpenSpan 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, OpenSpan 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 which 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 OpenSpan 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

MenuBarVisible

This property applies to the menu bar on the Internet Explorer application window running in OpenSpan projects. You can set the property to have the menu bar displayed (set to True) or not displayed (set to False). The property can be set either at design time (using the Properties Grid) or through an automation while the project is running.

Note: You can also get the value of this property and use it in automations as required by your project.

Boolean

MonitoredEvents

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

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 OpenSpan 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

Gets or sets the name assigned to the adapter.

String

OpenExternalLinksInNewProcess

This property controls how web applications or pages, unrelated to the active OpenSpan project, are opened. You can have external web applications open in the same Internet Explorer instance used by the project or force the unrelated application to open in a separate Internet Explorer instance. Your options are:

True – Any web applications/pages unrelated to the active project are opened in separate instances of Internet Explorer. For example, suppose the OpenSpan project is automating the training application (https://training.openspan.com/) on a system using Internet Explorer. If the user opens a web page unrelated to the project, the page opens in a new instance of Internet Explorer. Any pages opened external to the project remain open after the OpenSpan project is stopped.

False – Any web applications/pages unrelated to the active project are opened in the same Internet Explorer process which is used by the project. For example, suppose the OpenSpan project is automating the training application (https://training.openspan.com/) on a system using Internet Explorer. If the user opens a web page unrelated to the project, the page opens in a new tab within the current Internet Explorer process and focus shifts to the new tab. In this case, when the OpenSpan project is stopped, Internet Explorer is closed along with any pages opened external to the project.

This property applies regardless of whether the adapter is reparented (displayed in the TabbedReparentContainer control). Therefore if the property is False and a page external to the project is opened, the page displays in the TabbedReparentContainer control.

Boolean

SendMessageTimeout

Sets the amount of time OpenSpan waits for an acknowledgment message before sending the timeout message.

Milliseconds

StartMethod

The StartMethod property determines how the Path application is started. Your options are:

  • Start – With this option, starting the adapter causes OpenSpan to launch and hook the application defined by the Path property.

  • MonitorAll – With this option, after the adapter starts, OpenSpan waits until the web application is run and then hooks the application. In this case, the web application must be launched independently  (for example, from an external application or manually) after the adapter starts. Once the application is launched, OpenSpan hooks the application and the interrogated controls are available to the project automations or event monitoring. The adapter must be started before the web application is launched or OpenSpan will not hook the application.

Stopping the project will stop all application instances with which OpenSpan is interacting.

 

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

StartOnProjectStart

Sets whether or not the adapter should start when the project runs. See the StartMethod Property and StartOnProjectStart topic for more information.

Boolean

StartPage

The URL for the web application.

String

StartTimeout

Sets the number of milliseconds the adapter waits for the application to start before OpenSpan issues a timeout message.

Milliseconds

StopMethod

Sets how OpenSpan stops the application when the Stop method is called on the adapter. Your options are:

None – Stops the adapter, but leaves the process running.

ForceClose – For each process monitored by the adapter, OpenSpan sends the message WM_CLOSE to each top-level window in the process and waits up to the CloseTimeout value for the process to exit. If the CloseTimeout is exceeded, OpenSpan leaves the process running.

SimulateClose – For each process monitored by the adapter, OpenSpan sends the message WM_SYSCOMMAND (with parameter SC_CLOSE) to each top-level window in the process and waits up to the CloseTimeout value for the process to exit. This simulates the user clicking the 'X’ on each form’s title bar. If the CloseTimeout is exceeded, OpenSpan leaves the process running.

ForceCloseThenTerminate – Same as ForceClose, except OpenSpan waits up to the CloseTimeout value for the process to exit. When the CloseTimeout period expires, OpenSpan attempts to terminate the process and waits up to the TerminateTimeout value for the process to exit. If the process does not terminate within the TerminateTimeout it is likely hung, and OpenSpan leaves the process running.

SimulateCloseThenTerminate –  Same as SimulateClose, except OpenSpan waits up to the CloseTimeout value for the process to exit. When the CloseTimeout period expires, OpenSpan attempts to terminate the process and waits up to the TerminateTimeout value for the process to exit. If the process does not terminate within the TerminateTimeout it is likely hung, and OpenSpan leaves the process running.

Terminate – This setting does not attempt to gracefully close the process. For each process monitored by the adapter, OpenSpan attempts to terminate the process immediately and waits up to the TerminateTimeout value for the process to exit. If the process does not terminate within the TerminateTimeout it is likely hung, and OpenSpan leaves the process running.

String

StopWhenMainWindowCloses

Set to True to have the adapter shut down when the main window for the application is closed.

Boolean

SubscribeToWebBrowserEvents

Sets a value to control firing of web browser events within an automation. Set to False to disable firing these web browser events:

  • CanGoBackChanged

  • CanGoForwardChanged

  • DocumentCompleted

  • DocumentTitleChanged

  • EncryptionLevelChanged

  • FileDownload

  • Navigated

  • NewWindow

  • ProgressChanged

  • StatusTextChanged

For more information, see the Web Browser Properties, Methods, and Events topic.

Boolean

SuppressForegroundWindows

Set to True to prevent an application from creating top most windows or bringing windows into the foreground when it is not the active application. The default is False. For example, when automating a web application in the background, the application may create top most windows that show over the top of foreground windows disrupting user activity.

Setting this property to True will prevent the application from creating new topmost windows, converting existing windows to topmost, and bringing windows into the foreground.

Boolean

TerminateTimeout

This property is used when the Stop method is called on the adapter and is related to the StopMethod property ForceCloseThenTerminate, SimulateCloseThenTerminate, and Terminate options. The TerminateTimout value applies when the CloseTimeout expires. After the CloseTimeout expires, OpenSpan attempts to terminate the process. The TerminateTimout value sets the amount of time OpenSpan waits for the process to terminate. If the TerminateTimout value is exceeded, the process is most likely hung and OpenSpan leaves the process running. The TerminateTimeout property applies to each process monitored by the adapter.

Milliseconds

This

A reference to the adapter object.

String

ToolBarVisible

This property applies to the Tool Bar on the Internet Explorer application window running in OpenSpan projects. You can set the property to have the toolbar displayed (set to True) or not (set to False). The property can be set either at design time (using the Properties Grid) or through an automation while the project is running.

Note: You can also get the value of this property and use it in automations as required by your project.

Boolean

UniqueId

Indicates the unique identifier of the adapter object.

String

 

Events

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 OpenSpan'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 the Adapter Events topic.

ExceptionThrown

Occurs when an exception is raised by the adapter application.

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.

 

Methods

 

Methods

Description

Parameters

Return Type

AddBuildReference

This method applies when the project and adapter are referenced in code by a non-OpenSpan project and is not used in OpenSpan standalone projects. See the OpenSpan Knowledge Base for more information on referencing OpenSpan projects.

String reference

Void

BeginInvoke

This method applies when the project and adapter are referenced in code by a non-OpenSpan project and is not used in OpenSpan standalone projects. See the OpenSpan Knowledge Base for more information on referencing OpenSpan projects.

Delegate method, Object[] args

IAsyncResult

EndInvoke

This method applies when the project and adapter are referenced in code by a non-OpenSpan project and is not used in OpenSpan standalone projects. See the OpenSpan Knowledge Base for more information on referencing OpenSpan projects.

IAsyncResult result

Object

GetSelectedReparented
Window

This method applies when the project and adapter are referenced in code by a non-OpenSpan project and is not used in OpenSpan standalone projects. See the OpenSpan Knowledge Base for more information on referencing OpenSpan projects.

None

IntPtr

Hide

Hides all processes currently running in this adapter. See the UnMatchOnHidden property to understand how hiding an application changes control matching. This method is not applicable when the web application is selected to display in the TabbedReparentContainer control. If the web application is selected in the DesignComponentConfiguration property for the TabbedReparentContainer, you cannot hide the reparented application by calling the Hide method on the adapter.

Note:  We do not recommend using this method when automating applications because some applications and controls must be on an active desktop and visible.

None

 Void

Invoke

This method applies when the project and adapter are referenced in code by a non-OpenSpan project and is not used in OpenSpan standalone projects. See the OpenSpan Knowledge Base for more information on referencing OpenSpan projects.

Delegate method, Object[] args

Object

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

Show

Shows all processes currently running in this adapter. See the UnMatchOnHidden property to understand how hiding an application changes control matching.

None

Void

Start

Starts the application.

None

Void

Stop

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

None

Void