Versions Compared

Key

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

...

Scroll Table Layout
widths30%,70%

env_var

This variable specifies the value of an environmental variable. Use a colon followed by the name of a system environment variable before the closing curly brace to output the value of the environment variable.

Example:

session.id=${env_var:HOME}

project_name

Outputs the name of the tested project. If more than one project is provided as an input, the name of the project tested is printed followed by an ellipsis (...).

Example:

build.id=${dtp_project}-${time}

general_project

Outputs the name of the general DTP project to which results are linked. Only applies when connected to DTP. 

Example:

build.id=${general_project}

workspace_name

Outputs the workspace name or Visual Studio solution name.

Example:

report.mail.subject=Code Review Scanner Results for ${workspace_name}

config_name

Outputs the name of executed test configuration. Only applies to reports and email settings.

Example:

report.mail.subject=Findings from running ${config_name} on the ${project_name}

analysis_type

Outputs a comma-separated list of enabled analysis types (for example: Static, Execution). Only applies to reports and email settings.

Example:

report.mail.subject=${analysis_type} findings

tool_name

Outputs the name of the tool.

Example:

report.mail.subject=Tests executed by ${tool_name}

time

Outputs the current time. The default is yyyy-MM-dd. You can customize the format, for example:

${time:yyyy-MM-dd-HH.mm}

...

  • Each setting should be entered on a single line.
  • If a parameter is specified in settings, it will override the related parameter specified from the GUI. If a parameter is not specified in settings, the parameter specified in the GUI will be used.
  • If you are importing preferences from settings specified in DTP and you want to override these settings from the GUI, you can disable the Use DTP settings option on the appropriate page, then manually configure the settings.
  • If any settings problems are detected during a test run, details will be reported in the command line output.
  • If you are running cli mode from a developer/tester desktop (as opposed to from a Server machine), use the tasks.clear=false option to ensure that your results from previous runs are preserved.

...

Anchor
ApplicationCoverageSettings
ApplicationCoverageSettings
Application Coverage Settings

SettingPurpose
build.id

Specifies a build identifier used to label results. It may be unique for each build but may also label more than one test sessions that were executed during a specified build. The maximum length for a build ID is 128 characters.

Default:  ${dtp_project}-${time:yyyy-MM-dd}

report.active_rules=true|false

Determines if the reports contain a list of the rules that were enabled for the test.

Default: false

report.archive=true|false

Enables the generation of an additional compressed archive (.zip) file in the specified report location. The ZIP file contains all the files generated to build the report. 

This option can generate an archive for any report format (for example, HTML, CSV, PDF, and so forth). 

By generating an archive, you can also perform custom transformations of the report because all of the elements are generated to the specified destination folder.

Default: false

report.associations=true|false

Specifies whether the report shows requirements, defects, tasks, and feature requests that are associated with a test.

Default: false

report.authors_details=true|false

Determines whether the report includes an overview of the number and type of tasks assigned to each team member. 

Default: true

report.contexts_details=true|false

Determines whether the report includes an overview of the files that were checked or executed during testing.

Default: false

report.coverage.version=1|2

Specifies the version of the XML coverage report. Acceptable values are:

1 - The basic (legacy) coverage report.

2 - The optimized XML report. 

Default is 2

report.custom.extension

report.custom.xsl.file

Specifies the location and extension of the XSL file for a custom format. Used with report.format=custom

For details and examples, seeConfiguring Reporting Settings.report.developer_errors=true|false

Determines whether manager reports include details about team member tasks.

Default: false

report.developer_reports=true|false

Determines whether the system generates detailed reports for all team members (in addition to a summary report for managers). 

Default: true

report.format=html|pdf|sate|xunit|custom

Specifies the report format. Available formats are HTML, PDF, SATE, XUnit, and custom. To generate multiple reports in different formats for a single run, enter a comma-separated list. If you have the "Command Line" license feature enabled, XML reports are generated and saved in addition to the report formats specified. For example:

report.format=html,pdf,xunit

Default: html

report.mail.attachments=true|false

Determines whether reports are sent as attachments. All components are included as attachments; before you can view an HTML report with images, all attachments must be saved to the disk.

Default: false

report.mail.cc=[email_addresses]Specifies where to mail comprehensive manager reports. This setting must be followed by a semicolon-separated list of email addresses. This setting is typically used to send reports to managers or architects. It can also be used to send comprehensive reports to team members if such reports are not sent automatically.report.mail.compact=trends|links

Specifies that you want to email a compact report or link rather than a complete report. 

If trends is used, the email contains a trend graphs, summary tables, and other compact data; detailed data is not included.

If links is used, the email contains only a link to a report (which is available on DTP)

report.mail.domain=[domain]Specifies the mail domain used to send reports.report.mail.enabled=true|false

Determines whether reports are emailed to team members and to the additional recipients specified with the cc setting. 

Remember that each team member with assigned tasks will automatically be sent a report that contains only the assigned tasks.  

Default: false

report.mail.exclude=[email_addresses]Specifies any email addresses you do not want to receive reports. This setting is used to prevent automated sending of reports to someone that worked on the code but should not be receiving reports.report.mail.exclude.developers=true|false

Specifies whether reports should be mailed to any team member whose email is not explicitly listed in the report.mail.cc property. This setting is used to prevent reports from being mailed to individual team members.

Default: false

report.mail.format=html|ascii

Specifies the email format. Available formats are HTML and ASCII.

Default: html

report.mail.from=[email_address OR user_name_of_the_same_domain]

Specifies the "from" line of the emails sent.

Default: <global_user_name>

report.mail.include=[email_addresses]Specifies the email addresses of team members that you want to receive individual reports. This setting must be followed by a semicolon-separated list of email addresses. This setting is typically used to send individual reports to team members if such reports are not sent automatically (for example, because the team is not using a supported source control system). It overrides team members specified in the 'exclude' list. report.mail.on.error.only=true|false

Determines whether reports are sent to the manager only if a task is generated or a fatal exception occurs. Team member emails are not affected by this setting; individual emails are sent only to team members who are responsible for reported tasks.

Default: false

report.mail.port=[port]

Specifies the mail server host’s port number.

Default: 25

report.mail.security=[SL| STARTTLS| NONE]Specifies the desired security. Available settings are SSL, STARTTLS, NONE. SSL is not available in Visual Studio.report.mail.server=[server]Specifies the mail server used to send reports.report.mail.subject=My New Subject

