Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space CPPTDESKDEV and version 10.3.2

...

Localsettings can control report settings, Parasoft Concerto DTP settings, error authorship settings, Team Server settings, and more. If a parameter is specified in this file and there is an equivalent parameter in the GUI’s Preferences panel (available from Parasoft> Preferences), the parameter set in this file will override the related parameter specified from the GUI. 

...

  • Enter GUI-specified and manually-specified settings into Parasoft ConcertoDTP, which centralizes preference distribution and updating 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.

...

For a list of variables that can be used in reports, e-mail, Parasoft Report Project Center, Team Server, and license settings, see Using Variables in Preference Settings.

...

Localsettings can be stored on Parasoft Concerto DTP (where they are automatically applied to connected Parasoft Test installations) or in a local file (where they can be specified from the command line). 

...

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

...

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. 

Default: build-yyyy-MM-dd HH:mm:ss

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.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 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. 
report.graph.ue_coverage_start_date=[MM/dd/yy]Determines the start date for trend graphs that track coverage over a period of time. 
report.graph.ue_start_date=[MM/dd/yy]Determines the start date for trend graphs that track test execution results over a period of time. 
report.location_details=true|false

Specifies whether absolute file paths are added to XML data. This needs to be enabled on the Server installation if you want to relocate tasks upon import to desktop installations. 

Default: false

report.mail.attachments=true|false

Determines whether reports are sent as attachments. All components are included as attachments; before you can view an HTML report with images, all attachments must be saved to the disk.

Default: false

report.mail.cc=[email_addresses]Specifies where to mail comprehensive manager reports. This setting must be followed by a semicolon-separated list of email addresses. This setting is typically used to send reports to managers or architects. It can also be used to send comprehensive reports to team members if such reports are not sent automatically (for example, because authorship is not being determined by Parasoft Test).
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 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 "Jtest Report for Project A", you would use

report.mail.subject=jtest 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.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
SC - for statement coverage (C/C++test only) 
BCC - for block coverage (C/C++test only)
DC - for decision coverage (C/C++test, Jtest only)
SCC - for simple condition coverage (C/C++test only)
MCDC - for MC/DC coverage (C/C++test only)

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: ${config_name}


Parasoft

...

DTP /

...

Project Center Settings

SettingPurpose
concertodtp.autoconfig=true|false

Enables autoconfiguration with Parasoft Test settings stored on the Concerto DTP server.

Default: false

concertodtp.enabled=true|false

Determines whether the current Parasoft Test product C++testt is connected to ConcertoDTP

Default: false

concertodtp.user=[username]Specifies the username for Concerto DTP user authentication.
concertodtp.password=[password]Specifies the password for Concerto DTP user authentication.
concerto.reporting=true|false

Determines whether the current Parasoft Test product is connected to Parasoft Report Project Center. 

Default: false

concertodtp.server=[server]Specifies the host name of the Parasoft Concerto DTP server. 
concerto.data.port=[port]

Specifies the Parasoft Report Project Center port.

Default: 32323

concerto.webdtp.port=[port]

Specifies the Parasoft Concerto DTP server port.

Default: 80

concertodtp.user_defined_attributes=[attributes]

Specifies the user-defined attributes for Parasoft Report Project Center. 

Use the format key1:value1; key2:value2

For more details on attributes, see Connecting to Project Center.

concerto.log_as_nightly=true|false

Determines whether the results sent to Parasoft Report Project Center are marked as being from a nightly build. 

Default: false

concerto.use_resource_attributes=true|false

Determines whether Parasoft Report Project Center attributes specified in the GUI at the project level should be used. This allows you to disable project-level Parasoft Report Project Center attributes.

Default: true

generaldtp.project=[project_name]

Specifies the name of the Concerto DTP project that you want these results linked to. 

For more details on general projects, see Connecting to Project Center.

Default: Default Project

Team Server Settings

...

OptionDescription
bdf.import.location=[WORKSPACE|BDF_LOC|<path>]

You can specify an external location, or use the keyword WORKSPACE. If WORKSPACE is used, projects will be created in subdirectories within the workspace directory. 

If BDF_LOC is used and one project will be created, then it will be created in the exact location as the bdf file. If more then one project will be created, then the projects will be created in subdirectories within the bdf file location. Those subdirectories will be named with corresponding projects names.

If an external path is specified, then the project will be created in the specified location.

WORKSPACE is the default.For details on the available project creation options and their impacts, see the C++test User’s Guide.

bdf.import.pathvar.enabled=[true|false]

Specifies if Path Variables should be used in linked folders that will be created in the new projects. The default is false.
bdf.import.pathvar.name=<name>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 DEVEL_ROOT_DIR.
bdf.import.pathvar.value=<path>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.
bdf.import.compiler.family=<compiler_family>

Specifies what compiler family will be used (for example, vc_6_0, vc_7_0, vc_7_1, vc_8_0, gcc_2_9, gcc_3_2, gcc_3_3, gcc_3_4, ghs_4_0). For a custom compiler, you need to use the custom compiler family identifier, which is the name of the directory containing gui.properties, c.psrc and cpp.psrc files). If this property is not specified, the default values will be used.

bdf.import.c.compiler.exec=<exec>Specifies the executable of the C compiler that will be used in the created project.
bdf.import.cpp.compiler.exec=<exec>Specifies the executable of the C++ compiler that will be used in the created project.
bdf.import.linker.exec=<exec>Specifies the executable of the linker that will be used in the created project.
bdf.import.project.<proj_name>=dir1;dir2;dir3Specifies the set of folders to link for the project prj_name. Folders should be specified as a value list of folder paths, separated with semicolons.

...

Code Block
  # 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
 
  # Parasoft ReportProject Center settings   
  concerto.reporting=true
  concertodtp.server=concerto.mycompany.com
  concerto.webdtp.port=32323
 
  # 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   
  concerto.log_as_nightly=true

...

Code Block
# REPORTS
 
#Determines whether reports are emailed to developers and to the additional recipients specified with the cc setting.
#Remember that if the team is using CVS for source control and each developer's email address matches his or her CVS username + the mail domain, each developer that worked on project code will automatically be sent a report that contains only the errors/results related to his or her work.

report.mail.enabled=true
 
#Exclude developers emails (true/false) 
report.mail.exclude.developers=false
 
# Append developers errors to manager emails (true/false) 
report.developer_errors=true
 
# Send reports to developers (true|false) 
report.developer_reports=true
 
# Append suppressed messages (true|false) 
report.suppressed_msgs=false
 
#Determines where to mail complete test reports.
#This setting is typically used to send reports to managers or architects.
#It can also be used to send reports to developers if developer reports
#are not sent automatically (for example, because the team is not using CVS). 
[email protected]; ${env_var:USERNAME} @domain.com
 
# mail target for unknown developer errors 
[email protected]
 
#Specifies the mail server used to send reports. 
report.mail.server=mail_server.domain.com
 
#Specifies the mail domain used to send reports. 
report.mail.domain=domain.com
 
#Specify mali from 
report.mail.from=nightly
 
#Specifies any email addresses you do not want to receive reports.
#This setting is used to prevent from automatically sending reports to someone that worked on the code, but should not be receiving reports. This setting is only applicable if the team is using CVS for source control and developer reports are being sent automatically.
report.mail.exclude=developer1;developer2
 
# Specifies the subject line of the emails sent.
report.mail.subject= ${tool_name} Report - ${config_name}
 
# Report test params include (true|false) 
report.test_params=true
 
# Team Server
 
#Determines whether the current installation is connected to the Team Server. 
tcm.server.enabled=true
 
#Specifies the machine name or IP address of the machine running Team Server. 
tcm.server.name=team_server.domain.com
 
#Specifies the Team Server port number. 
tcm.server.port=18888
 
tcm.server.accountLogin=true 
tcm.server.username=user 
tcm.server.password=password 
session.tag= ${config_name}
 
# Parasoft ReportProject Center
 
#Determines the current installation is connected to Parasoft ReportProject Center. 
concerto.reporting=true
 
#Specifies the host name of the Parasoft ReportProject Center server. 
concertodtp.server=grs_server.domain.com
 
# Specifies the port number of the Parasoft ReportProject Center report collector. 
concerto.data.port=32323
 
# Specifies user-defined attributes for Parasoft ReportProject Center.
#Use the format key1:value1; key2:value2
#Attributes help you mark results in ways that are meaningful to your organization.
#They also determine how results are grouped in Parasoft ReportProject Center and how you can filter results in Parasoft ReportProject Center.
#For example, you might want to label results by project name and/or by project component name. #Each attribute contains two components: a general attribute category name
#and a specific identification value. For example, assume your organization wants to classify results by project.
#You might then use the attribute project:projname1. For the next project, you could use a different
#localsettings file that specified an attribute such as project:projname2.
concertodtp.user_defined_attributes=Type:Nightly;Project:Project1
 
# Determines whether the results sent to Parasoft ReportProject Center are marked as being from a nightly build.
concertoDTP.log_as_nightly=true
 
# 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
#jtest.license.autoconf.timeout=40
jtest.license.use_network=true
jtest.license.network.host=license_server.domain.com 
jtest.license.network.port=2222
jtest.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