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.1

...

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

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.

...