JIRA 4.3 : Configuring Project Keys
This page last changed on Dec 16, 2010 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 PatternThrough the property jira.projectkey.pattern, the administrator can specify a Perl5 regular expression defining the rule for a valid project key. During project creation, the user must specify a project key that conforms to this rule.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. Default Restrictions for Project KeysBy default, JIRA project key configuration is restricted to use two or more uppercase alphabetical characters. Configuring Different Project Key PatternsTo configure a different rule for your Project Key syntax, change the regular expression in the <jira-install/atlassian-jira/WEB-INF/classes/jira-application.properties file. Below is a list of common examples and patterns:
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.
Customising the Error Message for Invalid KeysIf JIRA detects that the project key entered does not match the jira.projectkey.pattern, it will throw the error message defined in jira.projectkey.warning. You can change jira.projectkey.warning in the jira-application.properties so that when a user keys in the wrong format, they will be informed of the correct pattern to use. Testing Your Regular ExpressionA variety of tools allow searching using a Regular Expression. Most text editors will allow a Regular Expression search. There are also a variety of websites available to for testing a Regular Expression available from an Internet search. Project Key DetailsThe jira-application.properties file also contains the following properties:
|
![]() |
Document generated by Confluence on Mar 27, 2011 18:33 |