You can configure Parasoft Virtualize Server using a properties file. The default location of the properties file is <SOAVIRT_HOME>/WEB-INF/config.properties.
Use Forward Slashes, Not Backslashes
When editing Windows file paths in config.properties, be sure to use forward slashes, not backslashes.
Correct: c:/my/workspace
Incorrect: c:\my\workspace
Several options can be specified in the config.properties file. The following is a list of the most commonly-specified options. See Advanced Virtualize Server Configuration Options for additional options.
In this section:
Base Configuration Options
- working.dir
- logging.config.file
- scripting.timeout.minutes
- server.port.http
- server.port.https
- env.manager.server
- env.manager.server. name
- env.manager.username
- env.manager.password
- env.manager.notify
- env.manager.registry.id
- virtualize.license.use_network
- virtualize.license.network.edition
- virtualize.license.custom_edition_features
- dtp.server
- dtp.port
- dtp.user
- dtp.password
- license.network.host
- license.network.port
- virtualize.license.local.password
- virtualize.license.local.expiration
working.dir
This option specifies an absolute path to the SOAVIRT working directory. If not specified, a default working directory called ‘workspace’ is created in the <SOAVIRT_HOME> folder. We recommend changing the default directory so that the workspace is not under the <SOAVIRT_HOME> folder because upgrading to a newer version of the server could overwrite the workspace.
logging.config.file
This option changes the logging level using a built-in or custom log4j configuration. If not specified, the default value is /WEB-INF/default.logging.xml.
You can specify a configuration using an absolute path or a relative path. The root for relative paths is the <SOAVIRT_HOME> directory location. The server ships with two built-in configurations available in the /WEB-INF/ folder:
- default.logging.xml: A standard log4j configuration that logs only errors.
- debug.logging.xml: A standard log4j configuration that provides verbose logging with extended details.
You can modify these built-in configurations as needed; see the log4j documentation for details.
Example Usage
logging.config.file=/WEB-INF/default.logging.xml
If you unzipped the WAR into c:/wars/soavirt, the server would resolve the relative location of logging.config.file to the absolute path c:/wars/soavirt/WEB-INF/default.logging.xml.
logging.config.file=d:/MyConfigurations/default.logging.xml
scripting.timeout.minutes
This option specifies the number of minutes after which Virtualize will attempt to stop an unresponsive script and log an error message. The default is 10 minutes.
Example Usage
scripting.timeout.minutes=5
server.port.http
This option tells CTP which port Parasoft Virtualize Server is listening to for HTTP. You must specify either server.port.http or server.port.https port. This value must match the HTTP port under which Parasoft Virtualize Server is deployed.
server.port.https
This option tells CTP which port Parasoft Virtualize Server is listening to for HTTPS. You must specify either server.port.https or server.port.http port. This value must match the HTTPS port under which Parasoft Virtualize Server is deployed.
env.manager.server
This option specifies the location of the CTP server. Be sure to specify the port and protocol (http/ https). Colons must be escaped with the backslash \ character.
Example Usage
env.manager.server=http\://em.parasoft.com \:8080/
env.manager.server=https\://em.parasoft.com \:9443/
env.manager.server. name
This option specifies the name that will be used to label this server on CTP. You can use any value that helps you identify this server.
Example Usage
env.manager.server.name=MyVirtServerLabel
env.manager.username
This option specifies the username for logging into CTP.
Example Usage
env.manager.username=me
env.manager.password
This option specifies the (plain text or encoded) password for logging into CTP.
As with the standard Eclipse-based Parasoft products, you can use the –encodepass <plain password>
option in the virtualizecli command line (from the Eclipse-based server) to generate an encoded version of a given password.
Example Usage
env.manager.password=12345
env.manager.notify
This option enables/disables notifications to Parasoft CTP when virtual assets are deployed.
Example Usage
The following example enables notifications:
env.manager.notify=true
env.manager.registry.id
This is a read-only setting used by CTP.
virtualize.license.use_network
This option enables/disables licensing over a network. If you are using a network license, you must also configure either a connection to License Server or Parasoft Development Testing Platform (DTP).
Configure the following options to connect to DTP:
Configure the following options to connect to License Server:
Example Usage
The following example enables licensing over a network:
virtualize.license.use_network=true
virtualize.license.network.edition
This option specifies the type of license to retrieve from DTP or License Server. You can specify either custom_edition
or professional_ edition
. Contact your Parasoft representative if you are unsure of which edition you should set.
Example Usage
virtualize.license.network.edition=custom_edition
virtualize.license.custom_edition_features
This option specifies a comma separated list of features that should be requested for a custom edition license from DTP or License Server. Contact your Parasoft representative if you are unsure of which features you should specify.
Example Usage
virtualize.license.custom_edition_features=Virtualize,Validate,Performance,Extension Pack,Service Enabled,Unlimited Hits/Day
dtp.server
This option specifies the host name of the DTP server. You must also set the virtualize.license.use_network
option to true
(see virtualize.license.use_network).
Example Usage
dtp.server=main1.parasoft.com
dtp.port
This option specifies the port number of the DTP server. You must also set the virtualize.license.use_network
option to true
(see virtualize.license.use_network).
Example Usage
dtp.port=8080
dtp.user
This option specifies the user name for DTP authentication.You must also set the virtualize.license.use_network
option to true
(see virtualize.license.use_network).
Example Usage
dtp.user=admin
dtp.password
This option specifies the password for DTP authentication.You must also set the virtualize.license.use_network
option to true
(see virtualize.license.use_network).
Example Usage
dtp.user=mypassword
license.network.host
This option specifies the host name of the License Server. You must also set the virtualize.license.use_network
option to true
(see virtualize.license.use_network).
license.network.port
This option specifies the host port of the License Server. You must also set the virtualize.license.use_network
option to true
(see virtualize.license.use_network).
virtualize.license.local.password
This option specifies the password for the local Virtualize license. You must also set the virtualize.license.use_network
option to false
(see virtualize.license.use_network).
virtualize.license.local.expiration
This option specifies an expiration for the local Virtualize license. You must also set the virtualize.license.use_network
option to false
(see virtualize.license.use_network).
Adding Custom/External Jars
You can make external/custom jars (e.g., Parasoft SOAtest/Virtualize custom extensions, third-party jars, JDBC drivers, etc.) available to Parasoft Virtualize Server.
- Add the jar(s) using one of the following methods:
- Copy the jar(s) into the <workspace>/VirtualAssets/system_jars folder, which is where Parasoft Virtualize Server searches for custom/external jar files to load. Add this folder if it does not already exist.
- Upload the jar(s) using the REST API upload operation (/v5/files/upload) as described in the Swagger documentation (see API Usage). The upload should specify the /VirtualAssets/system_jars as the parent folder. The /VirtualAssets/system_jars folder will be created if it did not already exist.
- Reload the jars using one of the following methods:
- If the jars contain Virtualize custom extensions, restart the server.
- Otherwise, either restart the server or call the /v5/preferences/systemProperties/reload REST API.
Additional Configuration Notes
If you want to modify the value of the "Server" HTTP Header in Parasoft Virtualize Server's HTTP Response to ‘Parasoft Server’ (this is the default for traditional Eclipse-based Virtualize server deployments), you need to modify the servlet container configuration.
Some servlet containers reject Trace requests (i.e., HTTP requests using the TRACE HTTP method). If your servlet container rejects Trace requests but you want Parasoft Virtualize Server to support Trace requests (like traditional Eclipse-based Virtualize Server deployments do), you will need to update your servlet container configuration accordingly.