Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space FUNCTDEV and version SVC2023.2

...

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.

Default: html

report.generate_htmls=true|false

Determines whether HTML reports are generated and saved on the local file system. 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 regardless of this setting’s value.in addition to the report formats specified. For example:

report.format=html,pdf,xunit

Default: true 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 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 Printable Docs 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

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

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.

...

SettingPurpose
dtp.autoconfig=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

dtp.enabled=true|false

Determines whether SOAtest or Virtualize is connected to DTP. 

Default: false

dtp.url=[url]Specifies the URL for the DTP server. Include the protocol and host name or IP address and, if appropriate, the port number and context path.
dtp.user=[username]Specifies the username for DTP user authentication.
dtp.password=[password]

Specifies the password for DTP user authentication.

We strongly recommend encoding your password to ensure successful authentication and a secure connection. You can encode your password by running a command line instance of SOAtest with the -encodepass flag. The command line tool will generate an encoded string that you can use in the configuration file. 

See CLI Options for additional information.

report.dtp.publish=trueEnables/disables publishing test result data to DTP.
dtp.project=[project_name]

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 DTPFor more details on general projects, see Connecting to DTP.

Default: Default Project

Anchor
ApplicationCoverageSettings
ApplicationCoverageSettings
Application Coverage Settings

...

SettingPurpose
oidc.enabled=true|false

Enables or disables user authentication via OpenID Connect.

Default: false

oidc.issuer.uri=[uri]

Specifies the URI of the OpenID Connect server.

Example: oidc.issuer.uri=http://server.com/

oidc.client.id=[user]

Specifies the ID provided by your OpenID Connect server.

oidc.client.secret=[password]

Specifies the application's password to the OpenID Connect server.

oidc.scopes=[list of scopes]

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

oidc.cli.mode=devicecode|certificate

Specifies the method that will be used to authenticate the user on the OpenID Connect server.

Default: devicecode

oidc.devicecode.token.file=[path]

Specifies the path to the custom token file containing user authentication information.

Example: oidc.devicecode.token.file=C:\\parasoft\\token

oidc.keystore=[path]

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

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

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. You can encode your password by running a command line instance of SOAtest with the -encodepass flag. The command line tool will generate an encoded string that you can use in the configuration file. 

Example: oidc.keystore.password=myPassword0987

Technical Support Settings

...

SettingPurpose
tasks.clear=true|false

Clears existing tasks upon startup in cli mode. This prevents excessive time being spent "loading existing results." 

Default: true

console.verbosity.level=low|normal|high

Specifies the verbosity level for the Console view. Available settings are:

low: Configures the Console view to show errors and basic information about the current step’s name and status (done, failed, up to date).

normal: Also shows command lines and issues reported during test and analysis.

high: Also shows warnings.

Default: normal

soatest.custom.rules.dir=[directory]

Indicates where user-defined rules are saved.

soatest.custom.configs.dir=[directory]

Indicates where user-defined Test Configurations are saved.

exec.env=[env1; env2; ...]Specifies a list of tags that describe the environment where a test session was executed. Tags could describe an operating system (for example, Windows, Linux), an architecture (for example, x86, x86_64), a compiler, a browser, and so on. These tags describe a complete test session; more environment details could be also added at the test suite, test, or test case levels via the services API.
issue.tracking.tags=[value]

Specifies custom issue tracking tags. Multiple tags can be separated by a comma. For example:

issue.tracking.tags=@custom,@pr ,@fr

For more details, see Indicating Code and Test Correlations.

parallel.mode=Manual|Auto|Disabled

Determines which of the following modes is active: 

  • Auto: SOAtest controls parallel processing settings.
  • Manual: Allows you to manually configure parallel processing settings to suit your specific needs.
  • Disabled: Use only one of the available CPUs.

For more details on this and other parallel processing options, see Configuring Parallel Processing.

Default: Auto

parallel.max_threads=<number>

Specifies the maximum number of parallel threads that can be executed simultaneously. The actual number of parallel threads is determined based on the number of CPUs, available memory, and license settings.

Default: [available_processors]

parallel.free_memory_limit=<percentage>

Specifies the amount of memory that should be kept free in low memory conditions (expressed as a percentage of the total memory available for the application). This is used to ensure that free memory is available for other processes.

Default: 25

parallel.no_memory_limit=true|false

Indicates that you do not want to place any restrictions (beyond existing system limitations) on the available memory. 

Default: false

usage.reporting.enabled=true|false

Enables or disables collecting anonymous usage information and sending it to Parasoft. Read our privacy statement to learn more at https://www.parasoft.com/privacy-policy.

Default: false

Additional Options for SOAtest and Virtualize

...