Share this page

# Scripting with Visual Studio Code

This topic describes how to build and run DevWeb scripts using the Microsoft Visual Studio Code (VS Code) editor.

In this topic:

## Create DevWeb scripts in VS Code

When creating a DevWeb script using VS Code, you can use the VsCodeTemplate as a basis for your script.

You can also use a VS Code extension package for creating and editing your DevWeb scripts. For details, see VS Code extension.

Alternatively, if you create a new DevWeb script from your own application, we recommend that you copy some of the files from the template script to your new script. This enables you to utilize extra functionality for the script in the VS Code environment.

Note: For Visual Studio Code 1.46.0 and later, an experimental debugger might be enabled by default. This debugger is not supported with DevWeb scripts.

Workaround: To debug, in the VS Code settings set ‘debug.javascript.usePreview’ to false.

To set up the VS Code environment:

1. The Visual Studio Code template can be downloaded from Marketplace. Download and extract the appropriate VsCodeTemplate.zip package for your product version.

   Alternatively, you can copy the VsCodeTemplate folder from <DevWeb root>\examples\.

   Tip: If you prefer to copy files to an existing DevWeb script, open the <DevWeb root folder>\examples\VsCodeTemplate folder, and copy the following files and folder to an existing DevWeb script folder:

   - .vscode folder. These files enable you to view predefined tasks for the DevWeb script in VS Code.

   - DevWebSdk.d.ts and tsconfig.json files. These files enables JavaScript SDK code completion for the DevWeb scripts in VS Code.

2. Copy the template folder to a location on the same machine as OpenText Performance Engineering for Developers, and rename the copied folder.

3. In VS Code, open the script: Select File > Open Folder and open the copied folder.
4. Edit the script as required.

5. Select Terminal > Run Task (in older versions of VS Code, select Tasks > Run Tasks), then select one of the options to record or generate the DevWeb script.

   For details, see VS Code tasks.

Note: The tasks use the environment variable DEVWEB_PATH, which should point to the DevWeb installation path. The environment variable is created automatically when DevWeb is installed with OpenText Professional Performance Engineering or OpenText Enterprise Performance Engineering.

## VS Code extension

You can install a VS Code extension directly from VS Code. You can then open a template in VS Code and create a DevWeb script, with all editing functionality available.

The VS Code extension includes correlate selection functionality for DevWeb scripts. This enables you to manually select the text you want to correlate, and then use the Correlate Selection option to add extractors. For more information about correlations, see Correlate dynamic values.

To install and use the VS Code extension:

1. Launch VS Code.
2. Open the Extensions Panel, and enter Performance Engineering for Developers in the Search box.
3. Click the Install button. After installation is complete, OpenText Functional Testing for Developers is added to the list of extensions.

4. Open the new extension. In the Explorer area, right-click and select Create DevWeb script from the displayed menu.

5. Select a folder for the script, or create a new one.

6. The script files are displayed in VS Code, edit as required.

7. Select Terminal > Run Task for task options. For details, see VS Code tasks.

To manually correlate selected text:

1. Within a web request in your DevWeb script, select the text to correlate.

2. Select Correlate Selection from the right-click menu.

   Note: The Correlate Selection option is enabled only if the following are true:

   - The script was generated from a HAR file.
   - The selected text is in the context of a web request.
   - The selected text is not in the first request.
   - The selected text contains at least 4 characters.

3. Give the extractor a name in the Enter extractor name box (displayed at top of the editing pane), and press Enter.

4. The editor finds all occurrences of the value, and the first match is displayed in the results box. You can select to replace all occurrences with the extractor, or scroll down the list to replace the occurrences one-by-one.

   The extractor type is determined by DevWeb and added to the script in all relevant locations.

## Run DevWeb scripts from VS Code

You can run your DevWeb script for up to 50 Vusers, using the DevWeb plug-in.

To run a script:

1. Select Terminal > Run Tasks (in older versions of VS Code, select Tasks > Run Tasks).
2. Select one of the run options.

3. If any errors are discovered during the run, press CTRL+left mouse button to jump to the line where the error occurred.

## VS Code tasks

The VsCodeTemplate includes the following tasks (available by selecting Terminal > Run Tasks):

Task: | Purpose: | For details, see:
--- | --- | ---
Debug single Vuser | Run the script in debug mode with 1 Vuser. |
Generate script | Generate a script from a HAR file. | Offline Script Generator tool
Record script | Run the DevWeb Proxy Recorder to record a HAR file | DevWeb Proxy Recorder
Regenerate script | Regenerate the DevWeb script |
Run single Vuser | Run the script in single mode with 1 Vuser. | Run scripts locally
Run single Vuser In Iterations | Run the script with iterations with 1 Vuser. | Run scripts locally
Run load | Run the script in load mode with up to 50 Vusers. | Run scripts locally
Generate script with Swagger API functions | Generate a script in Swagger mode. | Swagger API testing
Generate Swagger API functions | Generate a swaggerApi.js file. | Swagger API testing
Get distribution list from OpenText Performance Engineering Core | Display a list of cloud locations available for the test. | Run tests on OpenText Core Performance Engineering
Generate gRPC API functions | Generate gRPC functions for your test. |
Get load generator list from OpenText Performance Engineering Core | Display a list of OPLG machines available for the test. | Run tests on OpenText Core Performance Engineering
Run test on OpenText Performance Engineering Core | Run load test on OpenText Core Performance Engineering. | Run tests on OpenText Core Performance Engineering
Get test run results from OpenText Performance Engineering Core | Get results for a load test. | Run tests on OpenText Core Performance Engineering
Run test on OpenText Performance Engineering for Enterprise | Run load test on OpenText Enterprise Performance Engineering. | Run tests on OpenText Enterprise Performance Engineering
Get test run results from OpenText Performance Engineering for Enterprise | Get results for a load test. | Run tests on OpenText Enterprise Performance Engineering

## See also

- Scripting with your IDE
- Scale tests from your IDE
- Run scripts

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