Specifies the subject line of the emails sent. The default subject line is ${tool_name} Report - ${config_name}. For example, if you want to change the subject line to "SOAtest Report for Project A", you would use

report.mail.subject=SOAtest Report for Project A

Default: ${tool_name} Report - ${config_name}

report.mail.time_delay=[server]

Specifies a time delay between emailing reports (to avoid bulk email restrictions).

Default: 0

report.mail.unknown=[email_address OR user_name_of_the_same_domain]Specifies where to mail reports for errors assigned to "unknown".report.mail.username=[username] report.mail.password=[password] report.mail.realm=[realm]

Specifies the settings for SMTP server authentication.

The realm value is required only for those servers that authenticate using SASL realm.

report.metrics_details=true|false

Determines whether an XML report with metrics summary information (as well as individual class and method detail data where applicable) is produced. This report will be generated only when a metrics-enabled Test Configuration is run. Metrics details will be shown in HTML and PDF reports.

Default: true

report.organize_security_findings_by=CWE|OWASP2021

Specifies whether API Security reports are sorted by CWE or OWASP 2021 Top 10.

Default: CWE

report.rules=[url_path_to_rules_directory]

This setting specifies a path to the directory containing static analysis rules HTML files. Based on that path, links to rule documentation are added in HTML reports. 
The rules HTML files are provided by tools or can be generated by clicking Printable Docs in the Static tab of the Test Configuration.

To apply this setting in the GUI, you need to define it in a .properties file and then provide a path to this file in the Option file field in the Report & Publish window. For more details, see Generating Reports.

For example:

report.rules=file:///C:/Temp/Burt/parasoft/xtest/gendoc/
report.rules=../gendoc/
report.rules=file:///<TOOL_INSTALL>/rules/docs/

Default: none

report.scontrol=off|min|full

Specifies if and how much additional information from source control is included in the report.

If set to off, information from source control is not included in the report.

If set to min, the report includes information about repositories, file paths, and revisions.

If set to full, the report includes information about repositories, file paths, and revisions, as well as task revisions and comments.

Default: off

report.setup.problems=top|bottom|hidden

Determines whether reports include a section about setup problems. 

top - Adds a "Setup Problems" section to the top of the report. This is the default. 

hidden - Prevents a "Setup Problems" section from being added.

bottom - Adds a "Setup Problems" section to the bottom of the report. 

Default: bottom

report.suppressed_msgs=true|false

Determines whether reports include suppressed messages.

Default: false

report.test_params=true|false

Determines whether reports include test parameter details.

Default: false

report.test_suites_only=true|false

Determines whether the Test Suite Summary report section only lists the .tst files (with this option enabled) or displays a tree-like view of the individual tests in each .tst file (with this option disabled). SOAtest only

Default: true

report.ue_coverage_details_htmls=[coverage_type]

Determines whether a test's HTML report links to another report that includes source code annotated with line-by-line coverage details. 

The following values can be used for [coverage_type]:

LC - for line coverage

report.xml.param{n}.key=[id]

Specifies a custom parameter ID to be added to the xml report root element. The ID must be unique. Both report.xml.param{n}.key and report.xml.param{n}.value (where {n} is the same number) must be specified for the custom parameter to be added.

For example, the following configuration specifies that an attribute with the given key and value will be added to the xml report root element:

report.xml.param1.key=customId

report.xml.param1.value=12345

report.xml.param{n}.value=[value]

Specifies a custom parameter value to be added to the xml report root element. Both report.xml.param{n}.key and report.xml.param{n}.value (where {n} is the same number) must be specified for the custom parameter to be added.

For example, the following configuration specifies that an attribute with the given key and value will be added to the xml report root element:

report.xml.param1.key=customId

report.xml.param1.value=12345

session.tag=[name]

Specifies a session tag used to label these results. The tag is an identifier of the module checked during the analysis process. Reports for different modules should be marked with different tags.

Default: ${config_name}

tasks.source.control.details=true|false

This setting specifies if additional information from source control, such as revisions and comments, is included in the report.

DTP Settings

...

Enables auto-configuration using settings stored in DTP. This setting does not apply to the GUI and is ignored during import (see "-settings" or "-property" on the CLI Options page for more information about that process).

Default: false

...

Determines whether SOAtest or Virtualize is connected to DTP. 

Default: false

...

Specifies the password for DTP user authentication.

We strongly recommend encrypting your password to ensure successful authentication and a secure connection. You can encrypt your password by running a command line instance of SOAtest with the -encodepass flag. The command line tool will generate an encrypted string using AES 256-bit encryption that you can use in the configuration file. 

See CLI Options for additional information.

...

Specifies the name of the DTP project to which you want these results linked. If the project does not exist in DTP and the user specified in dtp.user has sufficient permissions to create projects, the project will be automatically created.

For more details on general projects, see Connecting to DTP.

Default: Default Project

...

Specifies whether application coverage is enabled or not.

Default: false

...

Specifies URLs where the applications under test and coverage agents are hosted. Include the protocol (HTTP/HTTPS) and port. Separate multiple entries with a semi-colon ( ; ).

Example: http\://<AGENT_HOST>\:8050;http\://<AGENT_HOST>\:9050

...

Specifies a user ID so that coverage results can be associated with a specific user. A user ID should only be specified when the coverage agent is configured to run in multi-user mode.

See the DTP Engine documentation for details.

...

Specifies whether coverage reports should be uploaded to DTP. If you have configured multiple coverage agents, their coverage reports will be merged into a single coverage report for DTP.

Defaults to the value of report.dtp.publish or to true if -publish is passed to soatestcli.

...

Specifies a comma-separated pattern of binaries to exclude during AUT scanning. Optional. Analysis of binaries will take longer and analyze more of the application than needed if not used. Do not use if application.coverage.static.file has been specified. By default, all binaries are accepted. The following wildcards are supported:

* matches zero or more characters

Example: *HelpPage*

...

Specifies a comma-separated pattern of binaries to include during AUT scanning. Optional. Analysis of binaries will take longer and analyze more of the application than needed if not used. Do not use if application.coverage.static.file has been specified. By default, all binaries are accepted. The following wildcards are supported:

* matches zero or more characters

Example: *qademo_webapp*

...

