Reference for integration project and build properties
In this topic: |
Project properties displayed by kwadmin
The following table provides a list of project properties displayed by the command kwadmin get-project-properties. Those properties that are editable can be set with kwadmin set-project-property.
Property | Description | OK to edit? | Allowable values | Example value |
---|---|---|---|---|
auto_delete_threshold | specifies the number of builds to save when the auto delete feature is enabled | yes | Numerical value; pass a null value to turn off the retention policy | 10 |
bug_tracker_schema | Used to replace {0} with id, and convert id to a hyperlink | N/A | url pattern that passes the information to the bug tracker url | https://bugs.example.com/project/id={0} |
copy_tables | specifies whether Klocwork tables will be copied to projects_root by kwadmin load | yes | true or false | true |
creator | user ID under which the project was created | no | N/A | joebloggs |
database.host | Database Server host name | no | N/A | myserver.acme.com |
database.port | Database Server port | no | N/A | 3306 |
database.started_by | user ID that started the Database Server | no | N/A | adminuser |
database.type | Database type | no | name of database type | mysql |
database.user | the user who started the Database Server | no | N/S | kw |
description | project description | yes (editable in Validate) | N/A | This project contains toolbus source code. |
disable_stream_ci_defects |
Specifies whether CI builds will load stream defects to the server. |
yes | true or false | true |
enable_exact_file_match | Disable auto-matching to give you more control over your project. Use in conjunction with .emp file that can be loaded (and edited) onto a project. | yes | true or false | true |
enable_group_calculations | changes the way the system displays server issues. By default, desktop and server issues are shown with grouping off. If you want issues for a project to persistently show issues with grouping on, change the setting to true. This option enables grouping calculations during build/load stage and is required in order for 'grouping_on_default' and 'grouping:on' to work correctly. If you disable 'enable_group_calculations', the build will not calculate groups, kwadmin load will not load groups and 'grouping:on' will not work (empty results). | yes | true or false | false |
grouping_on_default |
changes the way the system displays server issues. By default, desktop issues are shown with grouping off while server issues are shown with grouping on. If you want server issues for a project to persistently show issues with grouping off, change the setting to false. Note: This option causes searches which don't include "grouping:off" to return empty. You must pair it with 'enable_group_calculations=true' (and a build loaded after that) in order to return useful results. |
yes | true or false | true |
incompatible_server_versions | server versions that are incompatible with the current projects_root directory | no | N/A | 6.1,7.0 |
klocwork.host or web.host | Klocwork Server host name | no | N/A | myserver.acme.com |
klocwork.port or web.port | Klocwork Server port number | no | N/A | 8080 |
klocwork.started_by or web.started_by | user ID that started the Klocwork Server | no | N/A | adminuser |
language | programming language of the source files in the project | yes | comma-separated list. Acceptable values: c, cxx, java, csharp | c,cxx |
license.host | License Server host name | no | N/A | myserver.acme.com |
license.port | License Server port | no | N/A | 27000 |
locale | overrides the locale for the project set during project creation. Should only be set before running an integration build analysis with kwbuildproject, so that the language of issue messages and traceback will be consistent in all builds | yes | en, ja | ja |
project_creation_time_stamp | project creation timestamp; localized by Validate | no | N/A | 1136234753965 |
project_creation_version | for internal use | no | N/A | 21.0 |
project_version | for internal use | no | 21.0 | |
projects_root_creation_version | for internal use | no | N/A | 21.0 |
same_kind_defect_per_file_threshold |
When configured, this setting prevents an integration or CI build from being loaded into the project if any file contains defects of the same type (for example, ABV.EXAMPLE) that exceed the specified threshold. This is particularly useful for large projects with slow builds. If not configured, the default threshold is set to 0, meaning there is no limit on the number of same defects (infinite). If you have a build that fails due to exceeding the configured defect threshold, consider the following actions:
|
yes | Numerical value; pass 0 to turn off the threshold limit | 5000 (recommended) |
source.tables | location of pre-built tables used for the project | no | N/A | C:\klocwork\projects_root\projects\MyProject\builds\build_4\tables |
source_encoding | language encoding of project source files. See kwadmin create-project. | yes | language encodings. Use the --list option of kwconv to find the list of acceptable values. | utf-8 |