This topic explains how you can specify settings to control options for reporting, task assignment, licensing, and more. Local settings can be used to share preferences across a team as well as to apply different groups of settings to different projects and test runs.
Sections include:
About Localsettings
Localsettings can control report settings, Parasoft DTP settings, error authorship settings, and more. You may want to create a file with localsettings to:
- 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).
- Enter GUI-specified and manually-specified settings into Parasoft DTP, which centralizes preference distribution and updating across the team.
- Adjust settings without having to open the GUI.
If an option is configured both in the localsettings file and in the GUI, localsettings will override the GUI configuration.
Specifying and Storing Localsettings
There are two ways to specify localsettings:
- Enter them manually in a simple text file. There are no name or location requirements.
Export your GUI preferences as described in Exporting GUI Preferences to a localsettings File then adjust or extend them as needed.
Creating a Local Settings (Options) File by Exporting Your GUI Preferences
The fastest and easiest way to create options files is to export your Preferences from the GUI.
- Choose Parasoft> Preferences.
- Select Parasoft (the root element in the left tree).
- Click the share link in the right side of the panel.
- In the dialog that opens, specify which preferences you want to export to a file.
- Click the Browse button, then specify the file where you want the settings saved.
- Click OK.
- If you select an existing file, the settings will be appended to that file. Otherwise, a new file will be created.
- Exported passwords will be encrypted.
Localsettings can be stored on Parasoft DTP (where they are automatically applied to connected C/C++test installations) or in a local file (where they can be specified from the command line). For details on how to store and apply localsettings, see C++test Configuration Overview.
Additional Information
- Each setting should be entered on a single line.
- We highly recommend that you use encoded passwords to ensure successful authentication and increase the level of security; see Creating an Encoded Password.
- If you are importing preferences from localsettings specified on DTP and you want to override these settings from the GUI, you can clear the Use DTP settings option on the appropriate page, then manually configure the settings.
- If any localsettings 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.
Available Settings
Reporting Settings
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 default is |
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 |
| Specifies the location and extension of the XSL file for a custom format. Used with For details and examples, see Configuring 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. See Understanding Reports for more details on these reports. |
report.graph.ue_coverage_start_date=[MM/dd/yy] | Determines the start date for trend graphs that track coverage over a period of time. See Understanding Reports for more details on these reports. |
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 (for example, because the team is not using a supported source control system). |
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 developer that worked on project code will automatically be sent a report that contains only the errors/results related to his or her work. 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.server=[server] | Specifies the mail server used to send reports. |
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.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 "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.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. |
Parasoft DTP Settings
Setting | Purpose |
---|---|
dtp.enabled=true|false | Determines whether the current C/C++test installation is connected to DTP. |
dtp.server=[server] | Specifies the host name of the DTP server. |
dtp.port=[port] | Specifies the port number of the DTP server. |
dtp.user=[username] | Specifies the username for DTP server authentication. |
dtp.password=[password] | Specifies the password for DTP server authentication. We highly recommend that you use an encoded password to ensure successful authentication and increase the level of security; see Creating an Encoded Password. |
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. |
report.dtp.publish =true|false | Enables or disables reporting results to DTP server. |
dtp.project=[project_name] | Specifies the name of the DTP project that you want these results linked to. |
dtp.additional.settings=[KEY1\=VALUE1\nKEY2\=VALUE2...] | Specifies advanced settings for reporting results to DTP. |
dtp.autoconfig=true|false | Enables autoconfiguration with C/C++test settings stored on the DTP server |
Team Server Settings
Setting | Purpose |
---|---|
tcm.server.enabled=true|false | Determines whether C/C++test is connected 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 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
See Manually Adding the License to localsetttings for additional notes and examples.
Setting | Purpose |
---|---|
cpptest.license.use_network=true|false | Enables or disables retrieving a network license. Example: Default: true By default, C/C++test will try to retrieve a license form License Server on the DTP configured as your primary DTP server; see Parasoft DTP Settings. If you want to configure another License Server, enable the |
cpptest.license.local.password=[password] | Specifies the local password that you want C/C++test to use. |
cpptest.license. local.expiration=[expiration] | Specifies the expiration date of the local license. Default: 0 |
cpptest.license. network.edition=[edition_name] | Specifies the type of license that you want C/C++test to retrieve from License Server.
Example:
Default: custom_edition |
cpptest.license.custom_edition_features=[feature name] | Specifies the features you want to enable in the custom edition of the C/C++test license. |
cpptest.license.wait.for.tokens.time=[time in minutes] | Specifies the time that C/C++test will wait for a license if a license is not currently available. For example to make C++test wait 3 minutes for license tokens, use Default: 0 |
cpptest.license.autoconf.timeout=[seconds] | Specifies the maximum number of seconds C/C++test will wait for the license to be automatically configured from License Server. Default: 20 |
license.network.use.specified.server =true|false | Enables or disables retrieving the license from a custom License Server specified with the Example: Default: false |
license.network.host=[host] | Specifies the host name of the standalone License Server, secondary DTP, or legacy License Server that you use to obtain the license. It requires the Example:
|
license.network.port=[port] | Specifies the port number that is assigned to License Server specified with the
Example: |
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. Example: |
license.network.connection.type=[http|tcp] | Specifies the connection type if you obtain your license from a custom License Server.
It requires the Example: |
license.network.auth.enabled= | Enables or disables authentication on the secondary DTP server specified with the It requires the |
license.network.user=[username] | Specifies the username for authentication on the secondary DTP server specified with the Example: |
license.network.password=[password] | Specifies the password for authentication on the secondary DTP server specified with the Example: |
OpenID Connect Settings
Setting | Purpose |
---|---|
oidc.enabled= | Enables or disables user authentication via OpenID Connect. The default is |
oidc.issuer.uri=[uri] | Specifies the URI of the OpenID Connect server where your DTP is registered. |
oidc.client.id=[id] | Specifies the ID registered on your OpenID Connect server. |
oidc.client.secret=[password] | Specifies the password provided by your OpenID Connect server. |
oidc.keystore=[path] | Specifies the path to the keystore file that stores the certificate to authenticate the user on the OpenID Connect server. |
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; see Creating an Encoded Password. |
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.callback.host=localhost | 127.0.0.1 | This setting specifies the local callback host configured in the IDE to communicate with the OpenID Connect server. This is an IDE-related setting and is not intended for command line use. The default is |
oidc.callback.port=0 | [port number] | This setting specifies the callback port number configured in the IDE to communicate with the OpenID Connect server. This is an IDE-related setting and is not intended for command line use.
The default is |
oidc.callback.timeout=[seconds] | This setting specifies the maximum time allowed for providing user credentials on the authentication page to authenticate on DTP via OpenID Connect when working with C/C++test in the IDE. This is an IDE-related setting and is not intended for command line use. The default is |
Technical Support Settings
Setting | Purpose |
---|---|
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.
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. Default: false |
techsupport.dtp.engine=true|false | Specifies if additional data generated during analysis will be sent. Default: false |
Authorship/Scope Settings
Setting | Purpose |
---|---|
authors.mappings.location=team|local|shared | Specifies where the authorship mapping file is stored. This setting defaults to If set to If set to The
Default: team |
authors.mapping{n}=[from_user, to_user] | Specifies a specific author mapping for For example:
|
authors.user{n}=[username, email, full_name] | Specifies a specific author name and email for For example:
|
authors.mappings.file=[path] | Specifies the location of a "shared" file as described in For example:
|
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 C++test computes code authorship based on a data from a supported source control system. This setting is not needed if you want to use the value specified in the GUI. Default: false |
scope.local=true|false | Determines whether C++test computes code authorship based on the local user. This setting is not needed if you want to use the value specified in the GUI. Default: true |
scope.recommended.computation=first|random | Determines how C/C++test selects the Recommended Tasks for each team member—it can choose n tasks at random (the default) or select the first n tasks reported (n is the maximum number of tasks that C/C++test is configured to show 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
AccuRev Repository Definition Properties (deprecated)
Property | Description |
---|---|
scontrol.rep.type=accurev | AccuRev repository type identifier. |
scontrol.rep.accurev.host= | AccuRev server host. |
scontrol.rep.accurev.port= | AccuRev server port. Default port is 1666. |
scontrol.rep.accurev.login= | AccuRev user name. |
scontrol.rep.accurev.password= | AccuRev password. |
ClearCase Repository Definition Properties (deprecated)
Property | Description |
---|---|
scontrol.ccase.exec= | Path to external client executable (cleartool ). |
scontrol.rep.type=ccase | ClearCase repository type name. |
scontrol.rep.ccase.vob= | Path inside VOB. ccase.vob value + File.separator must be the valid path to a ClearCase controlled directory. |
CVS Repository Definition Properties (deprecated)
Property | Description |
---|---|
scontrol.rep.type=cvs | CVS repository type identifier. |
scontrol.rep.cvs.root= | Full CVSROOT value. |
scontrol.rep.cvs.pass= | Plain or encoded password. The encoded password should be the same as in the . For CVS use the value in . For CVSNT use the value store in the registry under When you are first logged in to the CVS repository from the command line using "cvs login", the password is saved in the registry. To retrieve it, go to the registry (using regedit), and look for the value under |
scontrol.rep.cvs.useCustomSSHCreden-tials= | Determines whether the cvs login and password should be used for EXT/SSH connections. Allowed values are true and false . It is disabled by default. |
scontrol.rep.cvs.ext.server | If connecting to a CVS server in EXT mode, this specifies which CVS application to start on the server side. Has the same meaning as the CVS_SERVER variable . |
scontrol.rep.cvs.ssh.loginname= | Specifies the login for SSH connections (if an external program can be used to provide the login). |
scontrol.rep.cvs.ssh.password= | Specifies the password for SSH connection. |
scontrol.rep.cvs.ssh.keyfile= | Specifies the private key file to establish an SSH connection with key authentication. |
scontrol.rep.cvs.ssh.passphrase= | Specifies the passphrase for SSH connections with the key authentication mechanism. |
scontrol.rep.cvs.useShell= | Enable an external program (CVS_RSH) to establish a connection to the CVS repository. Allowed values are true and false . It is disabled by default. |
scontrol.rep.cvs.ext.shell= | Specifies the path to the executable to be used as the CVS_RSH program. Command line parameters should be specified in the cvs.ext.params property. |
scontrol.rep.cvs.ext.params= | Specifies the parameters to be passed to an external program. The following case-sensitive macro definitions can be used to expand values into command line parameters:
|
Git Repository Definition Properties
Property | Description |
---|---|
scontrol.rep.type=git | Git 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
Property | Description |
---|---|
scontrol.perforce.exec= | Path to external client executable (p4 ). |
scontrol.rep.type=perforce | Perforce 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). |
Serena Dimensions Repository Definition Properties (deprecated)
Linux Configuration Note
To use Serena Dimensions, Linux users should run C/C++test in an environment prepared for using Serena programs, such as 'dmcli'.
- LD_LIBRARY_PATH should contain the path to <SERENA Install Dir>/libs.
- DM_HOME should be specified.
Property | Description |
---|---|
scontrol.rep.type=serena | Serena Dimensions repository type identifier. |
scontrol.serena.dmroot= | Path to the Serena Dimensions executable (e.g., scontrol.serena.dmroot=C\:\\Program Files (x86)\\Serena\\Dimensions 2009 R2\\CM\\ ) |
scontrol.rep.serena.login= | Login name. |
scontrol.rep.serena.password= | Password. |
scontrol.rep.serena.host= | Serena Dimensions server host name. |
scontrol.rep.serena.dbname= | Name of the database for C/C++test |
scontrol.rep.serena.dbconn= | Connection string for that database. |
scontrol.rep.serena.locale= | The language used (e.g., scontrol.rep.serena.locale=en_US ). |
scontrol.rep.serena.mapping= | If the project has been downloaded/moved to a location other than default work area, use this option to specify a mapping between the project (or stream) with the Serena repository and the local project. If you are working in the default work area, you do not need to define mappings. |
StarTeam Repository Definition Properties (deprecated)
Property | Description |
---|---|
scontrol.rep.type=starteam | StarTeam repository type identifier. |
scontrol.rep.starteam.host= | StarTeam server host. |
sscontrol.rep.starteam.port= | StarTeam server port. Default port is 49201. |
scontrol.rep.starteam.login= | Login name. |
scontrol.rep.starteam.password= | Password (not encoded). |
scontrol.rep.starteam.path= | When working with large multi-project repositories, you can improve performance by specifying the project, view, or folder that you are currently working with. You can indicate either a simple Project name (all views will be scanned when searching for the repository path), a Project/View (only the given view will scanned) or Project/View/Folder (only the specified Star Team folder will be scanned). Examples:
|
scontrol.rep.starteam.workdir= | If the Examples:
|
Subversion Repository Definition Properties
Property | Description |
---|---|
scontrol.rep.type=svn | Subversion 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 ). |
CM Synergy Repository Definition Properties (deprecated)
Property | Description |
---|---|
scontrol.rep.type=synergy | Synergy/CM repository type identifier. |
scontrol.rep.synergy.host= | Computer on which synergy/cm engine runs. Local host is used when missing. For Web mode, the host must be a valid Synergy Web URL with protocol and port (e.g., http://synergy.server:8400). |
scontrol.rep.synergy.dbpath= | Absolute synergy database path e.g \\host\db\name (backslash symbols '\' in UNC/Windows paths must be doubled). |
scontrol.rep.synergy.projspec= | Synergy project spec which contains project name and its version e.g name-version. |
scontrol.rep.synergy.login= | Synergy user name. |
scontrol.rep.synergy.password= | Synergy password (not encoded). |
scontrol.rep.synergy.port= | Synergy port. |
scontrol.rep.synergy.remote_client= | (UNIX only) Specifies that you want to start ccm as a remote client. Default value is false. Optional. This is not used for Web mode. |
scontrol.rep.synergy.local_dbpath= | Specifies the path name to which your data-base information is copied when you are running a remote client session. If null, then the default location will be used. This is not used for Web mode. |
scontrol.synergy.exec= | Path to external client executable (ccm ) |
Microsoft Team Foundation Server Repository Definition Properties
Property | Description |
---|---|
scontrol.rep.type=tfs | TFS repository type identifier. |
scontrol.rep.tfs.host= | Name of the machine running TFS. |
scontrol.rep.tfs.port= | TFS server’s port number (optional; when not specified, 8080 is used). |
scontrol.rep.tfs.protocol= | The protocol used to connect to TFS server. Available values are HTTP and HTTPS. |
scontrol.rep.tfs.url= | TFS repository URL (for example, http://localhost:8080/tfs ). |
scontrol.rep.tfs.login = | TFS username. Ensure you provide the same username that you used to configure the TFS repository on your machine. |
scontrol.rep.tfs.password= | TFS password. |
Microsoft Visual Source Safe Repository Definition Properties (deprecated)
Property | Description |
---|---|
scontrol.rep.type=vss | Visual SourceSafe repository type identifier. |
scontrol.rep.vss.ssdir= | Path of repository database (backslash symbols '\' in UNC/Windows paths must be doubled). |
scontrol.rep.vss.projpath= | VSS project path. |
scontrol.rep.vss.login= | VSS login. |
scontrol.rep.vss.password= | VSS password. |
scontrol.vss.exec= | Path to external client executable (ss ). |
scontrol.vss.lookup= | Determines whether a full VSS database search is performed to find associations between local paths and repository paths. True or false. |
Important Notes
- The repository(n).vss.ssdir property shouldco ntain a UNC value even if the repository database resides locally.
- Be aware of VSS Naming Syntax, Conventions and Limitations. Any character can be used for names or labels, except the following:
- Dollar sign ($)
- At sign (@)
- Angle brackets (< >), brackets ([ ]), braces ({ }), and parentheses (( ))
- Colon (:) and semicolon (;)
- Equal sign (=)
- Caret sign (^)
- Exclamation point (!)
- Percent sign (%)
- Question mark (?)
- Comma (,)
- Quotation mark (single or double) (' ")
- VSS 6.0 (build 8163), which is deployed with Visual Studio 6, does not work properly with projects whose names start with a dot (.) symbol. If such a project name is used, subprojects cannot be added.
- Do not use custom working directories for sub-projects (example: Project $/SomeProject has the working directory C:\TEMP\VSS\SomeProject and its subproject $/SomeProject/SomeSubProject has the working directory D:\SomeSubProject).
Settings for Creating or Importing Projects
Settings for Creating BDF-Based Projects
Option | Description |
---|---|
| You can specify an external location, or use the keyword If If an external path is specified, then the project will be created in the specified location.
For details on the available project creation options and their impacts, see Working with C++test Projects. |
| Specifies if Path Variables should be used in linked folders that will be created in the new projects. The default is false. |
| Specifies the name of the Path Variable (if Path Variables are used, per the bdf.import.pathvar.enabled property). The default Path Variable name is |
| Specifies the value of the Path Variable (if Path Variables are used, per the bdf.import.pathvar.enabled property). The default value is the most common root directory for all linked folders. |
| Specifies what compiler family will be used (for example, |
| Specifies the executable of the C compiler that will be used in the created project. |
| Specifies the executable of the C++ compiler that will be used in the created project. |
| Specifies the executable of the linker that will be used in the created project. |
| Specifies the set of folders to link for the project |
Settings for Importing Green Hills .gpj Projects
Setting | Purpose |
---|---|
gpj.import.location=WORKSPACE|ORIG|<path> | Specifies the location of the imported projects. If If If an external path is specified, then the project will be created in the specified location. The default value is |
gpj.import.linked=true|false | Specifies whether the The default value is |
gpj.import.subdirs=true|false | Applicable when Specifies whether the project(s) are imported into subdirectories or directly into the specified location. If you want the project(s) imported into subdirectories created in the specified external location, use true. If you are importing only one project and you want it imported directly into the specified external location, use false. The default value is true (subfolders are created for each project imported into in external location). |
gpj.import.pathvar.enabled=true|false | Specifies if path variables should be used when creating linked directories (if the above option is set to true). The default value is |
gpj.import.pathvar.name=<name> | Specifies the path variable name. The default value will be used unless you specify a path variable name that points to a different location (for instance, If a project with the specified name is already defined in the Eclipse workspace and it points to a different location than the value passed in the The default value is |
gpj.import.pathvar.value=<path> | Specifies the path variable value. By default, C++test calculates the common root for all linked folders. |
gpj.import.compiler.family=name | Specifies the compiler family (compiler ID) |
gpj.import.c.compiler.exec=name | Specifies the C compiler executable |
gpj.import.cpp.compiler.exec=name | Specifies the C++ compiler executable |
gpj.import.linker.exec=name | Specifies the linker executable |
Settings for Importing IAR Embedded Workbench .ewp Projects
Setting | Purpose |
---|---|
ewp.import.location=WORKSPACE|EWP_LOC|<path> | Specifies the location of the imported projects. If If If an external path is specified, then the project will be created in the specified location. The default value is |
ewp.import.config=<name> | Specifies which .ewp project configuration should be used. If the specified configuration cannot be found in the imported project, then the default configuration will be used. The configuration name can be passed in two ways: <project_name> - <configuration_name> or only <configuration_name>. If more then one project is imported, then only <configuration_name> should be entered. This prompts the wizard to search for that configuration in all projects. The default value is the default from .ewp. |
ewp.import.linked=true|false | Specifies whether the .project source folders are linked to the created Eclipse project. Default: |
ewp.import.subdirs=true|false | Specifies whether the project(s) are imported into subdirectories or directly into the specified location. Applicable when Set to Set to |
ewp.import.pathvar.enabled=true|false | Set to The default value is |
ewp.import.pathvar.name=name | Specifies the path variable name. The default name is |
ewp.import.pathvar.value=<path> | Specifies the path variable value. By default, C++test calculates the common root for all linked folders. |
Settings for Importing Microsoft Visual Studio 6.0 .dsp Projects
Setting | Purpose |
---|---|
dsp.import.location=WORKSPACE|DSP_LOC|<path> | Specifies the location of the imported projects. If If If an external path is specified, then the project will be created in the specified location. The default value is |
dsp.import.linked=true|false | Specifies whether the .dsp project source folders are linked into the created Eclipse project. The default value is |
dsp.import.subdirs=true|false | Applicable when Specifies whether the project(s) are imported into subdirectories or directly into the specified location. If you want the project(s) imported into subdirectories created in the specified external location, use true. If you are importing only one project and you want it imported directly into the specified external location, use false. The default value is true (subfolders are created for each project imported into in external location). |
dsp.import.pathvar.enabled=true|false | Specifies if path variables should be used when creating linked directories (if the above option is set to true). The default value is |
dsp.import.pathvar.name=<name> | Specifies the path variable name. The default value will be used unless you specify a path variable name that points to a different location (for instance, If a project with the specified name is already defined in the Eclipse workspace and it points to a different location than the value passed in the The default value is |
dsp.import.pathvar.location=<loc> | Specifies what location the path variable points to. By default, the automatically-generated location will be used. This location is the common root location for all linked directories. If it is not possible to find a common location (for example because .dsp projects are on multiple drives) or the specified location cannot be used, then the path variable will not be used. Full paths will be used instead. For example, assume you have the following paths:
The common root location would be The default value is automaticallygenerated. |
dsp.import.config=<name> | Specifies which .dsp project configuration should be used. If the specified configuration cannot be found in the imported project, then the default configuration will be used. The configuration name can be passed in two ways: The default value is the default from |
For example, if the folder C:\temp\sources should be linked in an imported project and we have defined the path variable DEVEL_ROOT_DIR
with the value C:\temp, then that folder will be linked as DEVEL_ROOT_DIR/sources and the DEVEL_ROOT_DIR
path variable will be created in the workspace. If such a variable cannot be used (for example, because its value points to another folder not containing C:\temp\sources folder, it is already defined and has different value, or it has an invalid value), then C:\temp\sources folder will be linked using the full path C:\temp\sources.
Settings for Importing Keil uVision Projects
Setting | Purpose |
---|---|
uv.import.location=WORKSPACE|ORIG|<path> | Specifies the location of the imported projects. If If If an external path is specified, then the project will be created in the specified location. The default value is |
uv.import.linked=true|false | Specifies whether the The default value is |
uv.import.subdirs=true|false | Applicable when Specifies whether the project(s) are imported into subdirectories or directly into the specified location. If you want the project(s) imported into subdirectories created in the specified external location, use If you are importing only one project and you want it imported directly into the specified external location, use The default value is |
uv.import.pathvar.enabled=true|false | Specifies if path variables should be used when creating linked directories (if the above option is set to The default value is |
uv.import.pathvar.name=<name> | Specifies the path variable name. The default value will be used unless you specify a path variable name that points to a different location (for instance, If a project with the specified name is already defined in the Eclipse workspace and it points to a different location than the value passed in the The default value is |
uv.import.pathvar.value=<path> | Specifies the path variable value. By default, C++test calculates the common root for all linked folders. |
uv.import.config=<name> | Specifies the name of the build configuration to use. |
Settings for Importing Renesas High-performance Embedded Projects
Setting | Purpose |
---|---|
hew.import.location=WORKSPACE|ORIG|<path> | Specifies the location of the imported projects. If If If an external path is specified, then the project will be created in the specified location. The default value is |
hew.import.linked=true|false | Specifies whether the The default value is |
hew.import.subdirs=true|false | Applicable when Specifies whether the project(s) are imported into subdirectories or directly into the specified location. If you want the project(s) imported into subdirectories created in the specified external location, use If you are importing only one project and you want it imported directly into the specified external location, use The default value is |
hew.import.pathvar.enabled=true|false | Specifies if path variables should be used when creating linked directories (if the above option is set to true). The default value is |
hew.import.pathvar.name=<name> | Specifies the path variable name. The default value will be used unless you specify a path variable name that points to a different location (for instance, If a project with the specified name is already defined in the Eclipse workspace and it points to a different location than the value passed in the The default value is |
hew.import.pathvar.value=<path> | Specifies the path variable value. By default, C++test calculates the common root for all linked folders. |
hew.import.config=<name> | Specifies the name of the build configuration to use. |
Miscellaneous Settings
Setting | Purpose |
---|---|
report.rules=[url_path_to_rules_directory] | Specifies the directory for rules html files (generated by clicking the For example:
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 |
| Indicates where user-defined rules are saved. |
| Indicates where user-defined Test Configurations are saved. |
custom.compilers.dir=[directory] | Overrides the custom compiler directory settings (found in Parasoft> Configurations> Custom compilers) and uses the defined directory to search for custom compilers. |
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 Indicating Code and Test Correlations. |
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 memory available to Parasoft Test. Default: false |
cpptest.fail.setup.problems =true|false | Enables or disables returning the Default: false |
Using Variables in Local Settings (Options) Files
The following variables can be used in report, e-mail, Parasoft DTP, Team Server, and license settings.
The session tag value must not contain any ':' characters.
env_var
example: ${env_var:HOME}
Outputs the value of the environmental variable specified after the colon.
project_name
example: ${project_name}
Outputs the name of the tested project. If more than one project is provided as an input, it first outputs the tested project name, then "..."
workspace_name
example: ${workspace_name}
Outputs an empty string.
config_name
$ example: ${config_name}
Outputs the name of executed test configuration; applies only to report and email settings.
analysis_type
$ example: ${analysis_type}
Outputs a comma separated list of enabled analysis types (for example: Static, Generation, Execution); applies only to reports and email settings.
tool_name
$ example: ${tool_name}
Outputs the tool name (for example: C/C++test).
Examples
Example 1
# 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
# Parasoft DTP settings dtp.enabled==true dtp.server=server1.mycompany.com dtp.port=32323 dtp.user=smith dtp.password=?1q2W3e4R5t6Y7u8I9o! # 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 #network license retrieved from DTP dtp.enabled=true dtp.server=onya.mycompany.com dtp.port=443 dtp.user=user1 dtp.password=mypassword cpptest.license.use_network=true # SOURCE CONTROL scontrol.rep1.type=cvs scontrol.rep1.cvs.root=:pserver:developer@cvs_server.domain.com:/home/cvs/scontrol.rep1.cvs.pass=mypassword