Specifies the URL or local file of the static coverage file generated with dotTEST or Jtest in the .xml or .data format. Optional. Not needed if the static coverage file is uploaded to DTP separately. Do not use if application.coverage.binaries has been specified.

See Creating a Custom Test Configuration for more information.

Example: static_coverage.xml

...

Specifies a set of tags that are used to create coverage images in DTP. A coverage image is a unique identifier for aggregating coverage data from runs with the same build ID. Separate multiple entries with a semi-colon ( ; ).

For details, see the Parasoft DTP user guide.

Example: ${dtp_project};${dtp_project}_Functional Test

...

Enables the storing of test associations with runtime coverage data. If set to false, runtime coverage data will only record which lines are covered, but not which test cases are covering which lines.

Default: true

Licensing Settings

...

Enables/disables network-based licenses.

Set to true and configure either the License Server setting (license.network.url) or the Parasoft DTP Settings to use a network license.  

Set to false and configure the soatest.license.local.password setting to use a local license.

Example: soatest.license.use_network=true

Default: true

...

Specifies the License Server URL. Remember to include the https:// protocol; License Server does not support http:// connections. If License Server is deployed to a location other than the root of the host server, the URL should include a context path (a relative path from the host name; for example: https://server.company.com:8443/contextPath). This may be the case if your organization uses a reverse proxy. Refer to the License Server documentation on https://docs.parasoft.com for additional information about reverse proxy server configuration and context path configuration.

...

Specifies the username for authentication on the Licenses Server specified with the license.network.url option.

This option requires the license.network.use.specified.server and license.network.auth.enabled options to be set to true.

Example: license.network.user=JohnDoe

...

Specifies the password for authentication on the License Server specified with the license.network.url option.

This option requires the license.network.use.specified.server and license.network.auth.enabled options to be set to true and the license.network.user to be configured.

We strongly recommend encrypting your password to ensure successful authentication and a secure connection. You can encrypt your password by running a command line instance of SOAtest with the -encodepass flag. The command line tool will generate an encrypted string using AES 256-bit encryption that you can use in the configuration file. 

See CLI Options for additional information.

...

This option enables SOAtest to connect to either DTP and License Server, or two instances of DTP simultaneously.

Set to false if you want to retrieve a license from the DTP server specified with Parasoft DTP Settings

Set to true if you want to retrieve a license from the server specified with the license.network.url option. 

...

Enables or disables authentication on the License Server specified with the license.network.url option.

This option requires the license.network.use.specified.server option to be set to true.

...

soatest.license.network.edition=[edition_name]

...

Specifies the type of license to retrieve from License Server. 

[edition_name] can be server_edition. To use a custom edition, do not set anything after the "="; simply leaving the value empty.

Example:

soatest.license.network.edition=desktop_edition

soatest.license.network.edition=server_edition

Default: custom_edition

...

Specifies the maximum number of seconds to wait for the license to be automatically configured from License Server.

Default: 20

...

Specifies the local password provided to you by Parasoft. 

...

Specifies how long to wait for a license if a license is not currently available. 

Example:

soatest.license.wait.for.tokens.time=3.

Default: 0

OIDC Settings

Info

CTP and DTP or PSTSec are required for OpenID Connect in SOAtest and Virtualize.

...

Enables or disables user authentication via OpenID Connect.

Default: false

...

Specifies the URI of the OpenID Connect server.

Example: oidc.issuer.uri=http://server.com/

...

Specifies the ID provided by your OpenID Connect server.

...

Specifies the application's password to the OpenID Connect server.

...

Defines a space-separated list of scopes, which are used during authentication to authorize access to a user's details.

Default: openid profile offline_access

...

Specifies the method that will be used to authenticate the user on the OpenID Connect server.

Default: devicecode

...

Specifies the path to the custom token file containing user authentication information.

Example: oidc.devicecode.token.file=C:\\parasoft\\token

...

Specifies the path to the keystore file that stores the certificate to authenticate the user on the OpenID Connect server. If only FIPS-approved algorithms are allowed, the keystore file must be in BCFKS (Bouncy Castle FIPS Keystore) format.

Example: oidc.keystore=C:\\parasoft\\certificates\\client_keystore.jks

...

Specifies the alias you want to use to authenticate on the OpenID Connect server. You may need to configure this setting if your keystore file contains multiple entries.

Example: oidc.keystore.alias=myalias

...

We strongly recommend encrypting your password to ensure successful authentication and a secure connection. You can encrypt your password by running a command line instance of SOAtest with the -encodepass flag. The command line tool will generate an encrypted string using AES 256-bit encryption that you can use in the configuration file. 

Example: oidc.keystore.password=myPassword0987

application.coverage.enabled=true|false

Specifies whether application coverage is enabled or not.

Default: false

application.coverage.agent.url=[url]

Specifies URLs where the applications under test and coverage agents are hosted. Include the protocol (HTTP/HTTPS) and port. Separate multiple entries with a semi-colon ( ; ).

Example: http\://<AGENT_HOST>\:8050;http\://<AGENT_HOST>\:9050

application.coverage.user.id=[username]

Specifies a user ID so that coverage results can be associated with a specific user. A user ID should only be specified when the coverage agent is configured to run in multi-user mode.

See the DTP Engine documentation for details.

application.coverage.dtp.publish=true|false

Specifies whether coverage reports should be uploaded to DTP. If you have configured multiple coverage agents, their coverage reports will be merged into a single coverage report for DTP.

Defaults to the value of report.dtp.publish or to true if -publish is passed to soatestcli.

application.coverage.binaries=[file|URL] Specifies the URL or local file that contains binaries of the application under test (AUT). You can specify the path to a folder or a .war, .jar, .zip, or .ear file. Optional. Not needed if the static coverage file is uploaded to DTP separately. Do not use if application.coverage.static.file has been specified.
application.coverage.binaries.exclude=[pattern]

Specifies a comma-separated pattern of binaries to exclude during AUT scanning. Optional. Analysis of binaries will take longer and analyze more of the application than needed if not used. Do not use if application.coverage.static.file has been specified. By default, all binaries are accepted. The following wildcards are supported:

* matches zero or more characters

Example: *HelpPage*

application.coverage.binaries.include=[pattern]

