A license is required to use Parasoft SOAtest and Virtualize Server. If you have access to the machine where the WAR is deployed, you can edit the <SOAVIRT_HOME>/WEB-INF/config.properties file to configure your license settings before launching the server. If you do not have access to the file or are configuring the server as part of an automated process, you can use the REST API set license settings.
The Virtualize module of the server provides communication with Continuous Testing Platform, remote management, and access to the REST API. A Virtualize license is required to access this set of functionalities.
The SOAtest module of the server provides the ability to execute tests. A SOAtest license is required to access this functionality.
At a minimum, you need at least one product license to use the server.
In this section:
Using a Machine-locked License
Configure the following settings to use a local license:
virtualize.license.use_network=false virtualize.license.local.password=<password sent to you from Parasoft> virtualize.license.local.expiration=<expiration sent to you from Parasoft> soatest.license.use_network=false soatest.license.local.password=<password sent to you from Parasoft> soatest.license.local.expiration=<expiration sent to you from Parasoft>
See Server Configuration for details on license settings. For advanced configuration, see Advanced Server Configuration Options.
Using a License Server License
Configure the following settings to use a license from License Server:
license.network.host=<hostname where License Server is deployed> license.network.port=<port number for your License Server> virtualize.license.use_network=true virtualize.license.network.edition=performance_server_edition virtualize.license.custom_edition_features=<comma-separated list of features> virtualize.license.enabled=true soatest.license.use_network=true soatest.license.network.edition=server_edition soatest.license.custom_edition_features=<comma-separated list of features> soatest.license.enabled=true
Contact your Parasoft representative to determine the type of license your organization has purchased (e.g., server_edition). If you are using a custom edition, you need to at least specify the Service Enabled feature for Virtualize and/or the Server API Enabled feature for SOAtest.
license.network.host=<hostname where License Server is deployed> license.network.port=<port number for your License Server> virtualize.license.use_network=true virtualize.license.network.edition=performance_server_edition virtualize.license.custom_edition_features=<comma-separated list of features> virtualize.license.enabled=true soatest.license.enabled=false
license.network.host=<hostname where License Server is deployed> license.network.port=<port number for your License Server> virtualize.license.enabled=false soatest.license.use_network=true soatest.license.network.edition=server_edition soatest.license.custom_edition_features=<comma-separated list of features> soatest.license.enabled=true
See Server Configuration for additional information. For advanced configuration, see Advanced Server Configuration Options.
Using a DTP License
SOAtest and Virtualize Server supports licenses from Parasoft Development Testing Platform. Configure the following settings to use a license from DTP:
virtualize.license.use_network=true soatest.license.user_network=true dtp.server=<hostname where DTP is deployed> dtp.port=<port number for your DTP deployment> dtp.user=<username for account on DTP> dtp.password=<password for account on DTP>
See Server Configuration for additional information. For advanced configuration, see Advanced Server Configuration Options.
Setting a License After Starting the Server
You can set the license for the server using the REST API. You can also use the API to configure the connection to CTP (see the env.manager.* settings in Server Configuration).
- Start the server and go to the endpoint for writing to the .properties file:
http://<host>:<port>/soavirt/api/v5#!/preferences/preferencesPUT_config
- Enter your license setting as a JSON object into the input field and click Try it out!. The documentation describes the structure of the valid objects. See the Example Requests for examples that you can copy and paste into the UI. The following example sets a network license:
- If the license is valid and the parameters are set correctly, the API will return the appropriate response.
- Call the following endpoint by clicking the Try it out! button to verify the license has been set successfully:
http://<host>:<port>/soavirt/api#!/status/statusGET
This will show information about the server host and the state of each license feature.
Example Requests
You can copy and paste the following JSON examples into your REST API endpoint to help you get started. Change the host, port, and any feature settings to match your license.
{
"license": {
"licenseServer": {
"host": "<your-LS-host>",
"port": <your-LS-port>
},
"virtualize": {
"enabled": true,
"useNetwork": true,
"network": {
"edition": "performance_server_edition"
}
},
"soatest": {
"enabled": true,
"useNetwork": true,
"network": {
"edition": "server_edition"
}
}
}
}
{
"license": {
"licenseServer": {
"host": "<your-LS-host>",
"port": <your-LS-port>
},
"virtualize": {
"enabled": true,
"useNetwork": true,
"network": {
"edition": "performance_server_edition"
}
},
"soatest": {
"enabled": false
}
}
}
{
"license": {
"licenseServer": {
"host": "<your-LS-host>",
"port": <your-LS-port>
},
"virtualize": {
"enabled": false
},
"soatest": {
"enabled": true,
"useNetwork": true,
"network": {
"edition": "server_edition"
}
}
}
}
{
"license": {
"licenseServer": {
"host": "<your-LS-host>",
"port": <your-LS-port>
},
"virtualize": {
"enabled": true,
"useNetwork": true,
"network": {
"edition": "custom_edition",
"customFeatures": [
"<comma-separated-list-of-features>"
]
}
},
"soatest": {
"enabled": true,
"useNetwork": true,
"network": {
"edition": "custom_edition",
"customFeatures": [
"<comma-separated-list-of-features>"
]
}
}
}
}
{
"license": {
"dtp": {
"host": "<your-DTP-host>",
"port": <your-DTP-port>,
"username": "<your-DTP-username>",
"password": "<your-DTP-password>"
},
"virtualize": {
"enabled": true,
"useNetwork": true,
"network": {
"edition": "performance_server_edition"
}
}
}
}
{
"license": {
"dtp": {
"host": "<your-DTP-host>",
"port": <your-DTP-port>,
"username": "<your-DTP-username>",
"password": "<your-DTP-password>"
},
"virtualize": {
"enabled": true,
"useNetwork": true,
"network": {
"edition": "performance_server_edition"
}
},
"soatest": {
"enabled": true,
"useNetwork": true,
"network": {
"edition": "server_edition"
}
}
}
}
