メール コンテンツのカスタマイズ (バッチ通知)

このページの内容

お困りですか?

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

コミュニティに質問

バッチ通知を使用する場合、一定の期間中に発生した課題の更新がグループ化され、1 つの要約メールで送信されます。バッチ通知の外観を制御するテンプレートは、Jira inform - batchers アプリにあります。ご利用の Jira インストールでこのアプリを見つけ、テンプレートを抽出してから編集する必要があります。

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

考慮事項

  • テンプレートを変更した後に Jira を再起動する必要はありません。
  • テンプレートを含むアプリは Jira のアップグレードごとに上書きされ、変更を再適用する必要があります。テンプレートのコピーを保管しておくと、変更をより迅速に再適用できます (バージョンが変更される可能性があるため、アプリケーション全体をコピーしないでください)。

  • メールの外観の変更のほかに、通知対象の課題をより詳細に確認できるよう、任意のカスタム フィールドを追加できます。詳細については、「カスタム フィールドをメールに追加する」を参照してください。

ステップ 1: Velocity テンプレートの取得

バッチ メール通知に使用される Velocity テンプレートは、Jira inform-batchers アプリにあります。これらを抽出する必要があります。

1. アプリ バージョンを調べる

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

  1. [管理] (> [アプリの管理] に移動して、[アプリの管理] ページを開きます。

  2. ドロップダウンで [すべてのアプリ] を選択し、"Jira inform - batchers" を検索します。

  3. アプリを展開し、バージョンを確認します (以下の例では 1.1.3 です)。 

    Jira inform - batchers アプリ。

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

アプリを別のディレクトリにコピーします。Jira インストール ディレクトリ内の .jar ファイルは編集しないでください。変更を元に戻す必要がある場合に備えて、元の JAR ファイルを保持することもおすすめします。

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

  2. batchers-<version>.jar ファイルを見つけます。

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

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

テンプレートを抽出する最も簡単な方法は、以下のコマンドを使用することです。このコマンドを動作させるには JDK がインストールされている必要があることにご注意ください。 

jar xf batchers-1.1.3.jar templates/email

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

Velocity テンプレートを抽出したら、それらを直接編集できます。

1. 更新するテンプレートを選択

一括メール通知ではいくつかのテンプレートが使用されます。最も重要なファイルは次のとおりです。

テンプレート ファイル説明

IssueUpdateBatcher-subject.vm

課題更新時のメール件名。

IssueUpdateBatcher-header.vm

メール ヘッダー。これには、メールで表示される最初の区切り文字より手前のすべての情報 (プロジェクト名、課題名、課題キー、および更新を要約した導入テキスト) が含まれます。

このファイルは、メンションにも使用されます。

IssueUpdateBatcher-content.vm (HTML 形式の場合)

IssueUpdateBatcher.vm (テキスト形式の場合)

作成された課題、課題の更新、およびコメントの詳細などのすべての変更の一覧を含む、メールの主要部分。

このファイルは、メンションにも使用されます。

MentionIssueUpdateBatcher-subject.vm

メンションのメールの件名。

footer.vm

メールのフッター。


2. テンプレートの編集

Jira は html 形式とテキスト形式のメールをサポートしています。Jira で設定された形式に従って手順を選択する必要があります。

テキスト形式...
  1. 変更するメール部分に対応した Velocity テンプレートを見つけます。すべてのテンプレートは次のディレクトリにあります。

    /templates/email/batch/text/
  2. テンプレートを任意のテキスト エディターに取り込みます。「Velocity Users Guide」を参照し、必要なカスタマイズを行います。

HTML 形式...
  1. 変更するメール部分に対応した Velocity テンプレートを見つけます。すべてのテンプレートは次のディレクトリにあります。

    /templates/email/batch/html/
  2. テンプレートを任意のテキスト エディターに取り込みます。「Velocity Users Guide」を参照し、必要なカスタマイズを行います。

ステップ 3: Jira への更新されたテンプレートのアップロード

変更のテスト

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

  1. JAR ファイルにテンプレートを戻します。 

    jar uf batchers-1.1.3.jar templates/email
  2. アプリを Jira にアップロードします。

    1. [管理] () > [アプリの管理] > [アプリの管理] に進みます。

    2. [アプリのアップロード] をクリックし、JAR ファイルをアップロードします。アプリが再インストールされると、変更が表示されます。Jira インスタンスを再起動する必要はありません。

トラブルシューティング

テンプレートの編集時に発生する一般的な問題です。

変更を元に戻す場合...

Jira インストール ディレクトリには、Jira inform - batchers アプリの元のバージョンが含まれます。変更を元に戻すには、アプリの JAR ファイルを見つけ、[管理] () > [アプリの管理] > [アプリの管理] に移動して、手動でアップロードします。

アプリの JAR ファイルは <jira-installation-directory>/atlassian-jira/WEB-INF/atlassian-bundled-plugins/ にあります。

変更がメールに表示されない...

この問題は、Jira インスタンスが使用している Jira inform - batchers アプリと異なるバージョンのテンプレートを編集する場合に多く発生します。バージョンの最適な取得方法については、「ステップ 1: Velocity テンプレートの取得」を参照してください。

Jira のアップグレード後に変更が反映されない...

Jira inform - batchers アプリおよびそれに含まれるテンプレートは、Jira インスタンスをアップグレードするたびに上書きされます。つまり、アップグレード後に変更を再適用する必要があります。テンプレートのコピーを保管すると、より迅速に変更を再適用することができます。

最終更新日 2020 年 7 月 9 日

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

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