Specifies a comma-separated pattern of binaries to include during AUT scanning. Optional. Analysis of binaries will take longer and analyze more of the application than needed if not used. Do not use if application.coverage.static.file has been specified. By default, all binaries are accepted. The following wildcards are supported:

* matches zero or more characters

Example: *qademo_webapp*

application.coverage.static.file=[file|URL]

Specifies the URL or local file of the static coverage file generated with dotTEST or Jtest in the .xml or .data format. Optional. Not needed if the static coverage file is uploaded to DTP separately. Do not use if application.coverage.binaries has been specified.

See Creating a Custom Test Configuration for more information.

Example: static_coverage.xml

application.coverage.images=$[dtp_project]

Specifies a set of tags that are used to create coverage images in DTP. A coverage image is a unique identifier for aggregating coverage data from runs with the same build ID. Separate multiple entries with a semi-colon ( ; ).

For details, see the Parasoft DTP user guide.

Example: ${dtp_project};${dtp_project}_Functional Test

application.coverage.runtime.dir=[directory]Specifies a directory to which to save a copy of the runtime coverage data. If no directory is specified, runtime coverage data is not saved after processing. Optional.
application.coverage.test.associations=true|false

Enables the storing of test associations with runtime coverage data. If set to false, runtime coverage data will only record which lines are covered, but not which test cases are covering which lines.

Default: true

Authorship/Scope Settings

SettingPurpose
authors.mapping{n}=[from_user, to_user]

Specifies a specific author mapping for authors.mappings.location=local, as described above.

For example:

authors.mappings.location=local
authors.mapping1=baduser,gooduser
authors.mapping2=brokenuser,fixeduser 
authors.mapping3=olduser,newuser 

authors.user{n}=[username, email, full_name]

Specifies a specific author name and email for authors.mappings.location=local.

For example:

authors.user1=dan,dan@parasoft.com,Dan Stowe
authors.user2=jim,jim@parasoft.com,Jim White 

authors.ignore.case=true|false

Determines whether author names are case sensitive. If true, David and david will be considered the same user. If false, David and david will be considered two separate users.

Default: false

scope.sourcecontrol=true|false

Determines whether code authorship is computed-based on a data from a supported source control system. 

Default: false

scope.local=true|false

Determines whether code authorship is computed based on the local user.

Default: true

scope.recommended.computation=first|random

Determines how the Recommended Tasks are selected for each team member. You can set the following modes:

random: (default) Assigns a random number of tasks.

first: The first tasks reported are shown to each team member per day.

scope.xmlmap=true|false

Determines whether task assignment is computed based on XML files that define how you want tasks assigned for particular files or sets of files (these mappings can be specified in the GUI then saved in an XML file).

Default: true

scope.xmlmap.file=[file]Specifies the name of the XML file that defines how you want tasks assigned for particular files or sets of files.

DTP Settings

SettingPurpose
dtp.autoconfig=true|false

Enables auto-configuration using settings stored in DTP. This setting does not apply to the GUI and is ignored during import (see "-settings" or "-property" on the CLI Options page for more information about that process).

Default: false

dtp.enabled=true|false

Determines whether SOAtest or Virtualize is connected to DTP. 

Default: false

dtp.url=[url]Specifies the URL for the DTP server. Remember to include the https:// protocol; DTP does not support http:// connections. If DTP is deployed to a location other than the root of the host server, the URL should include a context path (a relative path from the host name; for example: https://server.company.com:8443/contextPath). This may be the case if your organization uses a reverse proxy. Refer to the DTP documentation on https://docs.parasoft.com for additional information about reverse proxy server configuration and context path configuration.
dtp.user=[username]Specifies the username for DTP user authentication.
dtp.password=[password]

Specifies the password for DTP user authentication.

We strongly recommend encrypting your password to ensure successful authentication and a secure connection. You can encrypt your password by running a command line instance of SOAtest with the -encodepass flag. The command line tool will generate an encrypted string using AES 256-bit encryption that you can use in the configuration file. 

See CLI Options for additional information.

report.dtp.publish=trueEnables/disables publishing test result data to DTP.
dtp.project=[project_name]

Specifies the name of the DTP project to which you want these results linked. If the project does not exist in DTP and the user specified in dtp.user has sufficient permissions to create projects, the project will be automatically created.

For more details on general projects, see Connecting to DTP.

Default: Default Project

File Encoding Settings

SettingPurpose
fileencoding.mode=default|user|auto

Defines how file encoding is calculated. 

default specifies that you want to use system properties.

user indicates that you will explicitly specify the encoding name (using the setting below).

auto enables automatic detection of encoding for the Far-East language specified with fileencoding.autolanguage.

Default: default

fileencoding.user-encoding=<name_of_encoding>

If fileencoding.mode is set to user, this specifies the encoding name. 

Valid names are ASCII-US, UTF-8, UTF-16, UTF-16LE, UTF-16BE or java.nio canonical name. 

It should be specified in form parasoft-dotNET-[codepagenumber]

fileencoding.auto-language=<language’s numeric_code>

If fileencoding.mode is set to auto, this specifies the language’s numeric code. Valid codes are:

  • JAPANESE = 1
  • CHINESE = 2
  • SIMPLIFIED CHINESE = 3
  • TRADITIONAL CHINESE = 4
  • KOREAN = 5

Licensing Settings

SettingPurpose
soatest.license.use_network=true|false

Enables/disables network-based licenses.

Set to true and configure either the License Server setting (license.network.url) or the Parasoft DTP Settings to use a network license.  

Set to false and configure the soatest.license.local.password setting to use a local license.

Example: soatest.license.use_network=true

Default: true

license.network.url=[url]

Specifies the License Server URL. Remember to include the https:// protocol; License Server does not support http:// connections. If License Server is deployed to a location other than the root of the host server, the URL should include a context path (a relative path from the host name; for example: https://server.company.com:8443/contextPath). This may be the case if your organization uses a reverse proxy. Refer to the License Server documentation on https://docs.parasoft.com for additional information about reverse proxy server configuration and context path configuration.

license.network.user=[username] 

Specifies the username for authentication on the Licenses Server specified with the license.network.url option.

This option requires the license.network.use.specified.server and license.network.auth.enabled options to be set to true.

Example: license.network.user=JohnDoe

license.network.password=[password] 

Specifies the password for authentication on the License Server specified with the license.network.url option.

This option requires the license.network.use.specified.server and license.network.auth.enabled options to be set to true and the license.network.user to be configured.

