...

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:

...

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.connection.type=http
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 Configuring Virtualize Server Configuration 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.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>

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 Configuration for details on license settings. 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 Configuring Virtualize Server Configuration).

1. Start the server and open the documentation for the preferences endpoint:
   
   http://<host>:<port>/soavirt/api/v6#!/preferences/preferencesPUT_config
    
2. 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 Licensing the Server Example Requests for examples that you can copy and paste into the UI. The following example sets a network license:
   
3. If the license is valid and the parameters are set correctly, the API will return the appropriate response.
   
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.

...