Jira Server でのメール コンテンツのカスタマイズ

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

Jira generates emails in reaction to events using a templating engine—Apache’s Velocity. This relatively easy-to-use templating language can pull apart java objects in useful ways. Whether adding some info to the header or footer or shuffling around the contents of your emails, you can make a number of customizations and tailor the emails to your needs.

Velocity テンプレートやその他の Jira ファイルのカスタマイズは、アトラシアン サポートの範囲には含まれません。

はじめる前に

Jira Server の電子メール テンプレートは、次の 2 つの場所に格納されます。

  • Jira インストール ディレクトリ: バッチ処理された課題通知
  • Jira inform - batchers アプリ: 個別の課題通知やその他のイベント

Your choice of the location to retrieve depends on what kind of notifications you want to customize. If you’re not sure what notifications you’re using, see Different types of email notifications in Jira.

tip/resting Created with Sketch.

This article is for Jira Server. If you’re using Jira Data Center, you will retrieve the templates in a different way. Learn more about it in Customizing email content.

バッチ処理された課題通知用のテンプレートの取得

バッチ処理された課題通知用のテンプレートを取得します。 

考慮事項

  • You don't need to restart Jira after modifying these templates.
  • The app that contains the templates will be overwritten with every Jira upgrade, and you'll need to reapply your changes. We recommend keeping the copy of the templates somewhere, so you can reapply the changes more quickly. But we don't recommend copying the whole app, because its version may change. 

Step 1: Retrieve Velocity templates

Velocity templates used for batched issue notifications are in the Jira inform - batchers app. You should extract them.

1. Find out the app's version

Jira インストール ディレクトリに、このアプリの複数のバージョンがある場合があります。現在のバージョンを確認して、後で編集するファイルを確認します。

  1. [管理] ( ) > [アプリの管理] を選択します。 

  2. Go to Manage apps. From the dropdown list, select All apps. Search for Jira inform - batchers.

  3. Expand the app and check the version. In the screenshot, it’s 1.1.3. 

    Jira inform - batchers アプリ。

2. Jira インストール ディレクトリからアプリをコピーする

Copy the app to a separate directory. You should never edit the .jar files inside the Jira installation directory. We also recommend keeping the original .jar file in case you need to revert the changes.

  1. <jira-installation-directory>/atlassian-jira/WEB-INF/atlassian-bundled-plugins/ に移動します。

  2. Find the batchers-<version>.jar file.

  3. ファイルを別のディレクトリにコピーします。

3. アプリの JAR ファイルからテンプレート ファイルを抽出する

Use the following command to extract the templates. Note that you’ll need a JDK installed for it to work. 

jar xf batchers-1.1.3.jar templates/email

Step 2: Edit Velocity templates

Once you’ve extracted Velocity templates, you can edit them directly. For more information about the templates and what you can do with them, see: Templates: Batched issue notifications.

Step 3: Upload updated templates to Jira

変更のテスト

本番環境に適用する前に、ステージング環境で変更をテストすることをおすすめします。Velocity 構文に違反した場合、メールは一切送信されません。

  1. Insert the templates back into the .jar file with this command:

    jar uf batchers-1.1.3.jar templates/email
  2. Upload the app to Jira. Choose Administration () > Manage apps

  3. Go to Manage apps. Select Upload app and upload the .jar file. The changes will be visible once the app is reinstalled. You don’t need to restart your Jira instance.

Retrieving templates for separate issue notifications and other events

これらのテンプレートを取得して、個別の課題通知、またはユーザーの作成、パスワードを忘れた場合、管理者への連絡などのその他の通知をカスタマイズします。

考慮事項

Any changes to Velocity templates and JSPs (JavaServer Pages) will be overwritten after a Jira upgrade. In this case, you should manually copy the modified files to the new Jira version.

If Velocity templates or JSPs have changed in a later version, you should manually port your customizations into them, but not copy these files directly over from the old Jira installation to the upgraded one.

Step 1: Retrieve Velocity templates

To retrieve the templates:

  1. ご利用の Jira インストール ディレクトリの以下の場所に移動します。 

    /atlassian-jira/WEB-INF/classes/templates/email/

    Jira ソース ファイルを使用している場合、jira/src/etc/java/templates/email/ に移動します。

  2. Under this directory, you should see three subdirectories:

    • html contains templates used to create emails in HTML.
    • text contains templates used to create plain text mailouts.
    • subject contains templates used to generate the subject of emails.

新しいメール テンプレートの作成

  1. Create new mytemplate.vm files in the htmltext , and subject directories, based on the existing files in those directories
  2. テンプレートを atlassian-jira/WEB-INF/classes/email-template-id-mappings.xml に追加して、新しいイベントを追加する際に選択できるようにします。

ステップ 2: Veloctity テンプレートの編集

Once you’ve extracted Velocity templates, you can edit them directly. For more information about the templates and what you can do with them, see Templates: Separate issue notifications and other events.

ステップ 3: Jira の再起動

After modifying Velocity templates, you should restart your Jira instance to apply the changes.

オプション: Jira を再起動せずに Velocity テンプレートをデプロイする

On a development instance, you pick up velocity file changes without restarting Jira.
From <jira-install>/atlassian-jira/WEB-INF/classes/velocity.properties:

  1. class.resource.loader.cache を true から false に変更します。
  2. #velocimacro.library.autoreload=true からコメント記号 (#) を削除します。

On a production instance, this change allows you to go back to default Velocity templates and make changes in them without restarting Jira.

最終更新日 2022 年 8 月 4 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.