We strongly recommend encrypting your password to ensure successful authentication and a secure connection. You can encrypt your password by running a command line instance of SOAtest with the -encodepass flag. The command line tool will generate an encrypted string using AES 256-bit encryption that you can use in the configuration file. 

See CLI Options for additional information.

license.network.use.specified.server=true|false

This option enables SOAtest to connect to either DTP and License Server, or two instances of DTP simultaneously.

Set to false if you want to retrieve a license from the DTP server specified with Parasoft DTP Settings

Set to true if you want to retrieve a license from the server specified with the license.network.url option. 

license.network.auth.enabled=true|false

Enables or disables authentication on the License Server specified with the license.network.url option.

This option requires the license.network.use.specified.server option to be set to true.

soatest.license.network.edition=[edition_name]

Specifies the type of license to retrieve from License Server. 

[edition_name] can be server_edition. To use a custom edition, do not set anything after the "="; simply leave the value empty.

Example:

soatest.license.network.edition=desktop_edition

soatest.license.network.edition=server_edition

Default: custom_edition

soatest.license.autoconf.timeout=[seconds]

Specifies the maximum number of seconds to wait for the license to be automatically configured from License Server.

Default: 20

soatest.license.local.password=[password]

Specifies the local password provided to you by Parasoft. 

soatest.license.wait.for.tokens.time=[time in minutes]

Specifies how long to wait for a license if a license is not currently available. 

Example:

soatest.license.wait.for.tokens.time=3.

Default: 0

LLM Provider Settings

Info

This functionality is only supported with a license that has "LLM Integration" enabled.

SettingPurpose
llm.enabled=true|false

Enables or disables usage of an LLM model through your OpenAI, Azure OpenAI, or other LLM provider account, which can be necessary if you are running a test that uses an LLM-enabled component like an AI Assertor.

Example:

llm.enabled=true

Default: false

llm.provider=[provider]

Specifies which LLM provider to use, either openai, azure.openai, or other.llm. The provider specified here will determine which of the other LLM provider settings are used (API key, model, and so on).

Example:

llm.provider=openai

Default: openai

openai.api.key=[token]

Specifies the OpenAI token to use.

openai.organization.id=[organization_ID]

Specifies the optional OpenAI organization ID to use. If no Organization ID is supplied, the default organization ID for your account will be used.

openai.model=[model]

Specifies the OpenAI model to use. See LLM Provider for a list of recommended, tested models.

Example:

openai.model=gpt-4.1

openai.embedding.model=[embedding_model]

Specifies the OpenAI embedding model to use. See LLM Provider for a list of recommended, tested models.

Example:

openai.embedding.model=text-embedding-ada-002

azure.openai.resource.name=[resource]Specifies the Azure resource that contains the deployed Azure OpenAI model.
azure.openai.api.key=[token]Specifies the Azure OpenAI token to use.
azure.openai.deployment.id=[deployment_ID]

Specifies the deployment name of the Azure OpenAI model to use.

azure.openai.embedding.deployment.id=[embedding_model]

Specifies the deployment name of the Azure OpenAI embedding model to use.

other.llm.base.url=[URL]Specifies the base URL where another LLM provider is deployed.
other.llm.api.key=[token]Specifies the token to use with another LLM provider.
other.llm.model=[model]

Specifies the model to use with another LLM provider. See LLM Provider for a list of recommended, tested models.

Example:

other.llm.model=gemini-2.0-flash

other.llm.embedding.model=[embedding_model]

Specifies the embedding model to use with another LLM provider. See LLM Provider for a list of recommended, tested models.

Example:

other.llm.embedding.model=text-embedding-ada-002

OIDC Settings

Info

CTP and DTP or PSTSec are required for OpenID Connect in SOAtest and Virtualize.

SettingPurpose
oidc.enabled=true|false

Enables or disables user authentication via OpenID Connect.

Default: false

oidc.issuer.uri=[uri]

Specifies the URI of the OpenID Connect server.

Example: oidc.issuer.uri=http://server.com/

oidc.client.id=[user]

Specifies the ID provided by your OpenID Connect server.

oidc.client.secret=[password]

Specifies the application's password to the OpenID Connect server.

oidc.scopes=[list of scopes]

Defines a space-separated list of scopes, which are used during authentication to authorize access to a user's details.

Default: openid profile offline_access

oidc.cli.mode=devicecode|certificate

Specifies the method that will be used to authenticate the user on the OpenID Connect server.

Default: devicecode

oidc.devicecode.token.file=[path]

Specifies the path to the custom token file containing user authentication information.

Example: oidc.devicecode.token.file=C:\\parasoft\\token

oidc.keystore=[path]

Specifies the path to the keystore file that stores the certificate to authenticate the user on the OpenID Connect server. If only FIPS-approved algorithms are allowed, the keystore file must be in BCFKS (Bouncy Castle FIPS Keystore) format.

Example: oidc.keystore=C:\\parasoft\\certificates\\client_keystore.jks

oidc.keystore.alias=[alias]

Specifies the alias you want to use to authenticate on the OpenID Connect server. You may need to configure this setting if your keystore file contains multiple entries.

Example: oidc.keystore.alias=myalias

oidc.keystore.password=[password]

Specifies the password to the keystore file that stores the self-signed client certificate.

We strongly recommend encrypting your password to ensure successful authentication and a secure connection. You can encrypt your password by running a command line instance of SOAtest with the -encodepass flag. The command line tool will generate an encrypted string using AES 256-bit encryption that you can use in the configuration file. 

Example: oidc.keystore.password=myPassword0987

Reporting Settings

SettingPurpose
build.id

Specifies a build identifier used to label results. It may be unique for each build but may also label more than one test sessions that were executed during a specified build. The maximum length for a build ID is 128 characters.

Default:  ${dtp_project}-${time:yyyy-MM-dd}

report.active_rules=true|false

Determines if the reports contain a list of the rules that were enabled for the test.

Default: false

report.archive=true|false

Enables the generation of an additional compressed archive (.zip) file in the specified report location. The ZIP file contains all the files generated to build the report. 

This option can generate an archive for any report format (for example, HTML, CSV, PDF, and so forth). 

By generating an archive, you can also perform custom transformations of the report because all of the elements are generated to the specified destination folder.

Default: false

report.associations=true|false

