メールコンテンツのカスタマイズ
Jira はテンプレート エンジン (Apache の Velocity) を使用して、イベントに対応するメールを生成します。これは java オブジェクトを便利な方法で分離できる、使いやすいテンプレート言語です。ヘッダーやフッダーへの情報の追加やメールのコンテンツの入れ替えなどのために多数のカスタマイズを行い、要件に応じてメールを調整できます。
このページは Jira Data Center 用です
Jira Server を使用している場合は、ここで説明した方法とは異なる方法でテンプレートを取得する必要があります。詳細については、「Jira Server でのメール コンテンツのカスタマイズ」を参照してください。
メール テンプレートへのアクセス
メール テンプレートにアクセスするには、次の操作を実行します。
[管理] > [システム] > [メール テンプレート] に移動します。このページのアクションを実行するには、Jira System Administrator である必要があります。
ダウンロード: 使用可能なすべてのテンプレートを含む ZIP アーカイブをダウンロードし、ローカルで編集します。
アップロード: 編集が完了したら、アーカイブを Jira に再度アップロードします。アーカイブは、元のファイル構造と同じである必要があります。下記の「必要なファイル構造」を参照してください。
既定に戻す: アップロードしたテンプレートに問題がある場合、既定のテンプレートに戻します。Jira は、既定のテンプレートをそのリソースから Jira 共有ホーム ディレクトリにコピーします。
メール テンプレートの編集
メール テンプレートを編集すると、メール通知の外観を変更できます。これは、会社のブランディングを追加したり、コンテンツを再編成したりする場合に便利です。テンプレートを編集する時は、Velocity テンプレート言語を使用するので、それに関する知識が欠かせません。すべてのテンプレートの一覧とその説明を表示するには、次の内容をチェックしてください。
テンプレートのアップロード
テンプレートを ZIP アーカイブにアーカイブし、Jira に再度アップロードする必要があります。以下では、必要なものについて説明します。
必要なファイル構造
テンプレートを編集する際、Jira がファイル構造を検証するため、ファイル名やフォルダ内の場所を変更しないでください。グラフィックなどのファイルをアーカイブに追加し、テンプレートからリンクすることができます。
Jira は、必要なテンプレートが存在する場合にのみチェックします。テンプレートの構文やエラーは検証されません。
次のファイル構造が認められます。または、テンプレート フォルダを省略することもできます。
- templates
- email
- email-batch変更の適用
テンプレートをアップロードしても、すぐには適用されません。Jira は最初にファイル構造を検証し、すべて正しいと判断した場合、変更を適用するように依頼します。いったんこの操作を行うと、新しいテンプレートは <Jira-shared-home>/data/templates/data/templates に移動され、そこに存在するファイルは上書きされます。
テンプレートを既定に戻す
変更したテンプレートで何かが正しくない場合、[既定に戻す] をクリックして既定のテンプレートに戻すことができます。この操作を実行すると、次のような結果になります。
Jira は、既定のテンプレートをそのリソースから Jira 共有ホーム ディレクトリにコピーします。
既定のテンプレートは
<Jira-shared-home>/data/templatesの中にある既存のテンプレートをすべて上書きします。Jira はテンプレート キャッシュをクリアし、既定のテンプレートがすぐに適用されます。
考慮事項
以下に、きっとお役に立つその他の情報を紹介します。
テンプレート: 既定のテンプレートと現在のテンプレートの比較
現在のテンプレート
現在のテンプレートとは、Jira がメール通知に使用するテンプレートです。これらは Jira 共有ホーム ディレクトリに保存され、新しい ZIP アーカイブをアップロードして変更を適用するたびに更新されます。
個別の課題通知 (およびその他のイベント):
<Jira-shared-home>/data/templates/emailバッチ処理された課題通知:
<Jira-shared-home>/data/templates/email-batch
既定のテンプレート
既定のテンプレートとは、Jira リソースのインストール ディレクトリ (個別の課題通知およびその他のイベント) またはプラグインのいずれか (バッチ処理された課題通知) に保存されるバックアップ テンプレートのことです。Jira 8.14 以前では、メールをカスタマイズするにはこのテンプレートを編集します。これらのテンプレートはバックアップとして機能し、次の場合にのみ使用されます。
ファイルが見つからない: Jira 共有ホーム ディレクトリにいずれかのテンプレートがありません。そのようなテンプレートのために、Jira は既定のテンプレートにフォールバックします。
既定に戻す: 自らの選択でテンプレートを既定に戻します。既定のテンプレートが共有ホーム ディレクトリにコピーされ、現在のテンプレートが上書きされます。
既定のテンプレートが動作する仕組みが上記のように定められているので、Jira が常に元に戻せるまたはフォールバックできるものが存在するように、このテンプレートは変更しないようにしてください。
アップグレード時に変更を保持
メール テンプレートは Jira 共有ホーム ディレクトリに保存されるため、変更内容はアップグレード時にも保持されます。また、テンプレートを編集した後に Jira を再起動する必要はありません。
メール テンプレートをキャッシュする
Jira 共有ホーム ディレクトリ内のすべてのテンプレートがキャッシュされます。これにより、共有ディレクトリにアクセスできない場合でも、Jira はこれらのテンプレートを使用できます。見つからないファイルに関する情報はキャッシュされません。いずれかのテンプレートが共有ディレクトリに存在しない場合、Jira はそのファイルを毎回読み込もうとし、既定のテンプレートにフォールバックします。