Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

SettingPurpose
build.id=[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.

The default is  ${dtp_project}-${time:yyyy-MM-dd}. For example, for the ATM project, the build ID included in the report may resemble the following: ATM-2017-07-07. 

The following configuration specifies the custom build ID that consists of the name of the project and the build number passed via the environmental variable BUILD:

build.id=${dtp_project}-${env_var:BUILD}

For the ABC project and the build number 114 on a CI server, this may resolve to ABC-114.

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 (e.g., HTML, PDF, SARIF, etc.). 

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.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, see Configuring 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

Anchor
report.dtp.publish.src
report.dtp.publish.src
report.dtp.publish.src=off|min|full

Specifies whether the tested source code is published to the DTP server.  

If set to off, the source code is not published to DTP.

If set to min, the minimal part of the source code is published (in most cases, source code without reference to source control, for example, auto-generated code, is published).

If set to full, all of the source code from the specified scope is published to DTP.

Default: full (Default when the report.dtp.publish option is enabled.)

Anchor
report.format
report.format
report.format=[html|html_ut_details|pdf|sarif|sarif-azure|sast-gitlab|sast-gitlab-v14|sate|cppunit|xunit|custom]

Specifies the report formats. To generate multiple reports in different formats for a single run, enter a comma-separated list. If you have the "Automation" license feature enabled, XML reports are generated and saved in addition to the report formats specified. For example:

report.format=html,pdf,sarif

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 (for example, because the team is not using a supported source control system).
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 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 server).

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 developer that worked on project code will automatically be sent a report that contains only the errors/results related to his or her work.

Default: false

report.mail.exclude=[email_addresses]Specifies any email addresses you do not want to receive reports. This set-ting 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 developers.

Default: false

report.mail.format=html|ascii

Specifies the email format.

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.server=[server]Specifies the mail server used to send reports.
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.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 "Report for Project A", you would use

report.mail.subject=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.ref.report.file=[path]Specifies a path to the location where the reference report file will be created during analysis. See Configuring Task Reporting Preferences.
report.additional.report.dir=[directory]Specifies a path to the directory where additional C/C++test Standard-compatible XML report files will be generated for the currently executed test configuration. The additional XML report files may include static analysis, metrics, unit testing and line coverage results, depending on the test configuration. This setting is available only in the command line mode (CLI).
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 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/docs/

Default: none

Anchor
report.scontrol
report.scontrol
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

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

This setting specifies a custom parameter Id to be added to the xml report root element. The Id needs to be unique. Both report.xml.param{n}.key and report.xml.param{n}.value 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

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

This setting 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 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.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
SC - for statement coverage
BCC - for block coverage
DC - for decision coverage
SCC - for simple condition coverage
MCDC - for MC/DC coverage

session.tag=[name]

Specifies a session tag used to label these results. This value is used for uploading summary results to DTP. 

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.

...

SettingPurpose
parasoft.eula.accepted=true|false

Allows you to accept the terms of Parasoft End User License Agreement (EULA).

Default: false

cpptest.license.use_network=true|false

Enables or disables retrieving a network license.

Example: cpptest.license.use_network=true

Default: true

(info) By default, C/C++test will try to retrieve a license from License Server on the DTP configured as your primary DTP server; see Parasoft DTP Settings. If you want to configure another License Server, enable the license.network.use.specified.server option.

cpptest.license.local.password=[password]Specifies the local password that you want C/C++test to use. 
cpptest.license.local.expiration=[expiration]

Specifies the expiration date of the local license.

Default: 0

cpptest.license.network.edition=[edition_name]

Specifies the type of the network license that will be retrieved from the Licence Server. This setting requires that the cpptest.license.use_network is set to true.

Acceptable edition names:

  • desktop_edition: The license is optimized for desktop usage.
  • desktop_compliance_edition: The license is optimized for desktop usage and configured to support compliance with coding standards.
  • server_edition: The license is configured for high-performance usage in server command line mode.
  • server_compliance_edition: The license is configured for high-performance usage in server command line mode and includes support for compliance with coding standards.
  • custom_edition: The customized license that requires specifying the list of available features. Use cpptest.license.custom_edition_features to specify the list of features.

Default: custom_edition

Example:

The following configuration enables the license optimized for desktop usage.
cpptest.license.use_network=true
cpptest.license.network.edition=deskop_edition

cpptest.license.custom_edition_features=[feature name]

Specifies the features you want to enable in the custom edition of the C/C++test license. You can use a comma-separated list to specify multiple features.

Acceptable feature names:

  • Assembly Coverage
  • Automation
  • AUTOSAR Rules
  • Code Dependency Export
  • Static Analysis
  • Coverage
  • Coverage Advisor
  • CWE Rules
  • Desktop Command Line
  • DISA STIG Rules
  • DTP Publish
  • Embedded Support
  • Flow Analysis
  • HIC++ Rules
  • JSF Rules
  • MISRA C 2012 Rules
  • MISRA Rules
  • OWASP Rules
  • Requirements Traceability
  • Rule Wizard
  • Runtime Error Detection
  • Security Rules
  • SEI CERT C Rules
  • SEI CERT C++ Rules
  • Unit Test
cpptest.license.wait.for.tokens.time=[time in minutes]

Specifies the time that C/C++test will wait for a license if a license is not currently available. 

For example to make C++test  wait 3 minutes for license tokens, use cpptest.license.wait.for.tokens.time=3.

Default: 0

cpptest.license.autoconf.timeout=[seconds]

Specifies the maximum number of seconds C/C++test will  wait for the license to be automatically configured from License Server.

Default: 20

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

Enables or disables retrieving the license from a custom License Server (either standalone or deployed on another instance of the DTP server) specified with the license.network.url option.

Example: license.network.use.specified.server=true

Default: false

license.network.url=[url]

Specifies the URL of the License Server (either standalone or deployed on another instance of the DTP server) used to obtain the license. It requires the license.network.use.specified.server option set to true.

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). This may be the case if your organization uses a reverse proxy. The context path is not supported for a standalone License Server. Refer to the DTP documentation for additional information about reverse proxy server configuration and context path configuration. The context path is not supported for a standalone License Server.

Example: license.network.url=https://jade.mycompany.com:8443

Example including a context path: license.network.url=https://aurelia.mycompany.com:8443/contextPath

Anchor
license.network.auth.enabled
license.network.auth.enabled
license.network.auth.enabled=true|false

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

It requires the license.network.use.specified.serveroption to be set to true.

license.network.user=[username]

Specifies the username for authentication on the License Server specified with the license.network.url option. It requires the license.network.use.specified.server and license.network.auth.enabled options set to true.

Example: license.network.user=JohnSnow

license.network.password=[password]

Specifies the password for authentication on the License Server specified with the license.network.url option. It requires the license.network.use.specified.server and license.network.auth.enabled options set to true, and the the license.network.user to be configured. We highly recommend that you use an encoded password to ensure successful authentication and increase the level of security; see Creating an Encoded Password.

Example: license.network.password=Wic2019!

...