Page History

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}

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}

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

Example:

build.id=${general_project}

Outputs the workspace name or Visual Studio solution name.

Example:

report.mail.subject=Code Review Scanner Results for ${workspace_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}

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

Outputs the name of the tool.

Example:

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

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

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

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}

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

Default: 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

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

Default: false

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

Default: true

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

Default: false

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.

Determines whether manager reports include details about team member tasks.

Default: false

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

Default: true

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

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

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)

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

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

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

Default: html

Specifies the "from" line of the emails sent.

Default: <global_user_name>

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

Specifies the mail server host’s port number.

Default: 25

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}

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

Default: 0

Specifies the settings for SMTP server authentication.

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

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

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

Default: CWE

This setting specifies a the path to the directory containing a .zip file or directory that contains static analysis rules in HTML filesformat. 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  see Generating Reports.

For example:

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

report.rules=../gendoc/

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

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

Default: none

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

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

Determines whether reports include suppressed messages.

Default: false

Determines whether reports include test parameter details.

Default: 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

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

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

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 encoding encrypting your password to ensure successful authentication and a secure connection. You can encode encrypt your password by running a command line instance of SOAtest with the -encodepass flag. The command line tool will generate an encoded string encrypted string using AES 256-bit encryption that you can use in 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

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 encoding encrypting your password to ensure successful authentication and a secure connection. You can encode encrypt your password by running a command line instance of SOAtest with the -encodepass flag. The command line tool will generate an encoded string encrypted string using AES 256-bit encryption that you can use in in the configuration configuration file. 

See 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

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

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

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

Example: oidc.keystore.password=myPassword0987

Specifies location of the CTP server. Required

Example: env.manager.server=http://em_hostname:8080/

Specifies the name that will be used to label this server in CTP. You can specify any value that helps you identify this server. Optional

Example: env.manager.server.name=MyVirtServerLabel

Determines whether the Virtualize server notifies CTP when virtual assets are deployed. Optional

Example: env.manager.notify=true

Specifies the username for logging into CTP. Optional

Example: env.manager.username=me

Specifies the password for logging into CTP. Optional

Example: env.manager.password=12345

We strongly recommend encoding encrypting your password to ensure successful authentication and a secure connection. You can encode encrypt 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 encrypted string using AES 256-bit encryption that you can use in in the configuration configuration file. 

See See CLI Options for additional information.