...
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: | ||
report.active_rules=true|false | Determines if the reports contain a list of the rules that were enabled for the test. Default: | ||
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: | ||
report.associations=true|false | Specifies whether the report shows requirements, defects, tasks, and feature requests that are associated with a test. Default: | ||
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: | ||
report.contexts_details=true|false | Determines whether the report includes an overview of the files that were checked or executed during testing. Default: | ||
report.coverage.version=1|2 | Specifies the version of the XML coverage report. Acceptable values are:
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: | ||
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: | ||
report.format=html|pdf|sate|xunit|custom | Specifies the report format. Available formats are HTML, PDF, SATE, XUnit, and custom. 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 in addition to the report formats specified. For example:
Default: | ||
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: | 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: |
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: | ||
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 Default: | ||
report.mail.format=html|ascii | Specifies the email format. Available formats are HTML and ASCII. Default: | ||
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: | ||
report.mail.port=[port] | Specifies the mail server host’s port number. Default: | ||
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
Default: | ||
report.mail.time_delay=[server] | Specifies a time delay between emailing reports (to avoid bulk email restrictions). Default: | ||
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: | ||
report.organize_security_findings_by=CWE|OWASP2021 | Specifies whether API Security reports are sorted by CWE or OWASP 2021 Top 10. Default: | ||
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. 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:
Default: none | ||
report.setup.problems=top|bottom|hidden | Determines whether reports include a section about setup problems.
Default: | ||
report.suppressed_msgs=true|false | Determines whether reports include suppressed messages. Default: | ||
report.test_params=true|false | Determines whether reports include test parameter details. Default: | ||
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: | ||
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: | ||
| This setting specifies if additional information from source control, such as revisions and comments, is included in the report. |
...
Setting | Purpose |
---|---|
oidc.enabled=true|false | Enables or disables user authentication via OpenID Connect. Default: |
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. |
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: |
oidc.cli.mode=devicecode|certificate | Specifies the method that will be used to authenticate the user on the OpenID Connect server. Default: |
oidc.devicecode.token.file=[path] | Specifies the path to the custom token file containing user authentication information. Example: |
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.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.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 Example: |
...