This page last changed on May 10, 2009 by rosie@atlassian.com.

JIRA provides the ability to specify the format of project keys within the system. This is achieved by defining a regular expression 'rule' that governs the valid project key format.

Project Key Pattern

Through the property jira.projectkey.pattern, the administrator can specify a Perl5 regular expression defining the rule for a valid project key. This property can be found in the jira-application.properties file. During project creation, the user must specify a project key that conforms to this rule.

JIRA prepends the regular expression specified with '^' and closes it with '$' for an exact matching rule within the system. The project key must only be allowed to contain ASCII characters, as it is used in HTTP GET requests.

Editing the key pattern

This can be done by editing jira-application.properties. You will then need to restart JIRA (JIRA Standalone) or rebuild the JIRA webapp and redeploy in your app server.

Project Key Details

The jira-application.properties file also contains the following properties:

  • jira.projectkey.description — a configurable description (to match the project key pattern) displayed on project creation
  • jira.projectkey.warning — a configurable validation warning (to match the project key pattern)
It is not possible to configure the issue key pattern as JIRA expects this key to conform to specific rules.
Further information on Perl5 is available here.
Document generated by Confluence on Oct 06, 2009 00:25