Documentation for JIRA 4.0. Documentation for other versions of JIRA is available too.

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. 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 Keys

By default, JIRA project key configuration is restricted to use two or more uppercase alphabetical characters.

Configuring Different Project Keys

To configure a different rule to 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:

Avoid using the dash (-) character, as this character is inserted automatically after the regular expression and before the issue ID number (for our JIRA project, bugs look like JRA-1330).

要求されたパターン

必要な表現

結果の課題 ID

コメント

XXYY、ここで X は 2 つの固定された文字、Y は 2 つの固定された桁数を示す

([A-Z]{2}[0-9]{2})

TQ09-01、TQ09-02、など。

[A-Z] Any characters from A to Z
{2} Matches the preceding character 2 times exactly
[0-9] Any character from 0 to 9

XZ, where X indicates two or more letters, Z presents one or more digit or alphabet

([A-Z][A-Z0-9]+)

ACAT51-1, AAA5-1330, A20091-15

[A-Z] Any characters from A to Z
[A-Z0-9] Any character from A to Z or 0 to 9
+ specifies [A-Z0-9] as one or more characters from A to Z or 0 to 9

If 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.

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. 

Testing Your Regular Expression

さまざまなツールによって、正規表現を使用した検索が可能です。ほとんどのテキストエディターでは、正規表現検索を許可しています。また、インターネット検索で利用可能な正規表現をテストできる、さまざまな Web サイトもあります。

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.



Log a request with our support team.



Raise an issue for our developers.



See answers from the community.



Blog and update.

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.