...
| env_var | 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:
|
|---|---|
| project_name | 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:
|
| general_project | It outputs the name of the general DTP project that results are linked to. Only applies when connected to DTP. Example:
|
| workspace_name | Outputs the workspace name or Visual Studio solution name. Example:
|
| config_name | Outputs the name of executed test configuration. Only applies to reports and email settings. Example:
|
| analysis_type | Outputs a comma separated list of enabled analysis types (for example: Static, Execution). Only applies to reports and email settings. Example:
|
| tool_name | Outputs the name of the tool. Example:
|
| time | Outputs the current time. The default is
|
Specifying Which Localsettings to Use
...
| Setting | Purpose |
|---|---|
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: build- ${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 (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 | Specifies whether the report shows requirements, defects, tasks, and feature requests that are associated with a test. Default: false |
report.authors_details | Determines whether the report includes an overview of the number and type of tasks assigned to each team member. Default: true |
report.contexts_details | Determines whether the report includes an overview of the files that were checked or executed during testing. Default: false |
report.coverage.version | Specifies the version of the XML coverage report. Specify Specify Default is |
| Specifies the location and extension of the XSL file for a custom format. Used with For details and examples, seeConfiguring Report 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. 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. |
report.graph.ue_coverage_start_date=[MM/dd/yy] | Determines the start date for trend graphs that track coverage over a period of time. |
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. |
report.mail.compact=trends|links | Specifies that you want to email a compact report or link rather than a complete report. If If |
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 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 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 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: |
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
Default: |
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 |
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.setup.problems=top|bottom|hidden | Determines whether reports include a section about setup problems.
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. 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: |
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. |
...
| Setting | Purpose |
|---|---|
report.rules=[url_path_to_rules_directory] | Specifies the directory for HTML rule files generated by clicking Printable Docs in the Test Configuration’s Static Analysis tab. Default: none |
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:
Default: low |
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 (e.g. Windows, Linux), an architecture (e.g. x86, x86_64), a compiler, a browser, etc. 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:
For more details, see 2021-04-16_11-57-00_Associating Tests with Development Artifacts. |
parallel.mode=Manual|Auto|Disabled | Determines which of the following modes is active:
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
...