Configuring Project Keys

Project Key Pattern

The jira.projectkey.pattern property allows JIRA administrators to specify a Perl5 regular expression value that defines the rule for a valid project key. During project creation, JIRA project administrators must specify a project key that conforms to this rule.

This property and its regular expression value can be defined through the Advanced Settings page.

Default Project Key Pattern

By default, the JIRA project key configuration requires two or more uppercase alphabetical characters — based on the regular expression ([A-Z][A-Z]+).

Configuring Different Project Key Patterns

To configure a different rule for your project key syntax, change the regular expression (via the 'Advanced Settings' page). Below is a list of common examples and patterns:

注意:

• JIRA は指定された正規表現を先頭に「^」を付け、システム内の完全一致ルールには「$」で閉じます。
• The project key must only be allowed to contain ASCII characters, as it is used in HTTP GET requests.
• The project key only supports uppercase characters. For simplicity, use uppercase characters in your expressions as JIRA will convert any lowercase characters to uppercase ones.

Do not use ".", "-", or "_"

• Avoid using the dot (.) character (i.e. dot/period/full-stop), as the CreateOrCommentHandler currently fails to add comments to existing issues if the project key contains a dot (.) — see JRA-23180.
• Avoid using the dash (-) character, as this character is inserted automatically after the regular expression and before the issue ID number.
• Avoid using the underscore (_) character as there is a current bug in JIRA 5.x that the activity streams will not work for project keys using underscores — see JRA-27967.

Warning!

• If a number of issues have already been created in your JIRA installation, then changing the project key is not recommended.
• If you must change the project key pattern after issues have already been created, use a regular expression that allows a more 'permissive' project key pattern than the current one (e.g. use a regular expression which will still be valid for existing project keys defined in your JIRA installation).

Customising the Error Message for Invalid Keys

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-config.properties file so that when a user keys in the wrong format, they will be informed of the correct pattern to use.

Testing Your Regular Expression

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

Project Key Details

You can customise the following properties in the jira-config.properties file:

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