Share this page

# Options dialog box

The Options dialog box is comprised of VuGen application settings. These settings are common to all available protocols in VuGen.

To access the dialog box, select VuGen > Tools > Options

In this topic:

## General tab

This pane enables you to configure general user interface options.

Task list

User interface elements are described below:

UI Element | Description
--- | ---
Comment Tags | This pane enables you to add, delete, or modify tags names that you can use to label comment tasks in your scripts. Tags. List of available tags. Name. Displays the name of the highlighted tags in the token list. This area enables you to modify, add, or delete the current tag. Add. Enables you to add a tag to the token list. Edit. Enables you to modify the name of tag from the token list. Delete. Enables you to delete a tag from the token list.

Scripts and Solutions

User interface elements are described below:

UI Element | Description
--- | ---
Settings | Default project location Enables you to specify a path to your saved projects. Default location = `C:\Users\<username>\Documents\SharpDevelop Projects` Load previous solution on startup Enables you to automatically load the previous solution. By default this option is enabled.
Start Page Settings | Display Start Page on startup By default this option is enabled. Close Start Page after script loads By default this option is enabled.

OpenText Application Quality Management

User interface elements are described below:

UI Element | Description
--- | ---
Connect to ALM in CAC mode | Connects to OpenText Application Quality Management using CAC (Common Access Card). This enables you to log in without providing a username and password.

Message Dialogs

This page lists notification and warning messages that can be viewed when working with VuGen. Use the check boxes to indicate which messages should be displayed, and which should be hidden.

Use the help popup beside each message to learn more about where that message is used.

Back to top

## Editor tab

This pane enables you to configure the text editor options.

General

General settings are described below:

UI Element | Category | Description
--- | --- | ---
Text Font | Font | Enables you to select the font.
Size | Font | Enables you to select the font size.
Word wrap | General Options | Automatically wraps text to the next line.
Show Class/Function Browser | General Options | Show or hide the Class/Function Browser. When enabled, you can navigate quickly to a specific class or function in your script by selecting it from the drop-down list in the browser.
Show line numbers | General Options | Enable line numbering of script in the Editor. By default this option is enabled.
Check for line ending inconsistencies | General Options | Enable the editor to check for end of line inconsistencies in your script. If enabled, a utility appears in the script editor that enables you to normalize line endings based either on a Windows standard (CRLF) or a Linux standard (LF).
Enable working URL hypertext links in the Editor | General Options | Enable URLs in scripts to function as hypertext links. Disabling this option may improve performance. By default this option is enabled.

Markers and Rulers

Markers and Rulers settings are described below:

