Snapshot files

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

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 are also helpful when asking for technical help on our forums.

 

Screencast

 

The screencast Snapshot files walks you through information found in this chapter:

Watch the screencast now

 

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:

1. Start your AUT (for example, the Ranorex Studio Demo Application).

2. Start Ranorex Spy.

3. Using the TRACK button, track a UI element in the AUT (for example, the Submit button as shown below).

4. In the toolbar of the Element Tree browser, click Save as snapshot….

5. Name the file and specify where it should be saved and click Save to start snapshot file creation.

 

Note

 

The default save location for snapshot files is %USERPROFILE%RanorexSnapshots.

 

6. While the snapshot is being created, a progress bar indicates progress. Upon completion, the following message appears. Click Close.

 

Note

 

Snapshots usually contain the tracked/selected UI element and the complete ancestor subtree, for example, all elements of the respective application. You can change this default behavior under Settings > Advanced > Let snapshot contain complete ancestor subtree.

 

Further reading

---

Advanced settings are explained in Ranorex Studio system details > Settings & configurations >  Advanced settings & configurations.

 

Some UI elements, such as drop-down menus, pop-up windows, combo boxes, etc., only become visible after an interaction like 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 Ranorex Studio advanced > Tracking UI elements > Instant tracking.

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

To create a snapshot file with hidden UI elements:

1. Start your AUT and navigate where the hidden UI element you want to track appears (for example, in the Test database tab of the Demo Application).

2. Start Ranorex Spy.

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

4. With the UI element in focus, press Ctrl+WIN.

5. The tracked UI element appears in the element tree in Spy.

6. Now immediately before anything else, press Scroll to create a snapshot of the previously tracked hidden UI element and its ancestor subtree and cache it to the working memory.

1. 1. Snapshot file created successfully and cached to working memory. In this case, 10 UI elements were packed into the snapshot file, which is now opened in Ranorex Spy.

   2. Warning that the snapshot file may be incomplete. This usually happens when you try to create a snapshot of hidden UI elements without using Scroll.

7. The snapshot file is automatically opened in Ranorex Spy. This is indicated by the status message that switches from LIVE to SNAPSHOT.

Save the snapshot file

Finally, you need to save the Scroll-created snapshot from the working memory to permanent storage.

7. In the element tree toolbar, click the Save as snapshot… button.

8. Name the file, specify where it should be saved, and click Save.

9. A message shows that the snapshot file was saved successfully.

You can also load snapshot files in Ranorex Spy:

1. Start Ranorex Spy and in the element tree toolbar, click the Load from snapshot… button.

2. Browse to the snapshot file you want to open.

3. Click Open.

 

Note

 

The default save location for snapshot files is %USERPROFILE%RanorexSnapshots.

 

4. The snapshot file is opened in Spy, as indicated by the new element tree and the status indicator changing from LIVE to SNAPSHOT.

1. 1. Status indicator showing the snapshot file’s date of creation.