Share this page

# Snapshot pane

This topic describes the VuGen Snapshot pane.

To access: Select View > Snapshot, or click the Show Snapshot Pane button on the VuGen toolbar.

In this topic:

## About the Snapshot pane

Snapshots contain the data generated by the traffic between the client and the server, and are captured when a script is recorded and when the script is replayed. A snapshot displays all data associated with a specific step in a script.

Snapshots enable you to search for correlations, compare record versus replay snapshots and search for the specific values using the standard search operation.

Snapshots are displayed in various formats, and provide different functionality, depending on the current Vuser protocol.

Note:

- The Snapshot pane is not available for some Vuser protocols.
- For details on the DevWeb Snapshot pane, see DevWeb snapshots.
- The web snapshot model is backwards compatible with earlier versions. However some snapshot data may be missing. If this occurs, regenerate the script.

## Standard Snapshot pane controls

The Snapshot pane displays the following standard controls.

Tip:
- Press Ctrl+F to search for text within a snapshot view. (Search is not supported for the JSON view.)
- You can move this pane to different areas of the main user interface. For details, see How to modify the VuGen layout.

UI Element | Description
--- | ---
Single | Shows a single snapshot in the Snapshot pane.
Split | Splits the Snapshot pane to show two snapshots.
Horizontal | Displays two snapshots in the Snapshot pane - one to the side of the other.
Vertical | Displays two snapshots in the Snapshot pane - one above the other.
Recording | Shows the record snapshot in the Snapshot pane.
Replay | Shows the replay snapshot in the Snapshot pane.
Iteration | Select the iteration number of the replay snapshot to display. This is only visible when showing a Replay snapshot.
| Synchronizes the display of the two snapshots if the Snapshot pane is split. Note: Snapshot synchronization is available only for specific Vuser protocols, and specific views within the protocols.
Compare | Compares the two snapshots that are currently displayed in the Snapshot pane. To enable the Compare functionality, you must first split the Snapshot pane to show two snapshots. To change the default comparison tool, see Scripting tab. Note: The snapshot comparison functionality is available only for the Web HTTP/HTML and Web Services protocols.

## Snapshot pane controls for Citrix, RDP, SAP, and PCoIP protocols

User interface elements are described below:

UI Element | Description
--- | ---
Image | Displays a graphical representation of the snapshot. You can synchronize the display of two snapshots in the Snapshot pane. Snapshots display faster when the Image view is used than when the Full view is used.
Full | Displays a graphical representation of the snapshot. You cannot synchronize the display of two snapshots in the Snapshot pane. Snapshots display slower when the Full view is used than when the Image view is used.

### Context menu

UI Element | Description
--- | ---
Copy Image to the Clipboard | Copies the image to the clipboard.
Insert Mouse Click | Inserts a mouse click function, for example, ctrx_mouse_click, at the point of the cursor in the script.
Insert Mouse Double Click | Inserts a double mouse click function, for example, ctrx_mouse_double_click, at the point of the cursor in the script.
Insert Sync on Bitmap | Inserts a sync on image function, for example, ctrx_sync_on_bitmap, at the point of the cursor in the script. Select the bitmap area with the cursor to get the bitmap values (x,y coordinates, width, height) for the function. Note: For the PCoIP protocol (pcoip_sync_on_bitmap_ex), you can define the timeout period.
Insert Sync on Bitmap (by coordinates) | Inserts a sync on image function with synchronization area coordinates as function parameters, for example, ctrx_sync_on_bitmap. The parameters are entered in a dialog box displayed after selecting this option. The function is inserted at the point of the cursor in the script. Note: For the PCoIP protocol (pcoip_sync_on_bitmap_ex), you can define the timeout period.
Insert Get Bitmap Value | Inserts a get bitmap value function, for example, ctrx_get_bitmap_value, at the point of the cursor in the script. This function retrieves the hashed string value of a bitmap for use in custom synchronization functions. Select the bitmap area with the cursor to get the bitmap values (x,y coordinates, width, height) for the function.
Insert Get Text | Inserts a get text function, for example, ctrx_get_text function, at the point of the cursor in the script. Select the text area with the cursor to get the values (x,y coordinates, width, height) for the function. Note: This option is available only when the Vuser script is recorded on a Citrix server, with the Citrix agent installed on it.
Insert Sync on Text | Inserts a sync on text function, for example, ctrx_sync_on_text_ex function, at the point of the cursor in the script. Select the text area with the cursor to get the values (x,y coordinates, width, height) for the function. This function waits until the specified text is displayed (agent installations only). Note: This option is available only when the Vuser script is recorded on a Citrix server, with the Citrix agent installed on it.
Insert Obj Get Info | Inserts an object get info function, for example, ctrx_get_obj_info, at the point of the cursor in the script. This function retrieves the current state of the requested object property. Note: This option is available only when the Vuser script is recorded on a Citrix server, with the Citrix agent installed on it.
Insert Sync on Obj Info | Inserts a sync on obj info function, for example, ctrx_sync_on_obj_info, at the point of the cursor in the script. This function causes VuGen to wait for a certain state before continuing. Note: This option is available only when the Vuser script is recorded on a Citrix server, with the Citrix agent installed on it.