UI Element | Description
--- | ---
Show spaces | Enable markers that indicate where tabs exists. By default this option is disabled.
Show tabs | Enable markers that indicate where line ends. By default this option is disabled.
Show end-of-line makers | Enable markers that indicate where line ends. By default this option is disabled.
Underline errors | Enable underlining of errors. By default this option is enabled.
Highlight matching brackets | Enable highlighting of matching brackets. By default this option is enabled.
Highlight matching occurrences of non-keywords | When this option is enabled, you can select a non-keyword in your script and the Editor will highlight all other occurrences in your script. Copy code
    class MyClass
    {
        void foo()
        {
            int i;
            for (i = 0 i < 10; i++)
            {
            }
            int index;
            for (index = 0 index < 10; index++)
                while(true)
                {
                }
                while (true)
                {
                }
        }
By default this option is enabled.

Behavior

Behavior settings are described below:

UI Element | Category | Description
--- | --- | ---
Indentation | Tabs | Enables you to set the spacing for tab indentation. Default indentation is four spaces.
Convert tabs to spaces | Tabs | Converts tabs to spaces. By default this option is disabled.
Use smart indentation | Tabs | Automatically applies the indentation format from the previous line. By default this option is enabled.
Enable zoom with mouse wheel | Behavior | Enables you to use the mouse wheel to zoom. By default this option is enabled.
Cut or Copy entire line when nothing is selected | Behavior | Allows you to cut or copy an entire line without highlighting it in the editor, as long as the cursor is within that line. By default this option is enabled.
Enable Ctrl + Click for "Go to Definition" | Behavior | Enables the Ctrl + Click shortcut for "Go To Definition". This lets you move the cursor to the definition of a function you control-click on in the editor. By default this option is enabled. To enable this option for an extra file containing custom functions, right-click on the file in the Solution Explorer and select "Add to Parsing List". Parsing list functionality applies only to C language functions and the Web HTTP/HTML protocol JavaScript functions.
Use Compact mode for JavaScript scripts wherever possible | Recording and Code Generation | When using JavaScript as the coding language, use Compact mode. This mode reduces the number of lines in the script by selectively removing line breaks.

Code Color

Highlighting options enable you to customize the color of script elements.

User interface elements are described below:

UI Element | Description
--- | ---
<Language Selection> | Drop-down list of script languages for which you can customize appearance.
<Element Selection> | List of code elements whose appearance you can customize.
Foreground color | Enables you to select a color from the pallet. The select color is applied to the foreground of the code element.
Background color | Enables you to select a color from the pallet. The select color is applied to background of the code element.
Bold/Italic | Enables you to set the text style to a bold or italic font.
Reset | Resets the code coloring to the factory default.

Code Completion

User interface elements are described below:

UI Element | Description
--- | ---
Enable code completion features | Code completion features are enabled. For details on code completion, see Editor pane. By default this option is enabled.
Enable syntax tooltip | Enables tooltips that display function arguments. Each argument is highlighted as you are defining it, moving to the subsequent argument when the delimiter is entered. Example: By default this option is enabled.
Show tooltips when mouse pointer stops over an identifier | When this option is enabled, a description of the code elements is displayed when the mouse hovers over the identifier. This option is disabled when Show tooltips in debug mode only is enabled. By default this option is enabled.
Show tooltips in debug mode only | Tooltips are displayed in debug mode only. By default this option is disabled.

Include in the code completion list

UI Element | Description
--- | ---
ANSI C keywords | Enables you to include ANSI C keywords in code completion list. By default this option is enabled.
API Steps | Enables you to include VuGen API steps in the code completion list. By default this option is enabled.
API Constants | Enables you to include VuGen API constants in the code completion list. By default this option is disabled.
User-defined functions | Enables you to include user-defined functions in the code completion list. By default this option is enabled.
Function parameters, local and global variables | Enables you to include function parameters, local, and global variables in the code completion list. By default this option is enabled.

Folding

Folding settings are described below:

UI Element | Description
--- | ---
Enable folding features | This option enables expanding and collapsing of script sections. By default this option is enabled.
Enable steps folding | This option enables expanding and collapsing of script steps. By default this option is disabled.
When step length is longer than [ ] characters | Enables you define the number of characters in a step before implementing folding. By default this option is disabled.
When step consists of more than [ ] lines | Enables you to define the number of lines to a step before implementing folding. By default this option is disabled.

Back to top

## Scripting tab

This pane enables you to configure options related to recording, replaying and debugging scripts.

Recording

User interface elements are described below:

UI Element | Description
--- | ---
Enable Recording Floating Toolbar transparency mode | Display a transparent floating recording toolbar. When you click or hover on the toolbar it becomes opaque. By default this option is disabled.
Enable 'Cancel Recording' button | Enable the Cancel Recording button on the floating recording toolbar. Note: When the Cancel Recording button is enabled, there may be a delay when you start recording into an existing script. This delay occurs while VuGen makes a copy of the existing script. By default, this option is enabled.
Open Start Recording Dialog Box after new script is created | Automatically open the Start Recording Dialog Box after a new script is created. By default this option is disabled.
Automatically close transactions | Enable this function if you want VuGen to insert an end transaction step for open transactions before recording a subsequent action. By default this option is disabled.
Check the Internet connection before recording | Enable this function if you want VuGen to check for an Internet connection before recording starts. Note: The Internet connection is checked by pinging google.com. If the Google server is not available (for example no external Internet) this could indicate a false-positive. In such cases, disable this check box.
Generate Recording report | Enables the generation of a Recording report. To automatically display the report after generating the code, select Display the Recording report when recording is finished. Note: The Recording report is available for Web HTTP/HTML and SAP - Web scripts only.
Do not display log messages during recording | When selected, the recording events are not displayed in the Output pane during the recording process. This can prevent VuGen from freezing when recording large events. The recording log file is loaded once the recording is complete.

Replay

User interface elements are described below:

UI Element | Description
--- | ---
Layout | Do not switch the layout during Replay. By default, when you replay a script, VuGen automatically switches the UI layout to the Debug layout. This option enables you to maintain your selected layout during replay. By default this option is disabled.
Animated Run | Animated Run: Runs the script in animated mode, highlighting the line in the script that is currently running. In non-animated mode, VuGen runs the script, but does not indicate the line being executed. By default this option is enabled. Animated Run Delay: You can set a delay of the highlighting in the animated run, allowing you to better view the effects of each step. You set the delay in milliseconds. The default delay is 1 ms. Animate functions in the Action section only: Only animates the content of the Action sections, but not the init or end sections. By default this option is enabled.
Results | Enable result of replay summary to be saved to a named folder after each script run When this option is enabled the dialog box prompts you to name a results file before running a script in VuGen. When not enabled, VuGen automatically names the directory 'result1'. Subsequent script runs will automatically overwrite previous results files, unless you specify a different name. Note: Results are stored in a sub-directory of the script. By default this option is disabled.
During Replay | Show runtime view during replay Enables the runtime viewer Auto Arrange Window Select this option to arrange the two viewers side by side. This option is disabled by default. Collect replay statistics Select this option to enable the collection of replay-time statistics. The data collected is displayed in the Replay Summary report. This option is enabled by default. For details, see Replay Summary pane. Display NV Insights report Select this option to enable the NV Insights report. For details, see NV Insights report. This option is enabled by default when the NV for Load Generator and VuGen component is installed on the VuGen machine. Note: This option is available only if the required Network Virtualization component is installed. For details, see Network Virtualization.
After replay | After replay show Instructs VuGen how to proceed after the replay: Script. Show script in the Editor. Replay summary. Go directly to the Replay Summary window in the Editor. (Default)

Script Management

User interface elements are described below:

UI Element | Description
--- | ---
List of file types, by extension, that can be edited in the Editor | Enables you to modify the list of valid file extensions that can be edited in the Editor.
Encoding | Enable the Convert script to default encoding option when non-English characters do not display correctly in the VuGen editor and logs. After enabling, reload the script.

Comparison

User interface elements are described below:

UI Element | Description
--- | ---
Path to comparing tool | The comparison tool to be used when comparing two scripts. VuGen is installed with a default comparison tool (WinMerge). To use a different comparison tool, browse to the location of the tool on your local machine.
Command line arguments -comparison tool | A list of the command line arguments to use with your comparison tool. The mandatory default arguments %1 and %2 should not be modified.
Path to merge tool | The merge tool to use for combining files, for example, when working with Git repositories. For details, see Manage scripts with Git. VuGen is installed with a default merge tool (WinMerge). To use a different merge tool, browse to the location of the tool on your local machine.
Command line arguments - merge tool | A list of the command line arguments to use with your merge tool. The mandatory default arguments /e /u /dl %title1 /dr %title2 %1 %2 should not be modified.

Step Navigator

User interface elements are described below:

UI Element | Description
--- | ---
Enable Editor highlighting | This option enables you to highlight filtered steps in your script.
Background color | The background color to apply to the filtered steps in your script.
Border color | The border color to apply to the filtered steps in your script.

Thumbnails

User interface elements are described below:

UI Element | Description
--- | ---
Enable Thumbnail Explorer | Enables slide view of generated thumbnails in the Thumbnail Explorer. Double clicking a thumbnail sets the cursor at the associated step in the script.
Highlight the thumbnail associated with a step | Sync the display of the Thumbnail Explorer while scrolling through steps in the Editor.
Show important thumbnails by default | VuGen displays thumbnails directly related to the business process and filters out less important thumbnails by default.
Enable automatic creation | Enables the automatic creation of thumbnails during the application's idle time.
Cache thumbnails to script folder | Optimize VuGen's performance by saving rendered thumbnails to a cache file. Thumbnails are loaded from the cache file after the initial generation.

Output Pane

User interface elements are described below:

UI Element | Description
--- | ---
Format | Word wrap Enables word wrapping in the Output pane.
Font | Text Font Enables you to select a font for the text that appears in the Output pane. Size Enables you to select a font size for the text that appears in the Output pane.
Use color coding to display text in the Output pane | Enables color coding of the text that appears in the Output pane. Color coding may slow down system response while a very large output log is displayed (rendered) in the Output pane or as you scroll through the output log. Note: Restart VuGen for changes to this option to take effect.

Observability

Configure VuGen to push telemetry data to an OpenTelemetry Collector during script replay. For details, see Observability metrics.

User interface elements are described below:

Field | Details
--- | ---
Enable collection of telemetry data during replay | Select to enable collection of telemetry data during script replay.
OpenTelemetry collector | Name and port number of the collector, beginning with grpc:// or http:// (http support from version 25.3), for example `http://my-collector:4318`.
TLS CA certificate | File path of the TLS CA certificate to connect to the collector (if required).
Authorization header | Authorization header to send data to the collector (if required).

Java

User interface elements are described below:

UI Element | Description
--- | ---
Eclipse IDE Location | Browse Enables you to set the location of the Eclipse program, eclipse.exe. For details on supported versions, see the Support Matrix.
JRE | Enables you to define which JRE VuGen should use for code generation and other actions: The JRE installed on your machine, detected automatically by VuGen. Select Use internal logic to locate JRE/JDK. (Default) A custom JRE. Select Custom JRE path and browse to a valid JRE folder. You may need to restart VuGen for the change to take effect. For details, see Java code support.
Enable unsupported Java versions | For version 25.3 and later: Enables VuGen to use an unsupported version of Java when generating Java code for a script. This is useful if you want to experiment with different Java versions. Note: When selecting this option, the experimental Java version must be 1.8 or later.

Citrix

User interface elements are described below:

UI Element | Description
--- | ---
Show client during replay | Shows the Citrix client during script replay.
Show Bitmap Selection popup | Issues a popup message when inserting a Get Text or Sync Bitmap function before selecting a bitmap or text in the snapshot.

Correlation

User interface elements are described below:

UI Element | Description
--- | ---
Enable correlation from replay snapshots | Enables the Create Correlation context menu item in the Replay snapshot's Response Body pane. This option instructs VuGen to format the data so that it is open for correlations. When disabled, VuGen only generates raw data which cannot be altered.

Snapshots

User interface elements are described below:

UI Element | Description
--- | ---
Enable snapshot viewing | Enables the viewing of snapshots when you click on a step in the editor or step navigator. This option allows you to improve VuGen's performance when working with very large scripts.
Enable enhanced XML view | Enables the following XML viewer visual features: XML tree coloring Clear this option to reduce the amount of memory consumed by the XML view.
Enable snapshot caching | Allows snapshots to be cached. Clear this option where you are working with large snapshots and are running out of memory.
Do not load text snapshots larger than | Text-based snapshots are not loaded if they are larger than the specified size.
Do not load binary snapshots larger than | Binary [hexadecimal] based snapshots are not loaded if they are larger than the specified size.
Do not load XML snapshots larger than | XML-based snapshots are not loaded if they are larger than the specified size.
Do not highlight XML snapshots larger than | XML-based snapshots are not highlighted if they are larger than the specified size.
Enable HTTP Page View option in the Snapshot pane | Enables the display of HTTP protocol snapshots in the Page View. This option is disabled by default, since it may affect VuGen performance. We recommend to use the HTTP Data view instead.

Parameters

User interface elements are described below:

UI Element | Description
--- | ---
Left parameter delimiter | The left parameter delimiter. The following characters are valid: !, #, $, %, &, (, ), [, ], {, }, |, ~, `, <, >, ? Note: If you change the left parameter delimiter, the specified delimiter will be applied to new Vuser scripts only, not to existing scripts.
Right parameter delimiter | The right parameter delimiter. The following characters are valid: !, #, $, %, &, (, ), [, ], {, }, |, ~, `, <, >, ? Note: If you change the right parameter delimiter, the specified delimiter will be applied to new Vuser scripts only, not to existing scripts.
Parameter background color | The background color for parameters in a Vuser script.
Parameter border color | The border color for parameters in a Vuser script.
Restore Default Delimiters | Resets both the left and right parameter delimiters to their default values.

Parser

User interface elements are described below:

UI Element | Description
--- | ---
Enable C Language Parser | Disabling the C language parser may improve application performance when you are working with very large scripts. However, the following features will be disabled: Editing step arguments in the Editor Step navigator Correlations Script regeneration Snapshots Tasks Thumbnails inline code completion Additional step-related functionality This option is enabled by default.

Back to top

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 25.1-25.3 All View Local Help Center View Online Help Center Version: