メール コンテンツのカスタマイズ (バッチ通知)
バッチ通知を使用する場合、一定の期間中に発生した課題の更新がグループ化され、1 つの要約メールで送信されます。バッチ通知の外観を制御するテンプレートは、Jira inform - batchers アプリにあります。ご利用の Jira インストールでこのアプリを見つけ、テンプレートを抽出してから編集する必要があります。
Velocity テンプレートやその他の Jira ファイルのカスタマイズは、アトラシアン サポートの範囲には含まれません。
考慮事項
- テンプレートを変更した後に Jira を再起動する必要はありません。
- テンプレートを含むアプリは Jira のアップグレードごとに上書きされ、変更を再適用する必要があります。テンプレートのコピーを保管しておくと、変更をより迅速に再適用できます (バージョンが変更される可能性があるため、アプリケーション全体をコピーしないでください)。
- メールの外観の変更のほかに、通知対象の課題をより詳細に確認できるよう、任意のカスタム フィールドを追加できます。詳細については、「カスタム フィールドをメールに追加する」を参照してください。
ステップ 1: Velocity テンプレートの取得
バッチ メール通知に使用される Velocity テンプレートは、Jira inform-batchers アプリにあります。これらを抽出する必要があります。
1. アプリ バージョンを調べる
Jira インストール ディレクトリに、このアプリの複数のバージョンがある場合があります。現在のバージョンを確認して、後で編集するファイルを確認します。
> [アプリの管理] に移動し、[アプリの管理] ページを開きます。
ドロップダウンで [すべてのアプリ] を選択し、"Jira inform - batchers" を検索します。
アプリを展開し、バージョンを確認します (以下の例では 1.1.3 です)。
2. Jira インストール ディレクトリからアプリをコピーする
アプリを別のディレクトリにコピーします。Jira インストール ディレクトリ内の .jar ファイルは編集しないでください。変更を元に戻す必要がある場合に備えて、元の JAR ファイルを保持することもおすすめします。
Go to <jira-installation-directory>/atlassian-jira/WEB-INF/atlassian-bundled-plugins/.
batchers-<version>.jar ファイルを見つけます。
ファイルを別のディレクトリにコピーします。
3. アプリの JAR ファイルからテンプレート ファイルを抽出する
テンプレートを抽出する最も簡単な方法は、以下のコマンドを使用することです。このコマンドを動作させるには JDK がインストールされている必要があることにご注意ください。
jar xf batchers-1.1.3.jar templates/email
ステップ 2: Veloctity テンプレートの編集
Velocity テンプレートを抽出したら、それらを直接編集できます。
1. 更新するテンプレートを選択
一括メール通知ではいくつかのテンプレートが使用されます。最も重要なファイルは次のとおりです。
テンプレート ファイル | 説明 |
---|---|
| 課題更新時のメール件名。 |
| メール ヘッダー。これには、メールで表示される最初の区切り文字より手前のすべての情報 (プロジェクト名、課題名、課題キー、および更新を要約した導入テキスト) が含まれます。 このファイルは、メンションにも使用されます。 |
| 作成された課題、課題の更新、およびコメントの詳細などのすべての変更の一覧を含む、メールの主要部分。 このファイルは、メンションにも使用されます。 |
| メンションのメールの件名。 |
footer.vm | メールのフッター。 |
2. テンプレートの編集
Jira は html 形式とテキスト形式のメールをサポートしています。Jira で設定された形式に従って手順を選択する必要があります。
ステップ 3: Jira への更新されたテンプレートのアップロード
変更のテスト
本番環境に適用する前に、ステージング環境で変更をテストすることをおすすめします。Velocity 構文に違反した場合、メールは一切送信されません。
JAR ファイルにテンプレートを戻します。
jar uf batchers-1.1.3.jar templates/email
アプリを Jira にアップロードします。
> [アプリの管理] > [アプリの管理] に進みます。
[アプリのアップロード] をクリックし、JAR ファイルをアップロードします。アプリが再インストールされると、変更が表示されます。Jira インスタンスを再起動する必要はありません。
トラブルシューティング
テンプレートの編集時に発生する一般的な問題です。