In this section:

Overview

You can configure how SOAtest connects to other Parasoft systems, reports errors, determines code authorship, and performs other functions by configuring your preferences in a settings file. If a parameter is specified in this file and there is an equivalent parameter in the GUI’s Preferences panel (see Configuring SOAtest Across Teams), the settings parameter will override the parameter specified from the GUI. Settings can be imported into the GUI from the command line as well; see "-settings" or "-property" on the CLI Options page for more information about that process.

Settings can be used to:

  • Enter GUI-specified and manually-specified settings into Parasoft DTP, which centralizes reporting and preference distribution across the team.
  • Configure and use different setting configurations for different projects.
  • Extend or override team-wide settings as needed (for example, for settings that involve local paths).
  • Adjust settings without having to open the GUI.
  • Share preferences across a team, as well as to apply different groups of settings to different projects and test runs. 

Defining Settings

Settings are defined in a .properties configuration file. Enter them manually in a simple text file. There are no name or location requirements. Each setting should be entered in a single line.

You can also export your GUI preferences as described in Exporting GUI Preferences to a settings File to quickly create the file and adjust or extend them as needed.

Using Variables in Preference Settings

You can use the following variables in your preference configuration settings. The session tag value can not contain any colon characters (:).

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:

session.id=${env_var:HOME}

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:

build.id=${dtp_project}-${time}

general_project

It outputs the name of the general DTP project that results are linked to. Only applies when connected to DTP. 

Example:

build.id=${general_project}

workspace_name

Outputs the workspace name or Visual Studio solution name.

Example:

report.mail.subject=Code Review Scanner Results for ${workspace_name}

config_name

Outputs the name of executed test configuration. Only applies to reports and email settings.

Example:

report.mail.subject=Findings from running ${config_name} on the ${project_name}

analysis_type

Outputs a comma separated list of enabled analysis types (for example: Static, Execution). Only applies to reports and email settings.

Example:

report.mail.subject=${analysis_type} findings

tool_name

Outputs the name of the tool.

Example:

report.mail.subject=Tests executed by ${tool_name}


time

Outputs the current time. The default is yyyy-MM-dd. You can customize the format, for example:

${time:yyyy-MM-dd-HH.mm}

Specifying Which Settings to Use

You can store settings in DTP where they are automatically applied to connected tools or in a local file where they can be specified from the command line. 

Multiple layers of settings can be active for a single test run.

For details on how to store and apply settings, see Configuring SOAtest Across Teams. 

Additional Notes

  • Each setting should be entered on a single line.
  • If a parameter is specified in settings, it will override the related parameter specified from the GUI. If a parameter is not specified in settings, the parameter specified in the GUI will be used.
  • If you are importing preferences from settings specified in DTP and you want to override these settings from the GUI, you can disable the Use DTP settings option on the appropriate page, then manually configure the settings.
  • If any settings 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.

Reporting Settings

Some of the settings described in this section have been deprecated.

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}

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 1 to enable the basic (legacy) coverage report.

Specify 2 to enable the enhanced coverage report (JaCoCo). 

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, see Configuring 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.