Specifies whether the report shows requirements, defects, tasks, and feature requests that are associated with a test.

Default: false

report.authors_details=true|false

Determines whether the report includes an overview of the number and type of tasks assigned to each team member. 

Default: true

report.contexts_details=true|false

Determines whether the report includes an overview of the files that were checked or executed during testing.

Default: false

report.coverage.version=1|2

Specifies the version of the XML coverage report. Acceptable values are:

1 - The basic (legacy) coverage report.

2 - The optimized XML report. 

Default is 2

report.custom.extension

report.custom.xsl.file

Specifies the location and extension of the XSL file for a custom format. Used with report.format=custom

For details and examples, seeConfiguring Reporting Settings.

report.developer_errors=true|false

Determines whether manager reports include details about team member tasks.

Default: false

report.developer_reports=true|false

Determines whether the system generates detailed reports for all team members (in addition to a summary report for managers). 

Default: true

report.format=html|pdf|sate|xunit|custom

Specifies the report format. Available formats are HTML, PDF, SATE, XUnit, and custom. To generate multiple reports in different formats for a single run, enter a comma-separated list. If you have the "Command Line" license feature enabled, XML reports are generated and saved in addition to the report formats specified. For example:

report.format=html,pdf,xunit

Default: html

report.mail.attachments=true|false

Determines whether reports are sent as attachments. All components are included as attachments; before you can view an HTML report with images, all attachments must be saved to the disk.

Default: false

report.mail.cc=[email_addresses]Specifies where to mail comprehensive manager reports. This setting must be followed by a semicolon-separated list of email addresses. This setting is typically used to send reports to managers or architects. It can also be used to send comprehensive reports to team members if such reports are not sent automatically.
report.mail.compact=trends|links

Specifies that you want to email a compact report or link rather than a complete report. 

If trends is used, the email contains a trend graphs, summary tables, and other compact data; detailed data is not included.

If links is used, the email contains only a link to a report (which is available on DTP)

report.mail.domain=[domain]Specifies the mail domain used to send reports.
report.mail.enabled=true|false

Determines whether reports are emailed to team members and to the additional recipients specified with the cc setting. 

Remember that each team member with assigned tasks will automatically be sent a report that contains only the assigned tasks.  

Default: false

report.mail.exclude=[email_addresses]Specifies any email addresses you do not want to receive reports. This setting is used to prevent automated sending of reports to someone that worked on the code but should not be receiving reports.
report.mail.exclude.developers=true|false

Specifies whether reports should be mailed to any team member whose email is not explicitly listed in the report.mail.cc property. This setting is used to prevent reports from being mailed to individual team members.

Default: false

report.mail.format=html|ascii

Specifies the email format. Available formats are HTML and ASCII.

Default: html

report.mail.from=[email_address OR user_name_of_the_same_domain]

Specifies the "from" line of the emails sent.

Default: <global_user_name>

report.mail.include=[email_addresses]Specifies the email addresses of team members that you want to receive individual reports. This setting must be followed by a semicolon-separated list of email addresses. This setting is typically used to send individual reports to team members if such reports are not sent automatically (for example, because the team is not using a supported source control system). It overrides team members specified in the 'exclude' list. 
report.mail.on.error.only=true|false

Determines whether reports are sent to the manager only if a task is generated or a fatal exception occurs. Team member emails are not affected by this setting; individual emails are sent only to team members who are responsible for reported tasks.

Default: false

report.mail.port=[port]

Specifies the mail server host’s port number.

Default: 25

report.mail.security=[SL| STARTTLS| NONE]Specifies the desired security. Available settings are SSL, STARTTLS, NONE. SSL is not available in Visual Studio.
report.mail.server=[server]Specifies the mail server used to send reports.
report.mail.subject=My New Subject

Specifies the subject line of the emails sent. The default subject line is ${tool_name} Report - ${config_name}. For example, if you want to change the subject line to "SOAtest Report for Project A", you would use

report.mail.subject=SOAtest Report for Project A

Default: ${tool_name} Report - ${config_name}

report.mail.time_delay=[server]

Specifies a time delay between emailing reports (to avoid bulk email restrictions).

Default: 0

report.mail.unknown=[email_address OR user_name_of_the_same_domain]Specifies where to mail reports for errors assigned to "unknown".
report.mail.username=[username] report.mail.password=[password] report.mail.realm=[realm]

Specifies the settings for SMTP server authentication.

The realm value is required only for those servers that authenticate using SASL realm.

report.metrics_details=true|false

Determines whether an XML report with metrics summary information (as well as individual class and method detail data where applicable) is produced. This report will be generated only when a metrics-enabled Test Configuration is run. Metrics details will be shown in HTML and PDF reports.

Default: true

report.organize_security_findings_by=CWE|OWASP2021

Specifies whether API Security reports are sorted by CWE or OWASP 2021 Top 10.

Default: CWE

report.rules=[path]

This setting specifies the path to a .zip file or directory that contains static analysis rules in HTML format. Based on that path, links to rule documentation are added in HTML reports.

The rules HTML files are provided by tools or can be generated by clicking the Printable Docs button in the Static tab of the Test Configuration.

To apply this setting in the GUI, you need to define it in a .properties file and then provide a path to this file in the Option file field in the Report & Publish window. For more details, see Generating Reports.

For example:

report.rules=file:///C:/Temp/Burt/parasoft/xtest/gendoc/

report.rules=../gendoc/

report.rules=file:///<TOOL_INSTALL>/rules/

report.rules=D:/parasoft/myrules/doc.zip

Default: none

report.scontrol=off|min|full

Specifies if and how much additional information from source control is included in the report.

If set to off, information from source control is not included in the report.

If set to min, the report includes information about repositories, file paths, and revisions.

If set to full, the report includes information about repositories, file paths, and revisions, as well as task revisions and comments.

Default: off

report.setup.problems=top|bottom|hidden

Determines whether reports include a section about setup problems. 

top - Adds a "Setup Problems" section to the top of the report. This is the default. 

hidden - Prevents a "Setup Problems" section from being added.

bottom - Adds a "Setup Problems" section to the bottom of the report. 

Default: bottom

report.suppressed_msgs=true|false

Determines whether reports include suppressed messages.

Default: false

report.test_params=true|false

Determines whether reports include test parameter details.

Default: false

report.test_suites_only=true|false

