Project template properties

Project template properties can be specified for custom project templates you create.

Note:

If custom templates are used, then to have Polarion replace the Work Item Prefix from template-provided Work Items, add the following lines to your template.properties file:trackerPrefixToReplace=PREFIX, where PREFIX is the Work Item prefix specified in the project template's development project. For example, if your development project's Work Item prefix is "MYTEMPL", then you should specify trackerPrefixToReplace=MYTEMPL in the properties file.

process=.polarion/tracker/fields/workitem-type-enum.xml

These lines are added automatically in templates that ship with Polarion.

For information on project templates and creating custom project templates, see Customizing Project Templates

Each project template may contain a file named template.properties in its root. Use of this file is not required, but is recommended. The file has a standard Java properties file format. The following properties are recognized:

name

Short template name

description

Longer template description

parameters

Names of parameters required for project creation. Separated by ; (semicolon). The parameter names might contain letters, - (dash), and _ (underscore). Names are case sensitive. The following parameters are predefined:

```
project-id
```
```
project-name
```
```
tracker-prefix
```
```
trackerPrefixToReplace
```

skip

List of files/directories to exclude from copying to a new project's directory tree. (template.properties is excluded automatically). Names cannot start with a / (forward slash).

process

List of text files where the parameters will be substituted during project creation. Files are separated by a ; (semicolon). Names cannot start with a / (forward slash)

param.PARAM_ID.name

Human readable names of parameters defined in the parameters property

template.properties file example

name=Abc Software Project

description=Standard software development project for ABC-Corp, Inc. Development Teams

process=.polarion/polarion-project.xml

process=.polarion/tracker/fields/workitem-type-enum.xml

parameters=project-name

param.project-name.name=Project Name

Other files/directories in the template directory are copied to the new project directory during the creation process (except those listed in the skip property). Files listed in the process property are assumed to be text files. During the project creation process, all strings having the form %param-id% are replaced by the actual parameter value. For parameters defined in the parameters property, there is also a predefined parameter project-id, which contains the ID of a newly created project.