This setting is 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 is 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 is 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 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 the deprecated 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 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 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.

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.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. 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: ${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.

DTP Settings

Some of the settings described in this section have been deprecated.

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.

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.

This setting is deprecated.

report.dtp.publish=trueEnables/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

Team Server Settings (Deprecated)

The settings described in this section have been deprecated.

SettingPurpose
tcm.server.enabled=true|false

Enables/disables the connection to the Parasoft Team Server. 

Default: false

tcm.server.name=[name]Specifies the machine name or IP address of the machine running Team Server. 
tcm.server.port=[port]

Specifies the Team Server port number.

Default: 18888

tcm.server.accountLogin=true|false
tcm.server.username=[username]
tcm.server.password=[password]

Determines whether username and password are submitted to connect to Team Server. Usernames/passwords are not always needed; it depends on your team’s setup. 

If the first setting is true, the second and third settings specify the username and password.

Note that Team Server must have the username and password setting already enabled before these settings can be used.

tcm.server.accountLogin default: false

Licensing Settings

Some of the settings described in this section have been deprecated.

SettingPurpose
soatest.license.use_network=true|false

Enables/disables network-based licenses.

Set to true and configure either the License Server setting (license.network.url) or the Parasoft DTP Settings to use a network license.  

Set to false  and configure the soatest.license.local.password setting to use a local license.

Example: soatest.license.use_network=true

Default: true

license.network.url=[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: https://10.9.1.63:8443

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 https:// to the hostname.

This setting is deprecated.

Example: soatest.license.network.host=10.9.1.63, soatest.license.network.host=https://10.9.1.63

license.network.port=[port]

Specifies the License Server port number. 

This setting is deprecated.

Example: soatest.license.network.port=8080

Common port numbers are 8443 or 8080  for HTTP/S and 2002 (default) for TCP.

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. 

This setting is deprecated.

license.network.user=[username] 

Specifies the username for authentication on the secondary DTP server specified with the license.network.url option.

This options requires the license.network.use.specified.server and license.network.auth.enabled options to be set to true.

Example: license.network.user=JohnDoe

license.network.password=[password] 

Specifies the password for authentication on the secondary DTP server specified with the license.network.url option.

This option requires the license.network.use.specified.server and license.network.auth.enabled options to be set to true and the the license.network.user to be configured.

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.

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 false if you want to retrieve a license from the DTP server specified with Parasoft DTP Settings. 

If set to true, SOAtest will retrieve a license from the server specified with the license.network.url option. 

license.network.auth.enabled=true|false

Enables or disables authentication on the secondary DTP server specified with the license.network.url option.

This option requires the license.network.use.specified.server option to be set to true.

soatest.license.network.edition=[edition_name]

Specifies the type of license to retrieve from License Server. 

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

Example:

soatest.license.network.edition=desktop_edition

soatest.license.network.edition=server_edition

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]

Specifies how long to wait for a license if a license is not currently available. 

Example:

soatest.license.wait.for.tokens.time=3.

Default: 0

OIDC Settings

SettingPurpose
oidc.enabled=true|false

Enables or disables user authentication via OpenID Connect.

Default: false

Example:

oidc.enabled=true

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.

Example:

oidc.client.id=user1234

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.cli.mode=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

Technical Support Settings

SettingPurpose
techsupport.auto_creation=true|false

Determines whether archives are automatically prepared when testing problems occur.

Default: false

techsupport.send_email=true|false

Determines whether prepared archives are emailed to Parasoft support. If you enable this, be sure to specify email settings from the GUI or with the options in Reporting Settings.

Default: false  

techsupport.archive_location=[directory]Specifies where archives are stored.
techsupport.verbose=true|false

Determines whether verbose logs are included in the archive. Note that this option cannot be enabled if the logging system has custom configurations. Verbose logs are stored in the xtest.log file in a temporary folder:

  • Windows:
    • <USER>\AppData\Local\Temp\parasoft\techsupport
  • On macOS, random path is generated:
    • var/folders/<PATH>/<USER>/parasoft/techsupport
  • Linux:
    • /tmp/<USER>/parasoft/techsupport

Verbose logging state is cross-session persistent (restored on application startup).

The log file is a rolling file: it won't grow over a certain size, and each time it achieves the maximum size, a backup will be created.

Default: false

techsupport.verbose.scontrol=true|false

Determines whether verbose logs include output from source control commands. Note that the output could include fragments of your source code.  

Default: false

techsupport.item.general=true|false

Determines whether general application logs are included.

Default: false

techsupport.item.environment=true|false

Determines whether environment variables, JVM system properties, platform details, additional properties (memory, other) are included in the archive.

Default: false

techsupport.advanced=true|false

Specifies if advanced options will be sent.

Default: false

techsupport.advanced.options=[option]Specifies any advanced options that the support team asked you to enter.

Authorship/Scope Settings

SettingPurpose
authors.mappings.location=team|local|shared

Specifies where the authorship mapping file is stored. This setting defaults to team unless local or shared is specified.

If set to local (recommended), authorship mappings can be set directly in settings. See authors.mapping and authors.user{n} for details.

If set to shared, you can store map-pings in a local file using the authors.mappings.file option. 

The team and shared options are deprecated. Files specified by these options should be in the previously-used format of:

#author to author
user1=user3
user2=user3
#author to email
[email protected]

 Default: team

authors.mapping{n}=[from_user, to_user]

Specifies a specific author mapping for authors.mappings.location=local, as described above.

For example:

authors.mappings.location=local
authors.mapping1=baduser,gooduser
authors.mapping2=brokenuser,fixeduser 
authors.mapping3=olduser,newuser 

authors.user{n}=[username, email, full_name]

Specifies a specific author name and email for authors.mappings.location=local.

For example:

authors.user1=dan,[email protected],Dan Stowe
authors.user2=jim,[email protected],Jim White 

authors.mappings.file=[path]

Specifies the location of a "shared" file as described in authors.mappings.location above.

For example:

authors.mappings.file=/home/user/dev/temp/author_mapping1.txt

authors.ignore.case=true|false

Determines whether author names are case sensitive. If true, David and david will be considered the same user. If false, David and david will be considered two separate users.

Default: false

scope.sourcecontrol=true|false

Determines whether code authorship is computed  based on a data from a supported source control system. 

Default: false

scope.local=true|false

Determines whether code authorship is computed based on the local user.

Default: true

scope.recommended.computation=first|random

Determines how the Recommended Tasks are selected for each team member. You can set the following modes:

random: (default) Assigns a random number tasks.

first: The first tasks reported are shown to each team member per day.

scope.xmlmap=true|false

Determines whether task assignment is computed based on XML files that define how you want tasks assigned for particular files or sets of files (these mappings can be specified in the GUI then saved in an XML file).

Default: true

scope.xmlmap.file=[file]Specifies the name of the XML file that defines how you want tasks assigned for particular files or sets of files.

Source Control Settings

Defining multiple repositories of the same type

Indexes (numbered from 1 to n) must be added to the prefix if you want to define more than one repository of the same type. For example: 

scontrol.rep1.type=ccase
scontrol.rep1.ccase.vob=/vobs/myvob1

scontrol.rep2.type=ccase
scontrol.rep2.ccase.vob=/vobs/myvob2

If you are defining only one repository, you do not need to use an index. For example:

scontrol.rep.type=ccase
scontrol.rep.ccase.vob=/vobs/myvob1

Git Repository Definition Properties

PropertyDescription
scontrol.rep.type=gitGit repository type identifier.
scontrol.git.exec=Path to Git executable. If not set, assumes git command is on the path.
scontrol.rep.git.branch=The name of the branch that the source control module will use. This can be left blank and the currently checked out branch will be used.
scontrol.rep.git.url=The remote repository URL (e.g., git://hostname/repo.git).
scontrol.rep.git.workspace= The directory containing the local git repository.

Perforce Repository Definition Properties

PropertyDescription
scontrol.perforce.exec=Path to  external  client executable (p4).
scontrol.rep.type=perforcePerforce repository type identifier. 
scontrol.rep.perforce.host=Perforce server host. 
scontrol.rep.perforce.port=Perforce server port. Default port is 1666.
scontrol.rep.perforce.login=Perforce user name. 
scontrol.rep.perforce.password=Password. 
scontrol.rep.perforce.client=The client workspace name, as specified in the P4CLIENT environment variable or its equivalents. The workspace's root dir should be configured for local path (so that files can be downloaded). 

Subversion Repository Definition Properties

PropertyDescription
scontrol.rep.type=svnSubversion repository type identifier. 
scontrol.rep.svn.url=Subversion URL specifies protocol, server name, port and starting repository path (e.g., svn://buildmachine.foobar.com/home/svn). 
scontrol.rep.svn.login=Login name. 
scontrol.rep.svn.password =Password (not encoded). 
scontrol.svn.exec=Path to external client executable (svn).

Microsoft Team Foundation Server Repository Definition Properties 

PropertyDescription
scontrol.rep.type=tfsTFS repository type identifier. 
scontrol.tfs.sdk.path=

Path to the root directory of the unzipped TFS SDK. This is required for TFS support to work on your machine.

Example: scontrol.tfs.sdk.path=C:\Users\user\parasoft\libraries\TFS-SDK-14.134.0 

Note: TFS SDK version 14.134 is required.

scontrol.rep.tfs.url=TFS repository URL (for example, http://localhost:8080/tfs).
scontrol.rep.tfs.login=TFS user name.
scontrol.rep.tfs.password=TFS password.

File Encoding Settings

SettingPurpose
fileencoding.mode=default|user|auto

Defines how file encoding is calculated. 

default specifies that you want to use system properties.

user indicates that you will explicitly specify the encoding name (using the setting below).

auto enables automatic detection of encoding for the Far-East language specified with fileencoding.autolanguage.

Default: default

fileencoding.user-encoding=<name_of_encoding>

If fileencoding.mode is set to user, this specifies the encoding name 

Valid names are ASCII-US, UTF-8, UTF-16, UTF-16LE, UTF-16BE or java.nio canonical name. 

It should be specified in form parasoft-dotNET-[codepagenumber]

fileencoding.auto-language=<language’s numeric_code>

If fileencoding.mode is set to auto, this specifies the language’s numeric code. Valid codes are:

  • JAPANESE = 1
  • CHINESE = 2
  • SIMPLIFIED CHINESE = 3
  • TRADITIONAL CHINESE = 4
  • KOREAN = 5

Miscellaneous Settings

SettingPurpose
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:

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: 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:

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

For more details, see Associating Tests with Development Artifacts.

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

SettingPurpose

datasources.jdbc.classpath=[path1];[path2];[path3] ...

Specifies the location of JDBC driver jar files and class folders.

Special characters (spaces, slashes, colons, etc.) must be escaped; for instance: 

%20 = SPACE
%3A = :
%5C = \
%7B = {
%7D = }
%24 = $

If listing multiple jars, use \n as a delimiter.

For example, C:\temp\withspace\${example}\jar.jar

becomes

C%3A%5Ctemp%5Cwith%20space%5C$2 4%7Bexample%7D%5Cjar.jar\n 

scripting.jython.pathUsed to add a list of directories to search for python modules that are not already included with Jython. Multiple paths can be listed using the OS default path separator (";" for Windows and ":" for Linux and macOS).
scripting.timeout.minutesSpecifies the number of minutes after which the product will attempt to stop an unresponsive script and log an error message.

system.properties.classpath=[path1];[path2];[path3] ...

Specifies which jar files and class folders are in the classpath. For example:

system.properties.classpath=C\:\\myjars\\myLib1.jar;C\:\\myjars\\myLib2.jar

xml.conversion.data.model.directoriesRegisters data models that specify how to convert fixed-length data to and from XML. Enter a semicolon-separated list of directories that contain the appropriate data models.
browsertesting.chrome_executable_pathSpecifies the path to the Chrome executable. 
browsertesting.firefox_executable_path=[path]Specifies the path to the Firefox  executable.
browsertesting.proxy_port=[port]Specifies the proxy port. See the SOAtest User’s Guide> Proxy Configuration Details topic for more information and tips.
browsertesting.browser_communication_port=[port]Specifies the browser communication port.
browsertesting.startup_timeout=[seconds]Specifies the length of delay (in seconds) after which SOAtest should stop waiting for browser startup and consider it to be "timed out."
browsertesting.user_action_timeout=[seconds]Specifies the length of delay (in seconds) after which SOAtest should stop waiting for a user action and consider it to be "timed out."
browsertesting.page_load_timeout=[seconds]Specifies the default length of delay (in seconds) after which SOAtest should stop waiting for a page to load and consider it to be "timed out."

browsertest-
ing.asynchronous_request_timeout=[seconds]

Specifies the default length of delay (in seconds) after which SOAtest should stop waiting for an asynchronous request and consider it to be "timed out."
browsertesting.element_timeout=[seconds]Specifies the default length of delay (in seconds) after which SOAtest should stop waiting for an element and consider it to be "timed out."
browsertesting.dialog_timeout=[seconds]Specifies the default length of delay (in seconds) after which SOAtest should stop waiting for a dialog to open and consider it to be "timed out."
browsertesting.http_traffic_timeout=[seconds]

Specifies the default length of delay (in seconds) after which SOAtest should stop waiting for traffic to complete loading and consider it to be
"timed out."

browsertesting.print_debug_info=true|falseDuring recording of a browser functional test scenario, it is possible that an action taken is not recorded by SOAtest. Enabling this option will allow messages to be printed to the console during recording, with information about what events SOAtest handled, any locators that may have been generated, and if applicable, any exceptions that took place during recording.

browsertest-
ing.allowable_binary_extensions=[extensions]

Allows binary files with the specified extensions to be used in the Traffic Viewer and output. By default, only text files will be allowed. Extension lists are comma-separated.

browsertest-
ing.allowable_binary_mimetypes=[mime_types]

Allows binary files with the specified MIME types to be used in the Traffic Viewer and output. By default, only text files will be allowed. MIME type lists are comma-separated.
browsertesting.content_fetch_mode=all.con-tent|non.hidden.iframesEnables you to determine whether the contents of hidden frames are dis-played in the pre- and post-action HTML viewer.  For more details on this setting, see the SOAtest User’s Guide.
security.trust.all.certificatesIndicates that you want to accept any certificate. This is useful if you want to load pages whose certificates are not "trusted."
security.use.default.java.cacertsIndicates that you want to accept only certificates from the standard list of Java trusted certificate vendors.

Additional Options for Virtualize Only

Note that options covered in Additional Options for SOAtest and Virtualize also apply to Virtualize.

SettingPurpose
server.startupDetermines whether the server is automatically started upon Virtualize startup.
server.port.httpSpecifies the port that the Virtualize Server uses for HTTP.
server.port.httpsSpecifies the port that the Virtualize Server uses for HTTPS.
server.port.monitoringSpecifies the port that the Virtualize Server uses for monitoring.
traffic.wizard.xpath.ignores

Exclusions are specified in the format: 

traffic.wizard.xpath.ignores=[element name 1]:[value pattern 1];[element name 2]:[value pattern 2];[element name 3]:[value pattern 3]

For example,

traffic.wizard.xpath.ignores=*:[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0- 9]{2}:[0-9]{2}([.][0-9]{1,3})?(([+-][0-9]{2}:[0- 9]{2})|Z)?;uuid:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

Note that when the backslash character (\) is used in the regular expression, it needs to be escaped. For example, the regex [\d], which represents a single digit, would be entered as  [\\d].

Additional Options for Continuous Testing Platform (CTP)

SettingPurpose
env.manager.server

Specifies location of the CTP server. Required

Example: env.manager.server=http://em_hostname:8080/

env.manager.server.name

Specifies the name that will be used to label this server in CTP. You can specify any value that helps you identify this server. Optional

Example: env.manager.server.name=MyVirtServerLabel

env.manager.notify

Determines whether the Virtualize server notifies CTP when virtual assets are deployed. Optional

Example: env.manager.notify=true

env.manager.username

Specifies the username for logging into CTP. Optional

Example: env.manager.username=me

env.manager.password

Specifies the password for logging into CTP. Optional

Example: env.manager.password=12345

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 or Virtualize 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.

Sample Settings

The Team Server settings described in this section have been deprecated.

Example 1

# Team Server settings: (these may be redundant with settings already specified in Team Preferences of the installed version, so may not be needed).
tcm.server.enabled=true
tcm.server.name=<team_server.company.com>
 
# Report settings
report.developer_errors=true 
report.developer_reports=true 
report.format=html
session.tag=<project name>
 
# Mail settings:
report.mail.enabled=true
report.mail.cc=<[email protected];[email protected]> 
report.mail.server=mail.company.com
report.mail.domain=company.com
report.mail.subject=<Static Analysis results on Project X> 
report.mail.attachments=true

Example 2

# Team Server settings
tcm.server.enabled=true
tcm.server.name=teamserver.mycompany.com
tcm.server.port=18888
tcm.server.accountLogin=true
tcm.server.username=tcm_user
tcm.server.password=tcm_pass
 
 
# Mail settings
report.mail.enabled=true
report.mail.server=mail.mycompany.com   
report.mail.domain=mycompany.com   
report.mail.cc=project_manager   
report.mail.subject=Coding Standards

Example 3

# 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.url=http://license_server.domain.com: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
  • No labels

Need assistance? Visit our support page