Determines whether the Test Suite Summary report section only lists the .tst files (with this option enabled) or displays a tree-like view of the individual tests in each .tst file (with this option disabled). SOAtest only

Default: true

report.ue_coverage_details_htmls=[coverage_type]

Determines whether a test's HTML report links to another report that includes source code annotated with line-by-line coverage details. 

The following values can be used for [coverage_type]:

LC - for line coverage

report.xml.param{n}.key=[id]

Specifies a custom parameter ID to be added to the xml report root element. The ID must be unique. Both report.xml.param{n}.key and report.xml.param{n}.value (where {n} is the same number) must be specified for the custom parameter to be added.

For example, the following configuration specifies that an attribute with the given key and value will be added to the xml report root element:

report.xml.param1.key=customId

report.xml.param1.value=12345

report.xml.param{n}.value=[value]

Specifies a custom parameter value to be added to the xml report root element. Both report.xml.param{n}.key and report.xml.param{n}.value (where {n} is the same number) must be specified for the custom parameter to be added.

For example, the following configuration specifies that an attribute with the given key and value will be added to the xml report root element:

report.xml.param1.key=customId

report.xml.param1.value=12345

session.tag=[name]

Specifies a session tag used to label these results. The tag is an identifier of the module checked during the analysis process. Reports for different modules should be marked with different tags.

Default: ${config_name}

tasks.source.control.details=true|false

This setting specifies if additional information from source control, such as revisions and comments, is included in the report.

Source Control Settings

Info
iconfalse
titleDefining multiple repositories of the same type

Indexes (numbered from 1 to n) must be added to the prefix if you want to define more than one repository of the same type. For example: 

scontrol.rep1.type=ccase
scontrol.rep1.ccase.vob=/vobs/myvob1

scontrol.rep2.type=ccase
scontrol.rep2.ccase.vob=/vobs/myvob2

If you are defining only one repository, you do not need to use an index. For example:

scontrol.rep.type=ccase
scontrol.rep.ccase.vob=/vobs/myvob1

Git Repository Definition Properties

