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 to set license settings. In this section:

Encoding Your Password

A user name and password is required to request a license from License Server or DTP for SOAtest and Virtualize Server. We strongly recommend encoding your password to ensure successful authentication and a secure connection. You can encode your password by running a command line instance of SOAtest or Virtualize with the -encodepass flag. The command line tool will generate an encoded string that you can use in the configuration file. Examples:

soatestcli.exe -encodepass <your_password> 

virtualizecli.exe -encodepass <your_password> 

The command line tool will generate an encoded string that you can use in place of the password property in the SOAtest and Virtualize Server configuration file. See CLI Options for additional information. 

Using a License Server License

Configure the following settings to use a license from License Server:

license.network.use.specified.server=true
license.network.url=<URL for 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. If your server uses the HTTPS protocol, prepend https:// to the hostname in license.network.host.

license.network.use.specified.server=true
license.network.url=<URL for 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

If your server uses the HTTPS protocol, prepend https:// to the hostname in license.network.host.

license.network.use.specified.server=true
license.network.url=<URL for 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

If your server uses the HTTPS protocol, prepend https:// to the hostname in license.network.host.

See Configuring Virtualize Server for additional information. For advanced configuration, see Advanced Server Configuration Options.

Using a DTP License

You can connect the SOAtest and Virtualize Server to Parasoft DTP to retrieve a license.     

license.network.use.specified.server=false
virtualize.license.use_network=true
soatest.license.use_network=true

dtp.url=<URL for DTP>
dtp.user=<username for account on DTP>
dtp.password=<password for account on DTP>

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>

soatest.license.use_network=false
soatest.license.local.password=<password sent to you from Parasoft>

See Configuring Virtualize Server for details on license settings. For advanced configuration, see Advanced Server Configuration Options. 

End User License Agreement Acceptance

Set the following property to accept the Parasoft End User License Agreement (please read the EULA at https://www.parasoft.com/license):

parasoft.eula.accepted=true

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 Configuring Virtualize Server).

1. Start the server and open the documentation for the preferences endpoint:
   
   http://<host>:<port>/soavirt/api/v6#!/preferences/preferencesPUT_config
    
2. Click Try it out and enter your license settings as a JSON object into the New configuration input field. The documentation describes the structure of the valid objects. See the Example Requests for examples that you can copy and paste into the UI. 
   
3. Click Execute to send the request. The response body will include the configuration settings with passwords removed:
   
4. Send a GET request to the status endpoint 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": "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"
      }
    }
  }
}