Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space FUNCTDEV and version SVC2024.1

...

Option
Description
Traffic file

Specify where you want to save the traffic data that will be captured when the proxy is set to record mode. You can later use this traffic file to generate virtual assets that represent the live traffic captured in record mode.

By default, traffic will be recorded in a file named %n_%d_%t.txt (<proxy_name>_<current_date>_<current_time>.txt) and will be stored within the recorded_traffic folder (this will be created if it does not exist). The traffic file must be inside the VirtualAssets project when provisioning an instance that contains the message proxy. If set a location outside of the VirtualAssets project, the provision request (PUT request) will fail. CTP, however, can read a traffic file (GET request) that is outside of the VirtualAssets project when the proxy was configured with Virtualize.

When specifying the file name, you can use variables such as %d (current date) %t (current time), %n (proxy name), and %u (unique time-based id). Wildcards can be used together and mixed in with the name. For example, you could use %nProxyTraffic%d or %u_%d%nTraffic.

Do not configure multiple proxy connections to write to the same traffic file at the same time. This could corrupt the traffic file. 


Append traffic dataEnable this option to add new traffic data to an existing traffic file (the one specified in the Traffic file field). If the specified file does not already exist, a new file will be created
Use HTTP listener

Enable this option to specify a port specific to your proxy.

If the client sends traffic over SSL, enable the Secure option and specify your verification options:

  • Enable Use Keystore and specify the server-side authentication settings.
  • Enable Perform client authentication and specify the trust store verification settings.
Info
titleVersion Compatibility

Virtualize 9.10.4 or newer is required to use HTTP listeners.

You can configure one listener per proxy. If you want to use multiple HTTP listeners, you must create multiple components and configure them separately. For additional information about HTTP listeners, see the Virtualize Desktop documentation.

Proxy listen path

Enter the path where the proxy should listen for incoming connections. No two message proxies can have HTTP connections with the same proxy path or with a path that matches an existing virtual asset’s HTTP path.

In the simplest case, you can set the Proxy listen path to your service's path and leave the Service forward path setting empty. With this configuration, the proxy will automatically forward all messages it receives on that path to the same path at the Service host and Service port.

If you need the proxy to listen on a different path than the path of your service, set Service forward path to the actual path where you want the received messages to be sent. The proxy will forward the path and any query parts to the target service.

If the Proxy listen path and the Service forward path are different, then any segments in the request after the Proxy listen path will be appended to the forwarded request. The Proxy listen path is essentially being replaced with the Service forward path so that the entire path (as received by the proxy) gets sent to the service.

ModeDetermines whether the Primary or Secondary forwarding connection is active when both exist. The non-active connection can be used as a fallback connection if the active connection fails (see "Use Fallback Connection" below). For example, during a recording session, you might want a message proxy to forward to the live service as the primary connection and fall back to a virtual service as a secondary connection. In this case, you can set the mode to Primary and enable Use Fallback Connection, which will cause CTP to use the secondary connection if the primary mode fails.
Use for Recording
Determines which forwarding connection is used for recording, when both Primary and Secondary connections are defined. Must be enabled for one, but can be enabled for both. The precise behavior varies slightly depending on which connection or connections are being used for recording:
  • Both connections: Records traffic for both the primary and secondary connections. Error messages from the active connection will not be recorded; instead, the messages will be sent to the backup connection and the responses will be recorded. Errors reported by the backup will be recorded.
  • Primary connection only: Records traffic for the active connection. Does not record errors.
  • Secondary connection only: Records traffic for the backup connection, including errors.
Service host
Enter the host name of the machine where the service resides. This is the machine to which the proxy will send messages.
If you want the proxy to forward to a virtual asset on the local Virtualize server without consuming an HTTP connection, enter localhost or 127.0.0.1 rather than the actual host name.
Service port
Enter the port where the service is listening. This is the port to which the proxy will send messages.
Service forward path
(Optional) Enter the path to which the proxy should forward the messages that it receives. If blank, this defaults to the value in the Proxy listen path field. If the HTTP proxy is sending messages to localhost, you must enter a Service forward path because the proxy doesn't allow forwarding to itself. If the Service forward path sends a redirect, the proxy will follow the redirect and then respond. It will not pass the redirect back to the client.
Additional options
  • Use fallback connection: If you want traffic to be redirected to a fallback connection (e.g., a secondary proxy endpoint) when the primary connection fails or the responder/virtual asset is not available, enable this option. See the section below for details.
  • Valid response codes: Allows you to customize the message proxy's failover behavior so that it succeeds with HTTP response codes outside the 2xx range. Specify single codes and/or code ranges as a comma-separated list. For example, if you use "404, 500-599", a 404 code or any code in the 5xx range will be accepted. This option is only available when Use fallback connection is enabled.
  • Learn responses: If the service you are virtualizing has an internal endpoint that is a files responder (see Request/Response Files for more information) and you want it to learn to emulate the responses recorded from a live endpoint, enable this option. This option is only available when Use fallback connection is enabled.
  • Use SSL when connecting to the server: If the service you are virtualizing uses SSL, enable this option and complete the fields that display.
  • Use NTLM: If the service you are virtualizing uses SSL, enable this option and complete the fields that display.
  • Use Kerberos service: If your service requires Kerberos authentication, enable this option and specify the service principal to authenticate the request.
  • Use proxy server: If you want to specify a server for the message proxy, which allows you to configure a different proxy server for traffic to and from different message proxies, enable this option. This configuration provides control over which proxy server handles traffic between the application under test and a specific message proxy. Provide the appropriate details in the proxy configuration fields that appear when you enable the option. SSL is not supported.
     

...