PropertyDescription
scontrol.rep.type=gitGit repository type identifier.
scontrol.git.exec=Path to Git executable. If not set, assumes git command is on the path.
scontrol.rep.git.branch=The name of the branch that the source control module will use. This can be left blank and the currently checked out branch will be used.
scontrol.rep.git.url=The remote repository URL (for example, git://hostname/repo.git).
scontrol.rep.git.workspace= The directory containing the local git repository.

Perforce Repository Definition Properties

PropertyDescription
scontrol.perforce.exec=Path to external client executable (p4).
scontrol.rep.type=perforcePerforce repository type identifier. 
scontrol.rep.perforce.host=Perforce server host. 
scontrol.rep.perforce.port=Perforce server port. Default port is 1666.
scontrol.rep.perforce.login=Perforce username. 
scontrol.rep.perforce.password=Password. 
scontrol.rep.perforce.client=The client workspace name, as specified in the P4CLIENT environment variable or its equivalents. The workspace's root dir should be configured for local path (so that files can be downloaded). 

Subversion Repository Definition Properties

PropertyDescription
scontrol.rep.type=svnSubversion repository type identifier. 
scontrol.rep.svn.url=Subversion URL specifies protocol, server name, port and starting repository path (e.g., svn://buildmachine.foobar.com/home/svn). 
scontrol.rep.svn.login=Login name. 
scontrol.rep.svn.password =Password (not encoded). 
scontrol.svn.exec=Path to external client executable (svn).

Microsoft Team Foundation Server Repository Definition Properties 

PropertyDescription
scontrol.rep.type=tfsTFS repository type identifier. 
scontrol.tfs.sdk.path=

Path to the root directory of the unzipped TFS SDK. This is required for TFS support to work on your machine.

Example: scontrol.tfs.sdk.path=C:\Users\user\parasoft\libraries\TFS-SDK-14.135.0 

Note: TFS SDK version 14.135 or greater is required.

scontrol.rep.tfs.url=TFS repository URL (for example, http://localhost:8080/tfs).
scontrol.rep.tfs.login=TFS username.
scontrol.rep.tfs.password=TFS password.

Technical Support Settings

SettingPurpose
techsupport.auto_creation=true|false

Determines whether archives are automatically prepared when testing problems occur.

Default: false

techsupport.send_email=true|false

Determines whether prepared archives are emailed to Parasoft support. If you enable this, be sure to specify email settings from the GUI or with the options in Reporting Settings.

Default: false

techsupport.archive_location=[directory]Specifies where archives are stored.
techsupport.verbose=true|false

Determines whether verbose logs are included in the archive. Note that this option cannot be enabled if the logging system has custom configurations. Verbose logs are stored in the xtest.log file in a temporary folder:

  • Windows:
    • <USER>\AppData\Local\Temp\parasoft\techsupport
  • On macOS, random path is generated:
    • var/folders/<PATH>/<USER>/parasoft/techsupport
  • Linux:
    • /tmp/<USER>/parasoft/techsupport

Verbose logging state is cross-session persistent (restored on application startup).

The log file is a rolling file: it won't grow over a certain size, and each time it achieves the maximum size, a backup will be created.

Default: false

techsupport.verbose.scontrol=true|false

Determines whether verbose logs include output from source control commands. Note that the output could include fragments of your source code.  

Default: false

techsupport.item.general=true|false

Determines whether general application logs are included.

Default: false

techsupport.item.environment=true|false

Determines whether environment variables, JVM system properties, platform details, additional properties (memory, other) are included in the archive.

Default: false

techsupport.advanced=true|false

Specifies if advanced options will be sent.

Default: false

techsupport.advanced.options=[option]Specifies any advanced options that the support team asked you to enter.

Technical Support Settings

...

Determines whether archives are automatically prepared when testing problems occur.

Default: false

...

Determines whether prepared archives are emailed to Parasoft support. If you enable this, be sure to specify email settings from the GUI or with the options in Reporting Settings.

Default: false

...

Determines whether verbose logs are included in the archive. Note that this option cannot be enabled if the logging system has custom configurations. Verbose logs are stored in the xtest.log file in a temporary folder:

  • Windows:
    • <USER>\AppData\Local\Temp\parasoft\techsupport
  • On macOS, random path is generated:
    • var/folders/<PATH>/<USER>/parasoft/techsupport
  • Linux:
    • /tmp/<USER>/parasoft/techsupport

Verbose logging state is cross-session persistent (restored on application startup).

The log file is a rolling file: it won't grow over a certain size, and each time it achieves the maximum size, a backup will be created.

Default: false

...

Determines whether verbose logs include output from source control commands. Note that the output could include fragments of your source code.  

Default: false

...

Determines whether general application logs are included.

Default: false

...

Determines whether environment variables, JVM system properties, platform details, additional properties (memory, other) are included in the archive.

Default: false

...

Specifies if advanced options will be sent.

Default: false

...

Authorship/Scope Settings

...

Specifies a specific author mapping for authors.mappings.location=local, as described above.

For example:

authors.mappings.location=local
authors.mapping1=baduser,gooduser
authors.mapping2=brokenuser,fixeduser 
authors.mapping3=olduser,newuser 

...

Specifies a specific author name and email for authors.mappings.location=local.

For example:

authors.user1=dan,[email protected],Dan Stowe
authors.user2=jim,[email protected],Jim White 

...

Determines whether author names are case sensitive. If true, David and david will be considered the same user. If false, David and david will be considered two separate users.

Default: false

...

Determines whether code authorship is computed-based on a data from a supported source control system. 

Default: false

...

Determines whether code authorship is computed based on the local user.

Default: true

...

Determines how the Recommended Tasks are selected for each team member. You can set the following modes:

random: (default) Assigns a random number of tasks.

first: The first tasks reported are shown to each team member per day.

...

Determines whether task assignment is computed based on XML files that define how you want tasks assigned for particular files or sets of files (these mappings can be specified in the GUI then saved in an XML file).

Default: true

...

Source Control Settings

...

iconfalse
titleDefining multiple repositories of the same type

Indexes (numbered from 1 to n) must be added to the prefix if you want to define more than one repository of the same type. For example: 

scontrol.rep1.type=ccase
scontrol.rep1.ccase.vob=/vobs/myvob1

scontrol.rep2.type=ccase
scontrol.rep2.ccase.vob=/vobs/myvob2

...

scontrol.rep.type=ccase
scontrol.rep.ccase.vob=/vobs/myvob1

Git Repository Definition Properties

...

Perforce Repository Definition Properties

...

Subversion Repository Definition Properties

...

Microsoft Team Foundation Server Repository Definition Properties 

...

Path to the root directory of the unzipped TFS SDK. This is required for TFS support to work on your machine.

Example: scontrol.tfs.sdk.path=C:\Users\user\parasoft\libraries\TFS-SDK-14.134.0 

Note: TFS SDK version 14.134 is required.

...

File Encoding Settings

If fileencoding.mode is set to auto, this specifies the language’s numeric code. Valid codes are:

  • JAPANESE = 1
  • CHINESE = 2
  • SIMPLIFIED CHINESE = 3
  • TRADITIONAL CHINESE = 4
  • KOREAN = 5
    SettingPurpose
    fileencoding.mode=default|user|auto

    Defines how file encoding is calculated. 

    default specifies that you want to use system properties.

    user indicates that you will explicitly specify the encoding name (using the setting below).

    auto enables automatic detection of encoding for the Far-East language specified with fileencoding.autolanguage.

    Default: default

    fileencoding.user-encoding=<name_of_encoding>

    If fileencoding.mode is set to user, this specifies the encoding name. 

    Valid names are ASCII-US, UTF-8, UTF-16, UTF-16LE, UTF-16BE or java.nio canonical name. 

    It should be specified in form parasoft-dotNET-[codepagenumber]

    fileencoding.auto-language=<language’s numeric_code>

    Miscellaneous Settings

    SettingPurpose
    tasks.clear=true|false

    Clears existing tasks upon startup in cli mode. This prevents excessive time being spent "loading existing results." 

    Default: true

    console.verbosity.level=low|normal|high

    Specifies the verbosity level for the Console view. Available settings are:

    low: Configures the Console view to show errors and basic information about the current step’s name and status (done, failed, up to date).

    normal: Also shows command lines and issues reported during test and analysis.

    high: Also shows warnings.

    Default: normal

    soatest.custom.rules.dir=[directory]

    Indicates where user-defined rules are saved.

    soatest.custom.configs.dir=[directory]

    Indicates where user-defined Test Configurations are saved.

    exec.env=[env1; env2; ...]Specifies a list of tags that describe the environment where a test session was executed. Tags could describe an operating system (for example, Windows, Linux), an architecture (for example, x86, x86_64), a compiler, a browser, and so on. These tags describe a complete test session; more environment details could be also added at the test suite, test, or test case levels via the services API.
    issue.tracking.tags=[value]

    Specifies custom issue tracking tags. Multiple tags can be separated by a comma. For example:

    issue.tracking.tags=@custom,@pr ,@fr

    For more details, see Indicating Code and Test Correlations.

    miscmask.hidesensitive.masked.variablesdata=true|false

    Enables or disables hiding masked environment variables from traffic viewers, REST Clients, JSON/XML Data Banks and Assertors, and in the Event Monitoring Details. See  See Masking a Variable Value for more information about masking environment variables.
    . Also hides authorization request headers in displayed traffic and password input fields in HTML browser contents. Default:   false

    parallel.mode=Manual|Auto|Disabled

    Determines which of the following modes is active: 

    • Auto: SOAtest controls parallel processing settings.
    • Manual: Allows you to manually configure parallel processing settings to suit your specific needs.
    • Disabled: Use only one of the available CPUs.

    Default: Auto

    parallel.max_threads=<number>

    Specifies the maximum number of parallel threads that can be executed simultaneously. The actual number of parallel threads is determined based on the number of CPUs, available memory, and license settings.

    Default: [available_processors]

    parallel.free_memory_limit=<percentage>

    Specifies the amount of memory that should be kept free in low memory conditions (expressed as a percentage of the total memory available for the application). This is used to ensure that free memory is available for other processes.

    Default: 25

    parallel.no_memory_limit=true|false

    Indicates that you do not want to place any restrictions (beyond existing system limitations) on the available memory. 

    Default: false

    usage.reporting.enabled=true|false

    Enables or disables collecting anonymous usage information and sending it to Parasoft. Read our privacy statement to learn more at https://www.parasoft.com/privacy-policy.

    Default: false

    ...