A Ranorex snapshot is a “point-in-time” capture of the UI structure of an AUT (application under test). It contains the UI element tree and the element properties Spy can see at the moment the snapshot is created (elements, hierarchy, values, and more).
Snapshot files are created and viewed in Ranorex Spy. Their file extension is .rxsnp.
Typically, snapshot files are used to share detailed information about the UI of an application with the Ranorex Support or Technical Sales team. They’re also helpful when asking for technical help on forums.
Screencast: The Snapshot files screencast walks you through the information found in this article.
Create a standard snapshot file
Standard snapshot files capture a UI that contains no hidden UI elements like menus, menu items, context menus, tooltips, etc. Creating a snapshot of a UI that contains these elements is explained in the next topic below.
To create a standard snapshot file:
- Start your AUT (for example, the Ranorex Studio Demo Application).
- Start Ranorex Spy.
- Using the TRACK button, track a UI element in the AUT (for example, the Submit button as shown below).
- In the Element Tree toolbar, click Save as snapshot…
-
Name the file, choose the location, and click Save to start snapshot creation.
Note: The default save location for snapshot files is
%USERPROFILE%RanorexSnapshots. - When the progress completes, a confirmation message appears. Click Close.
Note: By default, snapshots usually contain the tracked/selected UI element and the complete ancestor subtree (often the full application subtree). You can change this under Settings > Advanced > Let snapshot contain complete ancestor subtree
Further reading: Read more about Advanced settings & configurations.
Some UI elements, such as drop-down menus, pop-up windows, combo boxes, etc., only become visible after an interaction, such as a click, and usually disappear if the AUT loses focus.
These elements are “hidden” and therefore, not automatically included in a snapshot file. This is because they appear as separate items in Ranorex Spy at the top level of the element tree. Capturing these elements in a snapshot file requires the use of the instant tracking function.
Further reading: Tracking hidden UI elements is explained in Instant tracking. Additionally, an alternative method is explained in Track button.
To create a snapshot file with hidden UI elements:
- Start your AUT and navigate to where the hidden UI element you want to track appears (for example, in the Test database tab of the Demo Application).
- Start Ranorex Spy.
- Make the hidden UI element visible, for example, by opening the containing drop-down menu, as for the Project Management list item in the Demo Application, and ensure it is in focus, for example, by mousing over it.
- With the UI element in focus, press
Ctrl+WIN. - The tracked UI element appears in the element tree in Spy.
- Now, immediately before anything else, press
Scrollto create a snapshot of the previously tracked hidden UI element and its ancestor subtree and cache it to the working memory.-
Snapshot file created successfully and cached to working memory.
Important: The snapshot file may be incomplete. This usually happens when you try to create a snapshot of hidden UI elements without using
Scroll.
The snapshot file is automatically opened in Ranorex Spy. This is indicated by the status message that switches from LIVE to SNAPSHOT.
-
- In the element tree toolbar, click Save as snapshot…
- Name the file, specify where it should be saved, and click Save.
- A message shows that the snapshot file was saved successfully.
Load a snapshot file
You can also load snapshot files in Ranorex Spy:
- Start Ranorex Spy and click Load from snapshot… in the element tree toolbar.
- Browse to the snapshot file you want to open.
-
Click Open.
Note: The default save location for snapshot files is
%USERPROFILE%RanorexSnapshots. - The snapshot file is opened in Spy, as indicated by the new element tree and the status indicator changing from LIVE to SNAPSHOT.