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