...
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: ${dtp_project}-${time:yyyy-MM-dd} |
dottest.install.dir=[directory] | Specifies where dotTEST is installed. Used by SOAtest to create and upload a coverage report to DTP after test execution against a .NET-based application. |
jtest.install.dir=[directory] | Specifies where Jtest is installed. Used by SOAtest to create and upload a coverage report to DTP after test execution against a Java-based application. |
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 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. 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. This setting has been deprecatedis deprecated. |
report.graph.ue_coverage_start_date=[MM/dd/yy] | Determines the start date for trend graphs that track coverage over a period of time. This setting has beenis deprecated. |
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. This setting has beenis deprecated. |
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.organize_security_findings_by=CWE|OWASP2021 | Specifies whether API Security reports are sorted by CWE or OWASP 2021 Top 10. Default: CWE |
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 the deprecated 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: |
| This setting specifies if additional information from source control, such as revisions and comments, is included in the report. |
DTP Settings
Info |
---|
Some of the settings described in this section have been deprecated. |
Setting | Purpose |
---|---|
dtp.autoconfig=true|false | Enables auto-configuration using settings stored in DTP. 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 See CLI Options for additional information. |
dtp.context.path=[path] | Specifies the path to DTP. The context path is a relative path from the host name specified with the 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. This setting is deprecated. |
report.dtp.publish=true | Enables/disables publishing test result data to DTP. |
dtp.server=[host] | Specifies the host name of the Parasoft DTP server. This setting is deprecated. |
dtp.project=[project_name] | Specifies the name of the DTP project that you want these results linked to. For more details on general projects, see Connecting to DTP. Default: Default Project |
...
See Manually Adding the License to localsetttings to localsetttings for additional notes and examples.
Info |
---|
Some of the settings described in this section have been deprecated. |
Setting | Purpose | ||
---|---|---|---|
soatest.license.use_network=true|false | Enables/disables network-based licenses. Set to Set to Example: Default: | ||
license.network.baseurl=[url] | Specifies the License Server URL. Include the protocol and host name or IP address and, if appropriate, the port number and context path. Example: | ||
license.network.host=[host] | Specifies the machine name or IP address of the machine running License Server. If your server uses the HTTPS protocol, prepend This setting is deprecated. Example: | ||
license.network.port=[port] | Specifies the License Server port number. This setting is deprecated. Example: Common port numbers are | ||
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 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. This setting is deprecated. | ||
license.network.user=[username] | Specifies the username for authentication on the secondary DTP server specified with the This options requires the Example: | ||
license.network.password=[password] | Specifies the password for authentication on the secondary DTP server specified with the This option requires the 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 See CLI Options for additional information. | ||
license.network.use.specified.server=[true|false] | This option enables SOAtest to connect to either DTP and License Server, or two instances of DTP simultaneously. Set to Set to | ||
license.network.connection.type=[http|tcp] | This option specifies whether to connect to DTP/License Server over HTTP or over TCP. HTTP over a secure port (SSL) is recommended. Default is | ||
| |||
license.network.auth.enabled=[true|false] | Enables or disables authentication on the secondary DTP server specified with the This option requires the | ||
| Specifies the type of license to retrieve from License Server.
Example:
Default: custom_edition | ||
soatest.license.autoconf.timeout=[seconds] | Specifies the maximum number of seconds to wait for the license to be automatically configured from License Server. Default: 20 | ||
soatest.license.local.password=[password] | Specifies the local password provided to you by Parasoft. | soatest.license.wait.for.tokens.time=[time in minutes] | provided to you by Parasoft. |
soatest.license.wait.for.tokens.time=[time in minutes] | Specifies how long to wait for a license if a license is not currently available. Example:
Default: 0 |
OIDC Settings
Setting | Purpose |
---|---|
oidc.enabled=true|false | Enables or disables user authentication via OpenID Connect. Default: false Example:
|
oidc.issuer.uri=[uri] | Specifies the URI of the OpenID Connect server. Example:
|
oidc.client.id=[user] | Specifies the ID provided by your OpenID Connect server. Example:
|
oidc.cli.mode=devicecode|certificate | Specifies the method that will be used to authenticate the user on the OpenID Connect server. Default: devicecode Example:
|
oidc.devicecode.token.file=[path] | Specifies the path to the custom token file containing user authentication information. Example:
|
Technical Support Settings
...
Code Block |
---|
# REPORTS #Determines whether reports are emailed to developers and to the additional recipients specified with the cc setting. #Remember that if the team is using CVS for source control and each developer's email address matches his or her CVS username + the mail domain, 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. report.mail.enabled=true #Exclude developers emails (true/false) report.mail.exclude.developers=false # Append developers errors to manager emails (true/false) report.developer_errors=true # Send reports to developers (true|false) report.developer_reports=true # Append suppressed messages (true|false) report.suppressed_msgs=false #Determines where to mail complete test reports. #This setting is typically used to send reports to managers or architects. #It can also be used to send reports to developers if developer reports #are not sent automatically (for example, because the team is not using CVS). [email protected]; ${env_var:USERNAME} @domain.com # mail target for unknown developer errors [email protected] #Specifies the mail server used to send reports. report.mail.server=mail_server.domain.com #Specifies the mail domain used to send reports. report.mail.domain=domain.com #Specify mali from report.mail.from=nightly #Specifies any email addresses you do not want to receive reports. #This setting is used to prevent from automatically sending reports to someone that worked on the code, but should not be receiving reports. This setting is only applicable if the team is using CVS for source control and developer reports are being sent automatically. report.mail.exclude=developer1;developer2 # Specifies the subject line of the emails sent. report.mail.subject= ${tool_name} Report - ${config_name} # Report test params include (true|false) report.test_params=true # Team Server #Determines whether the current installation is connected to the Team Server. tcm.server.enabled=true #Specifies the machine name or IP address of the machine running Team Server. tcm.server.name=team_server.domain.com #Specifies the Team Server port number. tcm.server.port=18888 tcm.server.accountLogin=true tcm.server.username=user tcm.server.password=password session.tag= ${config_name} # SCOPE #code authorship based on CVS scope.sourcecontrol=true #code authorship based on author tag scope.author=false #code authorship based on local user scope.local=false # LICENSE #override license settings #soatest.license.autoconf.timeout=40 soatest.license.use_network=true soatest.license.network.hosturl=http://license_server.domain.com soatest.license.network.port=:2222 soatest.license.network.edition=server_edition # SOURCE CONTROL scontrol.rep1.type=cvs scontrol.rep1.cvs.root=:pserver:developer@cvs_server.domain.com:/home/cvs/scontrol.rep1.cvs.pass=mypassword |