Versions Compared

Key

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

...

  • Each setting should be entered on a single line.
  • We highly recommend that you use encoded passwords to ensure successful authentication and increase the level of security; see Creating an Encoded Password.
  • If you are importing preferences from localsettings specified on DTP and you want to override these settings from the GUI, you can clear the Use DTP settings option on the appropriate page, then manually configure the settings.
  • If any localsettings 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.

...

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, CSV, PDF, 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

report.format=html|pdf|sarif|sarif-azure|

sast-gitlab|sate|xunit|custom

Specifies the report format.

Default: html

report.generate_htmls=true|false

Determines whether HTML reports are generated and saved on the local file system. XML reports are generated and saved regardless of this setting’s value.

Default: true

report.graph.cs_start_date=[MM/dd/yy]Determines the start date for trend graphs that track static analysis tasks over a period of time. See Understanding Reports for more details on these reports.
report.graph.ue_coverage_start_date=[MM/dd/yy]Determines the start date for trend graphs that track coverage over a period of time. See Understanding Reports for more details on these reports.
report.graph.ue_start_date=[MM/dd/yy]Determines the start date for trend graphs that track test execution results over a period of time. 
report.location_details=true|false

Specifies whether absolute file paths are added to XML data. This needs to be enabled on the Server installation if you want to relocate tasks upon import to desktop installations. 

Default: false

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 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 Team 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 the path to the location when the reference report file will be created during analysis. See Configuring Task Reporting Preferences.
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.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 Team Server. 

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
dtp.enabled=true|false

Determines whether the current C/C++test installation is connected to DTP.

dtp.server=[server]Specifies the host name of the DTP server.
dtp.port=[port]Specifies the port number of the DTP server.
dtp.user=[username]Specifies the username for DTP server authentication.
dtp.password=[password]Specifies the password for DTP server authentication. We highly recommend that you use an encoded password to ensure successful authentication and increase the level of security; see Creating an Encoded Password.
dtp.context.path=[path]Specifies the path to DTP. The context path is a relative path from the host name specified with the dtp.server setting. This setting should only be configured if DTP is deployed to a location other than the root of the host server, which may be the case if your organization uses a reverse proxy.
report.dtp.publish=true|falseEnables or disables reporting results to DTP server.
dtp.project=[project_name]Specifies the name of the DTP project that you want these results linked to.
dtp.additional.settings=[KEY1\=VALUE1\nKEY2\=VALUE2...]Specifies advanced settings for reporting results to DTP.
dtp.autoconfig=true|falseEnables autoconfiguration with C/C++test settings stored on the DTP server

...

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 form 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 license that you want C/C++test to retrieve from License Server. 

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

Example:

cpptest.license.network.edition=desktop_edition

cpptest.license.network.edition=automation_edition

Default: custom_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.
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 specified with the license.network.host and license.network.port options.

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

Default: false

license.network.host=[host]

Specifies the host name of the standalone License Server,  secondary DTP, or legacy License Server that you use to obtain the license. It requires the license.network.use.specified.server option set to true.

Example: license.network.host=jade.mycompany.com

(info) If you retrieve the license from a standalone License Server that uses the HTTPS protocol, precede the hostname with https://.

license.network.port=[port]

Specifies the port number that is assigned to License Server specified with the license.network.host option.

  • For a standalone License Server:  Depends on your Tomcat settings; typically, a  HTTP port, for example, 8080.
  • For License Server on secondary DTP: Typically, a HTTPS port, for example 443 or 8443.
  • For legacy License Server: Typically, 2002.

Example: license.network.port=2222

license.network.context.path=[path]

Specifies the path to the DTP License Server. The context path is a relative path from the host name specified with the license.network.host setting. This setting should only be configured if DTP is deployed to a location other than the root of the host server, which may be the case if your organization uses a reverse proxy.

Configuring the context path is not supported for standalone License Server.

Refer to the DTP documentation for additional information about reverse proxy server configuration and context path configuration.

Example: license.network.context.path=/foo/bar

license.network.connection.type=[http|tcp]

Specifies the connection type if you obtain your license from a custom License Server.

http: Allows you to obtain the license from a standalone License Server or License Server on secondary DTP.

tcp: Allows you to obtain the license from Legacy License Server.

It requires the license.network.use.specified.server, license.network.host, and license.network.port to be enabled.

Example: license.network.connection.type=http

license.network.auth.enabled=true|false

Enables or disables authentication on the secondary DTP server specified with the license.network.host and license.network.port options.

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

license.network.user=[username]

Specifies the username for authentication on the secondary DTP server specified with the license.network.host and license.network.port options. 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 secondary DTP server specified with the license.network.host and license.network.port options. 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!

...

SettingPurpose
oidc.enabled=true|false

Enables or disables user authentication via OpenID Connect.

The default is false.

oidc.issuer.uri=[uri]Specifies the URI of the OpenID Connect server where your DTP is registered.
oidc.client.id=[id]Specifies the ID registered on your OpenID Connect server.
oidc.client.secret=[password]Specifies the password provided by your OpenID Connect server.
oidc.keystore=[path]

Specifies the path to the keystore file that stores the certificate to authenticate the user on the OpenID Connect server.

oidc.keystore.password=[password]Specifies the password to the the keystore file that stores the self-signed client certificate. We highly recommend that you use an encoded password to ensure successful authentication and increase the level of security; see Creating an Encoded Password.
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=grs

oidc.callback.host=localhost | 127.0.0.1

This setting specifies the local callback host configured in the IDE to communicate with the OpenID Connect server.

(info) This is an IDE-related setting and is not intended for command line use.

The default is localhost.

oidc.callback.port=0 | [port number]

This setting specifies the callback port number configured in the IDE to communicate with the OpenID Connect server.

(info) This is an IDE-related setting and is not intended for command line use.

0: The port will be automatically configured.

The default is 0.

oidc.callback.timeout=[seconds]

This setting specifies the maximum time allowed for providing user credentials on the authentication page to authenticate on DTP via OpenID Connect when working with C/C++test in the IDE.

(info) This is an IDE-related setting and is not intended for command line use.

The default is 60.

...