Status : Validated

Declaration of Pages

Once the application has been declared, pages must be added (there must be at least a main page per application to declare items).

The declaration of a page involves:

  • Capturing the page,
  • Setting the page parameters,
  • Defining the criteria that allow the software to recognize this page.

Select the application in the 'Project Tree', then select 'Capture a new Page…'

The following panel appears, allowing the selection of the page to be captured:

Capture of a Page

Select the Page to Capture

Page selection Select a page to capture as follows:

  • Move the cursor over the desired screen to capture it,
  • Hold down the 'Ctrl' key briefly,
  • Desktop Studio constantly monitors the keyboard: when it detects that the 'Ctrl' key is down, it selects the page under the cursor.

When detected, information about the selected page is shown:

  • The technology of the selected page (1),
  • The screen capture of this page (2),
  • A red rectangle surrounding the selected page,
  • A tree (3) of the other potential pages detected around the selected page (the selected page is the red one).

Note :

  • Remember, for Java application, you must capture the pages while running the project.

Choose Technology

The technology of the selected page is detected automatically, depending on the technology of the declared application.

It can also be forced by checking the 'Choose technology' option and selecting the desired technology in the combobox.

Page Tree

The content of the tree of pages depends on the technology (automatically detected or manually selected):

  • For a web page, it contains all the frames displayed in the selected IE instance,
  • For a Windows page, it contains all the controls of the selected Windows application,
  • For a Java page, no tree is displayed.

The selected page can be changed by selecting it in the tree.
The red border and the screen capture (if available) are changed to reflect this selection.

Note that for a Windows page, the selected item will be considered as the Root Item of the page.

Show invisible options

To see hidden controls, check the 'Show invisible' checkbox.

Recognition option

Check the 'Recognize' checkbox to highlight the pages already declared.
Desktop Studio checks each listed page with the criteria of the declared pages of the application:

  • Each page is preceded by the icon if it is detected as belonging to the application,
  • A recognized page is given the corresponding page name.

Please note that only pages and applications with defined criteria can be used for recognition.
Recognition can be time-consuming, especially with Web pages that have 'MustExist' items.
In this case, uncheck the 'Recognize' checkbox to accelerate page capture.

MultiCapture option

Check the 'MultiCapture' checkbox to capture multiple pages at once.
In this case, a checkbox is added for each page in the tree. All the checked pages will be captured (and only the checked pages, the selected page is then ignored).

Show All option

If unchecked, the page tree contains only the element selected.
This option can be useful when tree exploration is time-consuming.

Capture on Hover option

Use the 'Capture on Hover' option to capture pages opening only on some mouse actions (for exemple: opening a menu with the mouse).
If checked, capture starts automatically when you depress the 'Ctrl' key.

Capture Mode

Capture mode lets you select the method used to make a screen capture of the page.

The default Capture mode is 'PrintWindow' that lets you capture a page that is not completely visible on the screen.
If this capture fails, the other capture mode is automatically used.
Sometimes, the 'PrintWindow' capture succeeds, but the resulting capture is not the same as the original.
In these cases, use of the 'CaptureScreen' mode can be forced by checking it.
Please note: When you use this mode, the page must be visible (not covered by other graphical elements) when validating the capture.

Capture the Page(s)

By default, the selected page is the one that will be captured.
If the 'MultiCapture' option is used, all checked pages will be captured (and only the checked pages, the selected page is then ignored).

After selecting the required page(s), start the capture by clicking on the 'Capture and edit' or 'Capture and continue' button:

  • 'Capture and edit' button will navigate to the 'Page properties' panel after the capture in order to define page criteria,
  • 'Capture and continue' will stay on the 'Capture' panel to let you capture further pages.

Pages criterias can also be defined later.

The following panel appears:

Page Capture

If required, the name of the page can be edited. Clicking the 'Start capture' button triggers the capture.
Desktop Studio executes and stores:

  • A screen capture of the page,
  • A capture of the internal structure of the page (HTML 'DOM' for a Web page or the class structure for a Windows application),
  • A capture of the 'source' of the page (for a Web page only).

A progress bar is updated during the operation to show the capture in progress.
Captures are stored on disk and are available for working offline (no need for the application to be running after the capture action).

Captured elements depend on the page technology:

  • Screen capture is the same for all technologies,
  • DOM capture:
    • For a Web page, this is the DOM of the Web document,
    • For a Windows page, this is the tree of all the controls, with their properties,
  • Source capture:
    • This capture is available for Web Pages only. This is the HTML page source.

Note :

  • Some captures can be time-consuming, especially when capturing very big documents(Web technology).
    It is possible to interrupt an ongoing capture by clicking the 'Int.' button.
    In this case, the capture is not cancelled all together, but will be only partially completed.

Capture a Subpage

Some technologies (Windows, …) require the declaration of Subpages.

This requirement is due to the tree structure of Windows application and to the way the Windows connector recognizes Windows pages:
If a Windows control to be recognized as a Page_1 by Desktop Studio has a parent control which is recognized as a Page_2, the Page_1 MUST be declared as subpage of the Page_2.

This subpage relationship ensures that only the controls required are recognized.
However, if not declared correctly, it can prevent required controls from being correctly recognized.

A subpage is declared exactly like a simple page declaration.
The only difference is that it MUST be declared with the corresponding parent page.

Studio Explorer lets you define this subpage relationship in the following ways:

Defining a Subpage Relationship Manually

The first way to define a subpage relationship is to do so manually.

To do this, select the parent page and activate the 'Add a subpage' context menu.
The new captured page will be created as a subpage of this page.

Detection of a Subpage Relationship with Recognition

If you do not define the subpage relationship manually, Studio Explorer tries to detect it by recognizing pages in the captured control parents.
The nearest page recognized is used as parent page.

Limitation: The parent page can be detected only if it has been recognized in the page view.

Detection of a SubPage Relationship Without Recognition

Multiple pages can be captured without having to define their criteria immediately.

During this operation, Studio Explorer detects the subpage relationship by comparing the 'ParentTree' of each captured page and inserting a new captured page as a subpage of the correct parent.

Limitation: The 'ParentTree' of a page is the chain of window handles ('HWND') of the parent controls of the newly captured control.
As this chain is comprised of window handles, it is valid until one of the parent controls is closed or until the application itself is closed.
In order to use this detection method, it is advisable to capture all the pages during the same application session.

Create a SubPage from a Page Component

A subpage can be created directly from the parent-page capture by right-clicking the item (1) and selecting the 'Create a new Page' context menu item (2).
The new subpage is created using the same capture, with the selected item as the root item.

Create a Subpage

Change the Subpage Root Item

When capturing a subpage, the root item is set (see Page tree).

Later on, another item can be set as the root item by right-clicking the new root item and selecting the 'Associate with the Selected Page' context menu item.

Capture an HLLAPI Page

It is not possible to capture an HLLAPI page by selecting the page on the screen.
Instead, to select an HLLAPI Page, click on the Browse button.

The page tree shows all the HLLAPI sessions opened on the desktop (A, B, and so on):

Click the “Capture and edit” or the “Capture and continue” button after selecting the session to be captured.

Make a New Capture

Captures can be added to an existing page.

Having multiple captures can be useful when a pagehas different states.
Select the pagein the Project Tree, then select 'Make a new Capture of this Page…'

The capture process is the same asfor a new page, except for a popup asking if you wish to replace the current capture.

Options available :

  • 'Yes', the old capture is replaced by the new one.
  • 'No', the new capture is added to the page's captures.

The various captures associated with a page are accessible in the Capture Selector.
Here is an example of a page with two captures: Page Capture Toolbar

This toolbar lets you:

  • Select the current capture,
  • Make a new capture,
  • Lock the current capture,
  • Edit the current capture,
  • Delete the current capture.

Select the Current Capture:

The current capture can be selected manually by selecting its corresponding tab.
To make this simpler, each tab has a tooltip showing the capture's comment and the date of capture.

Make a New Capture:

A new capture can be made by clicking the button.
The capture workflow is the same as described previously.

Lock the Current Capture:

When you select an item in the Project Tree, the current capture is automatically changed to the one in which the item was selected
(see Associate Items with Components in the Page capture).
In order to avoid this, the current capture can be locked by clicking the button.

This way, the current capture remains the same, whichever item is selected. To unlock the current capture, click the button.

Edit the Current Capture:

By clicking the button, the data associated with the capture can be changed.

This opens the following form:

The options available are:

  • Change the capture's comment,
  • Indicate if the capture is to be visible in the Application View (by default, only the first one is visible)

Delete the current capture :

Delete the current capture by clicking on the button.

After the Page capture, or at any later time, the various elements of a page definition can be modified:

  • The page parameters,
  • The criteria used for page recognition,
  • The technical events notified by the page.

Regardless of the page technology, this panel contains the same subparts:
Page Parameters Tool Window

Set Page Parameters

The Parameters tool window lets you set the page's parameters:

General category
Name Name of the entity used in scripts to monitor the page
Comment Description of the entity
Technical If set, the page is declared for technical use only
Driver category
Parameters specific to the driver used to manage the page
Technical category
Driver Name of the driver used to monitor the application (read-only)
Launch path Path used to launch the target screen
Offlinepath Path where page captures are stored (read-only)
Technology Technology of the page (read-only)

A description of each parameter is available in the 'Help' panel.

Track Events Tool Window

Select Page Tracked Events

The Track Events Tool Window lets you set the technical events monitored on the page.

The list of available technical events depends on the page technology.
A description of each event is available in the 'Help' panel.

Set Page Critera

Page Captured Data Tool Window

Page Criteria Tool Window

The Captured Data Tool Window shows the properties of the page that can be used as criteria.

These properties are collected when the page is captured.
If the page was been captured by Desktop Studio, this tool window is empty.

The properties captured depend on the page's technology and on the connectors: only properties used by the connector are captured.

  • For a Web Page, these properties are associated with the captured frame,
  • For a Window Page, these properties are associated with the root item set at the beginning at the capture.

The Criteria Tool Window lets you edit the criteria of the page that will be used by the connector to recognize a page at runtime.

For a complete description of this tool window, see Criteria Management

Page Recognition

When a page is selected in the Project Tree, Desktop Studio tries to automatically recognize it in the current capture.
In the same way, when changing the current capture, Studio Explorer tries to recognize the current page on this capture.
The page is highlighted in green if recognized, in red if not, and in black if no recognition has been attempted.

For a complete description of page recognition, see Using Recognition.