## Snapshot pane controls for Windows Sockets protocol

The snapshot for Windows Sockets protocol are displayed as textual and hexadecimal representations of data buffers sent and received.

User interface elements are described below:

UI Element | Description
--- | ---
Hex | Displays the buffer data in hexadecimal.
Text | Displays the buffer data as text.
Go To | Opens the Go To Offset dialog box that enables you to navigate within the data buffer.
Context menu: Create Correlation | Select the text for the correlation, from the Response Body tab. Opens the Correlation dialog box. For details see Correlate scripts.

## Snapshot pane controls for Web - HTTP/HTML protocol

The snapshots for Web - HTTP/HTML protocol are displayed as textual and hexadecimal representations of the request and response. To view these controls, double-click on a step with a snapshot in the Step Navigator tab.

User interface elements are described below. These are available for both the Recording and Replay snapshots.

UI Element | Description
--- | ---
Http Data | Displays step data in HTTP format. This enables you to view in-depth information about the step, including request data, response data, cookies, and headers. For more information, see Web snapshots.
Page View | Displays step data in HTML format.
Tree | (Http Data view only) Displays the HTTP flow data in a tree structure. The data is separated into separate tabs: Raw Data, Request Body, Response Body, Headers, Cookies, and Query String. For some of the above tabs, you can display the data in text, hexadecimal, or json views, using the buttons on the right: Text View, Hex View, and JSON View. Note: Depending on your application, some tabs may not have any data.
Grid | (Http Data view only) Displays the HTTP flow data in a list format.
Iteration | The iteration number to display in the pane (only for Replay snapshots)

### Context menu

UI Element | Description
--- | ---
Create Correlation | Opens the Correlation dialog box. For details see Correlate scripts. Note: This option is available in the Response view only. This option is available for attribute and value nodes only.
Create Correlation Rule | Opens the Add as Rule dialog box. For details see Manually correlate scripts. Note: This option is available in the Response view only. This option is available for attribute and value nodes only.
Create Parameter | Opens the Create Parameter dialog box. For details see Create parameters. Note: This option is available in the Response view only. This option is available for attribute and value nodes only.
Search Community | Performs a search in the OpenText Professional Performance Engineering Community forum, using the selected text as the search string.
Add Text Check Step | Opens the Find Text dialog box. For details see Add a text check from the XML view in the Snapshot pane. Note: This option is available in the Response view only. This option is available for attribute and value nodes only.

## Snapshot pane controls for XML protocols

The snapshots for protocols with an XML request/response (such as Web Services) are displayed as XML, textual, and hexadecimal representations of the request and response bodies.

For more details, see Snapshots with XML view.

User interface elements are described below:

UI Element | Description
--- | ---
Response | Displays a snapshot of the server response.
Request | Displays a snapshot of the request sent to the server.
| Opens the XPath search dialog box, allowing you to search the XML code using a standard XPath expression.
| Displays the previous or next results of the XPath search.

