編輯JIRA項目鍵及其注意事項

當創建JIRA項目時，你應該選擇一個滿足長期需求的鍵，而不是根據項目創建之后再更改。不過，也有需要更改現有項目鍵的情況，如更改產品名稱。下面主要教大家如何更改項目的鍵，以及描述這種變化所帶來的影響。

首先

• 項目鍵的格式必須是JIRA限制規定的格式。默認情況下，項目鍵格式必須至少為2個字符，并且只包含大寫字母。
  你可以更改項目鍵的格式來實現不同的限制。
• 在低使用率期間執行此更改—當保存更新項目鍵時JIRA將啟動后臺重新索引。這可能會對實例的性能產生影響。注意，不能選擇 “Lock JIRA and rebuild index”，盡管它會使后臺索引變快，但是將受限于項目的問題。
• 將更改傳達給用戶—確保你知道更改項目鍵的后果，且用戶已做好充分準備。

編輯項目鍵

1. 導航到JIRA項目，并訪問項目管理頁面。選擇Project Administration（項目導航欄的底部）。
2. 選擇Edit Project按鈕。
3. 選擇Key字段旁邊的edit key。
4. 更改鍵并點擊Update。  

注意：

• 頁面上的其它字段，保存后可以直接看到更改后的信息。而不需要等待重新索引完成。
• 不要取消后臺重新索引。如果取消，那么搜索與項目有關的問題時將出錯。如果需要取消，你可以稍后再取消。

更新任務

• Fix the project entity links—當你把JIRA和其它Atlassian應用程序鏈接時，JIRA項目和其他應用程序相關的項目（如Confluence spaces）之間的實體鏈接會被自動創建。如果JIRA項目的鍵更改了，那你需要修改項目的實體鏈接。
• Updating JIRA Agile board filters—如果JIRA敏捷主板使用舊項目鍵，過濾器板需要更新到新的項目鍵。否則，版上可能不會顯示更名后的項目問題。

變更管理注意事項

編輯項目的鍵是一個大的更改，多數情況下， 期望JIRA項目以新鍵運行。注意以下少數情況。

• 舊的項目鍵可用于JQL查詢 - 用戶將不必更新引用舊項目鍵的問題過濾器。
• 如果將Confluence和JIRA一起使用，Confluence中的JIRA問題宏將繼續有效。注意，如果你沒有馬上看到更改，是因為緩存更新需要時間。
• 你不能使用舊的項目鍵來創建一個新的項目。但你可以將重命名的項目改回舊的項目鍵。如果刪除該項目，所有相關的鍵將被釋放，你就可以重新使用它們。
• 無論是來自JIRA內部或是外部的鏈接都將正常工作。然而，鏈接別名不會被更新 - 例如，如果有一個鏈接到名為“EXAMPLE-1”的鏈接，將該項目的鍵“EXAMPLE”改為“DEMO”后，別名'EXAMPLE-1'不會更新為 'DEMO-1'，但該鏈接還是會鏈接到DEMO-1。
• 如果你在全局過濾器使用Activity Stream小工具，你需要在項目重命名后更新過濾器。
• 當項目的鍵更改后所有附件也可訪問。但注意，它們的存儲目錄（\data\attachments）將保留舊的項目鍵。例如，如果把項目的鍵從TEST改為DEMO后，附件的存儲目錄仍是\data\attachments\TEST。
• 如果導出一個重命名的項目再將其導入，將顯示更新后的項目鍵，即不會保留原來的項目鍵。事實上，該項目的所有歷史鍵都將被移除。有一種解決方法，就是直接在你的數據庫修改數據。

相關話題

Changing the maximum project key length—你可以修改項目鍵的最大字符長度。導航到JIRA管理控制臺的General Configuration頁面修改Maximum project key size字段。
Changing the project key format—你可以修改項目鍵的格式，但當創建或編輯項目鍵時，這將限制其格式。

開發人員注意事項

• 在項目鍵更改后REST API調用指定關鍵問題時仍用舊的項目鍵。例如，項目鍵從EXAMPLE 改為 DEMO后，/rest/api/issue/EXAMPLE-100仍可用。
• ProjectUpdatedEvent事件被創建，任何時候項目的細節包括項目的鍵發生改變該事件將被觸發。
• 要想檢索所有問題鍵和項目鍵，你可以通過以下方式：
  REST:
  • 獲取所有項目鍵: /rest/api/2/project/?expand=projectKeys
  Java API:
  • 獲取所有項目鍵: com.atlassian.jira.project.ProjectManager#getAllProjectKeys
  • 獲取所有問題鍵: com.atlassian.jira.issue.IssueManager#getAllIssueKeys