DevWeb > Recording Options

Enables you to customize the code generation settings and proxy recording settings for DevWeb scripts.

To access
Record > Recording Options
Important information
  • This Recording Options UI is available for DevWeb scripts only. For information on recording DevWeb scripts, see Record and replay DevWeb scripts in VuGen.
  • The Use Defaults button at the top of each node page restores all fields on that page to the default settings.

Import/export options

UI option Description
Import page This button enables you to import a YAML file containing recording options for the currently displayed Recording Options page. After importing, the page will be updated with the values from the file.
Export page

This button enables you to export the settings on the current page to a YAML file. The file can then be imported for other DevWeb scripts.

Back to top

Code Generation node

The Code Generation node enables you to define log levels, configure filtering options for script generating, and to enable automatic correlation scans.

User interface elements are described below:

UI area Description
Logging Define log level for script generation. Default value: Info.
Correlation configuration

Enable correlation scans to find correlation candidates (by default, all options are disabled):

  • Enable rules scan. When enabled, DevWeb runs a rules scan during code generation, to find dynamic values that match the correlation rules. To define and edit the rules, see Correlation rules node.

    Note: There is currently only one default option available for the Rules directory, under the DevWeb folder: ..\CorrelationRules

  • Enable record scan. When enabled, DevWeb runs an automatic record scan during code generation, to identify correlation candidates. You can select the preferred extractor type to use for plain text: Boundary (default) or Regular expression.
  • Show correlation candidates during code generation. When enabled, the Correlation Candidates dialog box is opened while generating/regenerating the script, displaying a list of discovered correlation candidates. You can select which correlations to apply to the script.

  • If required, edit the correlation scan timeout value, and the maximum comment length that will be included for the extracted value.

    For more information on using the correlation scans and managing candidates, see Correlation for DevWeb scripts.

<Filtering sections>

To edit the content in the Filtering sections of the Code Generation page:

Located to the right of each filtering section header, for example, Include hosts. Use to add new entries to each filtering section.

Available when the cursor hovers over a filtering section entry. Use to edit entries.

Note: There is no internal check for the accuracy of your entries.

Available when the cursor hovers over a filtering section entry. Use to delete entries.

Note: We recommend that you do not modify the default entries in the filtering sections.

Traffic filtering

Enables you to filter traffic for specific hosts, based on host names (using regular expressions):

  • Include hosts. Lists hosts to include, so that requests from those specific hosts will be the only ones included in the generated script.
  • Exclude hosts. Lists hosts to exclude, so that requests from those hosts will be excluded from the generated script. Default values: .*google.*, .*bing.*, .*geolocation.*, .*gstatic.*

  • Exclude WebSocket traffic. Select to filter out WebSocket traffic from the generated script.
Content types

Enables you to define content type handling:

Non-resources. The content types listed here will be treated as pages (new WebRequest step), if Pages is selected as the Level for script generation in the Start Recording dialog box.

You can add additional content types to the list. Default values: text/html, text/xml, text/plain, application/json

Content filtering

Enables you to filter web requests based on content:

  • File extensions. Exclude URLs with these extensions from web request steps. Default value: .ico
  • Headers. Exclude the listed headers from web request steps. Default values: Host, Content-Length, Cookie
  • Exclude methods. Exclude all requests that include one of the listed request methods. Default: CONNECT
  • Exclude response status codes. Exclude all requests if the response is one of the listed status codes. Default value: 404

General settings

Parameterize host names. When this option is enabled, at code generation the host names and IP addresses are identified and stored as parameter variables. The stored parameters are then used to substitute the relevant occurrences in the script at runtime.

Back to top

Proxy Recorder node

Enables you to define Proxy Recorder settings.

User interface elements are described below:

UI area Description
Logging Define log level for the Proxy Recorder. Default value: Info.
Proxy

Select one of the proxy options for the Proxy Recorder:

  • Use proxy. Select this option and define the proxy server settings, if you are recording your application behind a corporate proxy.

    You can also define, as required:

    • Credentials for proxy server authentication.
    • Authentication type to use: None, basic, or NTLM
    • Hosts to exclude when using the proxy.
  • Use PAC. Select to use PAC (Proxy Auto-Configuration), and enter the URL for the PAC configuration file.
  • No proxy. Select if you are recording without a proxy server connection.
Internet Settings
  • Enable HTTP/2. Allows HTTP/2 connections.
  • Client certificate. For HTTPS requests that require a certificate, specify the path to the client-side certificate and key file. The file must be in PEM format, and should contain both the unencrypted private key and the certificate.

Back to top

Correlation rules node

DevWeb scripts use their own correlation rules and methods, different from standard VuGen correlation. The Correlation rules page enables you to define, enable, and edit the correlation rules to be used by the DevWeb engine. Use the mouse-over tips on the Recording Options page to help you complete the relevant fields.

The page displays a tree of all the existing rules that are already defined for your scripts, within logical groups that are called categories. This includes the predefined correlation rules for an ASP.NET testing environment.

  • To enable the rules scan during code generation, the Enable rules scan option must be selected in the Code Generation node.
  • To include a rule during code generation, make sure the check boxes for the rule and the category are both selected.
  • If the check box for a category is not selected, the rules under it will not run during code generation, even if the rules themselves are checked.

Tip:  

UI area Description
Add category

Enables you to add a new correlation rules category. A category is a logical name for a group of rules.

Define the category and file name for each new category. By default, the file is added to the \DevWeb\CorrelationRules folder. The category name is not included in the code.

To change a category name, select the category in the tree. Then click the category name displayed at the top of the right panel.

Add rule

Enables you to add a new rule within a category. Define the rule name and the extractor type to use for the rule.

To change a rule name, select the rule in the tree. Then click the rule name displayed at the top of the right panel.

Note:  

  • Correlation rule names can contain alphanumeric characters only.
  • To create a new rule based on an existing rule, select the rule and click the Create copy of rule button.
Extractor tab

This tab is displayed in the right panel when you click on a rule. The rule extractor defines how to locate and extract the dynamic data in the responses. It can be based on boundary definitions or regular expressions, or can be used to query for object values inside JSON, XML, and HTML-formatted data.

Define the relevant properties for the selected extractor type. Mandatory properties are marked in red. Use the recording options tips to help you complete the property fields.

Applier tab

This tab is displayed in the right panel when you click on a rule. The appliers apply the extracted values, so that the saved parameter is used instead of the recorded value in subsequent requests to the server.

Define the relevant applier properties, as required for the rule. The following applier types are available:

  • Simple. Replaces the extracted value with a dynamic parameter that was created from the extractor.
  • Boundary. Replaces an extracted value between defined boundaries (left and right), with a dynamic parameter that was created from the extractor.
  • Regular expression. Replaces an extracted value that follows a regular expression, with a dynamic parameter that was created from the extractor.
  • None. Used when you want to enable the generation of extractors in the script, but do not want the extracted values to be applied in the script.

By default, a new rule is assigned a Simple applier that will run on the entire scope.

Back to top

See also: