Snapshot files | Ranorex
Help CenterUser GuideRanorex Studio advanced

Snapshot files

A Ranorex Snapshot is a file representation of the user interface (UI) structure of an application under test (AUT) at a particular point in time. A Ranorex Snapshot captures all interface elements, their hierarchy, values, etc.

It can be saved as a single file. A Ranorex Snapshot file can be created and viewed with Ranorex Spy. The file extension is .rxsnp.

Typically, Ranorex Snapshots are used to share detailed information about the UI of an application with the Ranorex support and technical sales team.

In this chapter

    Creating a simple snapshot

    This section introduces how to create & save a simple snapshot from a UI which contains no hidden UI-elements like menus, menu items, context menus, tool-tips, etc. The herein given explanation will introduce you to the concept of Ranorex snapshots.

    Creating a snapshot file - part I

    Creating a snapshot file – part I

    Start the application under test (AUT) (i.e. demo application)
    Start Ranorex Spy

    Creating a snapshot file - part II

    Creating a snapshot file – part II

    Track a UI-element in the application under test (i.e. the Submit button in the demo application)
    Creating a snapshot file - part III

    Creating a snapshot file – part III

    Click the Save as snapshot… button in Ranorex Spy
    Select a location and give the snapshot file a meaningful name
    Click Save to start saving the snapshot file

    Note icon

    Note

    Ranorex saves snapshot files to %USERPROFILE%RanorexSnapshots per default.

    Result(s):

    A progress indicator shows the status of packing and saving the snapshot. Finally, a success message appears and can be confirmed with Close.

    Creating a snapshot file - part IV

    Creating a snapshot file – part IV

    Important to know:

    Note icon

    Note

    Snapshots usually contain the corresponding repository item and its complete ancestor subtree (of the Spy UI-item tree browser). You can change this default behavior in the advanced settings & configuration.

    Further reading

    The advanced settings & configuration can be found in > Ranorex Studio system details > Settings & configurations > ⇢ Advanced settings & configurations.

    Snapshot of hidden UI-elements

    Particular UI-elements of the application under test, such as drop-down menus, pop-up windows, combo boxes, etc., only become visible after a mouse click and usually disappear if the application under test loses focus. These elements are usually not automatically included in a Ranorex snapshot, as they appear as separate items in Ranorex Spy at the top level of the element tree. Therefore, these UI-elements are to be snapshotted differently. Here is how to.

    Tracking hidden UI-elements

    The tracking of hidden UI-elements such as menu items, drop-down list items, combo-box elements, is introduced and explained in a separate chapter. If you are not familiar with tracking such UI-elements, we recommend reading:

    Further reading

    The tracking of hidden UI-elements is introduced and explained in > Ranorex Studio advanced > Tracking UI-elements > ⇢ Instant tracking.

    An alternative method is explained in > Ranorex Studio advanced > Tracking UI-elements > ⇢ Track button.

    Snapshotting hidden UI-elements

    Creating hidden UI-elements snapshot - part I

    Creating hidden UI-elements snapshot – part I

    Start the application under test (AUT) (i.e. the demo application) with the Test database register pane
    Start Ranorex Spy

    Creating hidden UI-elements snapshot - part II

    Creating hidden UI-elements snapshot – part II

    Select a hidden UI-element (i.e. the ‘Project Management’ list item in the demo application)
    Instantly track this list element by pressing Ctrl+WIN
    See the tracked UI-element in the Spy tree browser

    Creating hidden UI-elements snapshot - part III

    Creating hidden UI-elements snapshot – part III

    Before you do anything else – press Scroll to create a snapshot of the previously tracked hidden UI-element and all of its repository tree children and cache it to the working memory

    Important to know:

    Information of successful snapshot creation in working memory. 10 repository items have been packed into a snapshot which is now opened in Ranorex Spy
    Warning that the snapshot created may be incomplete. This usually happens if you try to create a snapshot of hidden UI-elements without using Scroll

    Note icon

    Note

    The Scroll key instantly creates a snapshot of the currently in Spy activated repository item and its complete ancestor subtree.

    Result(s):

    The result is a snapshot which is opened in Ranorex Spy. This is noticeable at the Spy status message.

    Creating hidden UI-elements snapshot - part IV

    Creating hidden UI-elements snapshot – part IV

    Saving the snapshot

    Finally, the Scroll-created snapshot needs to be saved to a physical storage memory (i.e. disc, network drive, …)

    Saving a hidden UI-element snapshot

    Saving a hidden UI-element snapshot

    Click the Save as snapshot… button in the Spy toolbar, assign it a meaningful name, and
    click Save to confirm

    Result(s):

    The snapshot file is saved and a final success message appears.

    Saved hidden UI-elements snapshot file

    Saved hidden UI-elements snapshot file

    Loading a snapshot

    This section shows how to load a saved snapshot into Ranorex Spy.

    Loading a snapshot - part I

    Loading a snapshot – part I

    Start Ranorex Spy and click Load from snapshot… in the toolbar
    Choose folder and saved snapshot file
    Click Open

    Note icon

    Note

    If not changed, Ranorex saves snapshot files in %USERPROFILE%RanorexSnapshots.

    Result(s):

    The snapshot is loaded into Spy which is easily noticeable.

    Loading a snapshot - part II

    Loading a snapshot – part II

    See the snapshot with the date of creation in the status information