Configure the VSE Recorder in the Workstation to capture HTTP/S transactions

Document ID : KB000108940
Last Modified Date : 18/10/2018
Show Technical Document Details
This document describes the basic steps to configure the VSE Recorder in the Workstation to capture HTTP/S transactions.
Start DevTest Workstation.
To start the VSE Recorder you can:
1. Select the VSE Recorder icon:
User-added image
2. Select the "By Recording" option from the File, New menu:
User-added image
3. Right Click in the Images folder and select the option 'Create New VS Image" and "By recording".
User-added image

The VSE Recorder window will open.
Provide the Basic information:
Write image to: this will be the name of the VSI file.
Transport Protocol: select HTTP/S
Export to: provide the path and the name of a file which the raw traffic will be saved.
Model File: this will be the name of the VSM file.
Select Next.
User-added image

In the next screen, provide the following fields:
Listen/ Record on port: by default is it 8001, you can change the Listen port as needed.
Target Host: the address of the live endpoint. The name or IP address of the target host where the service runs.
Target Port: the target port number. The port which the service is listening.
If the target endpoint is using SSL, we will need to select Use SSL to Server. In this case, the communication between the VSE Recorder and the server will be over SSL.
If client authentication is required ( mutual authentication, 2-way SSL) provide the client keystore under Use SSL to server, SSL keystore file and Keystore password.
If client authentication is not required (one-way SSL), there is no need to change the default keystore - webreckeys.ks, provided with the property ssl.client.cert.path.

When the option Use SSL to client is enabled, the communication between the client application and the VSE Recorder will be over SSL.
By default, the VSE Recorder will present the key under ssl.server.cert.path property to the client application.
If the client application does not accept this keystore, you can provide a valid key under Use SSL to client, SSL keystore file and Keystore password.

It is possible to leave Use SSL to server enabled only. In this case, the client application needs to send a HTTP request to the VSE Recorder, and the VSE Recorder forwards a HTTPS request to the target endpoint.
Select Next.
User-added image

In the next screen, the VSE Recorder will be listening for requests:
VSE Recorder 2

At this point, the VSE Recorder will be listening for transactions.
Configure the client application to send requests to the host where the VSE Recording is running.
If the client application and the VSE Recorder are running on the same host, you can use localhost or your local hostname or IP address.
In the example below, I am using a test step to send a request to the VSE Recorder
User-added image

After the transactions are captured, proceed with the recording.
Select Next
User-added image

In the next window provide a base path, if it was not already provided.
More information regarding base path can be found in the link below:
What is the base path in the Virtual Service Model?  -
User-added image

In the next screen, select the Data Protocol Handlers as needed.
In this sample, the SOAP DPH was automatically selected.
For more information regarding Data Protocol Handers, please use the link below:
Using Data Protocols
Select Next.
User-added image

Depending on the DPH selected and the type of transactions captured, the next screen will allow you to configure the transactions and arguments.
In the screen below we can select which transaction will be the conversation starter and the token identification.
If the transactions are stateless there is no need to select a conversation starter and token.
For more information regarding conversational and stateless transactions, please use the link below:
Stateless and Conversational VSE Transactions
Select Next.
User-added image

In the next screen select 'Open the service image' and 'Open the generated virtual service model', with these options both VSI and VSM will open after we select the Finish button.
The Save icon at the bottom of the screen let us save the recording session definition (VRS file) to a local file.
For more information regarding VRS file, please use the link below:
What is a VRS file and how to create it using DevTest Workstation -
Select Finish to end the recording process.
User-added image