### Context menu

UI Element | Description
--- | ---
Copy Selection | Copies the text that is selected in the text view to the clipboard
Search Community | Performs a community search using the text that is selected in the text view as the search string. For details about performing a community search, see Editor pane.
Copy XPath | In the tree view, copies the XPath of the selected node to the clipboard. In the text view, copies the XPath of the XML element in which the cursor is located to the clipboard.
Copy full value | In the tree view, copies the full XML code of the selected node to the clipboard. In the text view, copies the full XML code of the XML element in which the cursor is located.
Node Properties | Opens the XML Node Properties dialog box.
Insert XML Check | Opens the Insert XML Check dialog box that enables you to insert an XML Find step into the Vuser script. Note: This option is available in the Response view only. This option is available for attribute and value nodes only.
Save value in parameter | Opens the Save Value as Parameter dialog box that enables you to save the selected value to a simple parameter. Note: This option is available in the Response view only. This option is available for attribute and value nodes only.
Save XML in parameter | Opens the Save Value as Parameter dialog box that enables you to save the selected value to an XML parameter. This option is available in the Response view only.
Create Correlation | Opens the Correlation tab in the Design Studio. The text selected in the Snapshot pane appears as a manual correlation entry in the Design Studio. For details, see Manually correlate scripts. Note: This option is available in the Response view only. This option is available for attribute and value nodes in the tree view, and when text is selected in the text view.
Create Correlation Rule | Opens the Add as Rule dialog box that enables you to add the selected text as part of a correlation rule. For details, see Correlating values. Note: This option is available in the Response view only. This option is available for attribute and value nodes in the tree view, and when text is selected in the text view.

## Snapshot pane controls for database protocols

User interface elements are described below:

UI Element | Description
--- | ---
Recording | Shows the recording snapshot in the Snapshot pane.
Data Grid | Displays data in a data grid.

### Context menu

UI Element | Description
--- | ---
Create Correlation | Opens the Correlation dialog box. For details see Correlate scripts. Note: This option is available in the Response view only. This option is available for attribute and value nodes only.
Save Grid to File | Saves the grid's contents to a CSV file.

## Copying images to the clipboard

You can copy an image-based snapshot to the clipboard. This enables you to import the image into a graphics application, where you can analyze and modify the graphic.

For details on how to copy a snapshot to the clipboard, see Work with snapshots.

Note: The "copy snapshot to the clipboard" functionality is available for only RDP, Citrix, and SAP GUI protocols.

## Copying snapshot text to the clipboard

You can copy text from a snapshot to the clipboard. You can then paste the text from the clipboard into another application.

For details on how to copy snapshot text to the clipboard, see Work with snapshots.

## Customized Snapshot pane functionality

In addition to the basic Snapshot pane functionality, the Snapshot panes for some Vuser protocols include customized functionality. For example, the Snapshot pane for RDP Vuser scripts lets you display snapshots in either Full or Image modes; the Snapshot pane for Winsock Vuser scripts lets you display snapshots in either Text or Hex modes. The controls for the customized functionality can be found in the Snapshot pane toolbars.

## Activating the Snapshot on error functionality

In addition to showing record and replay snapshots, the Snapshot pane can display snapshots of errors that occurred during the replay of a script. The "snapshot on error" functionality is available for only specific Vuser protocols.

You can generate and display snapshots of errors only if the "snapshot on error" functionality is activated.

To activate the snapshot-on-error functionality:

1. Click Replay > Runtime Settings. The runtime settings dialog box opens.

2. Under General, click Miscellaneous.

3. Under Error Handling, select the Generate snapshot on error check box.

## See also

- Work with snapshots

https://admhelp.microfocus.com VuGen,Professional Performance Engineering,Performance Engineering for Developers 8942
Tips to improve your search results... OpenText™ Virtual User Generator Help Center OpenText™ VuGen Help 26.1-26.3 All View Local Help Center View Online Help Center Version: