通知テンプレートについて
通知テンプレートは、 システムで発生したイベントに関して、カスタマイズされたメッセージを送信するために使用されます。
用意されているテンプレート・タイプ
システムには、次のような通知テンプレート・タイプのセットが含まれています。
- 変更成果物マッチング・メッセージ
- フィルター・マッチング・メッセージ
- ジョブ中断メッセージ
- ジョブ失敗メッセージ
- ジョブ成功メッセージ
- ジョブ開始メッセージ
- ジョブ警告メッセージ
- パージ失敗メッセージ
- ステップ E メール・メッセージ
- ステップ失敗メッセージ
- ステップ成功メッセージ
- ステップ警告メッセージ
- システム・アラート・メッセージ
各タイプには一連の翻訳済みメッセージが含まれています。メッセージは、コンテキストを提供するために変数を使用します。
グローバルな使用
提供されているテンプレートは、次のようにグローバルに使用します。
- プロジェクト: 各プロジェクト内のプロパティーを使用して、プロジェクトの開始、成功、および失敗の通知タイプを通知できます。ジョブが警告を出して終了している場合、ジョブ警告の通知が行われます。
- ステップ: 各ステップ内のプロパティーを使用して、成功および失敗の通知タイプを通知できます。ステップの失敗後にジョブが続行されている場合、ステップ警告の通知が行われます。
- その他の通知タイプには以下があります。
- 変更成果物マッチング・メッセージ - ユーザーに関連する成果物が変更されました。
- ジョブ .break メッセージ - ジョブで、.break コマンドを含むステップが検出されました。
- ステップ .email メッセージ - ステップが .email コマンドを実行します。
- システム・アラート・メッセージ
トランスレーションに保管されるメッセージ
使用される通知メッセージは、テンプレート・タイプに関連したトランスレーション に保管されます。 それぞれのトランスレーションでは、その通知メッセージに関する情報が指定されます。
- 言語
- 説明
- タイトル (通知 E メールの件名として使用されます)
- 本文 (通知 E メールのメッセージ本文として使用されます)
用意された通知テンプレートおよびユーザーが作成する通知テンプレートの両方で、トランスレーションを編集することができます。
メッセージ・フォーマット
メッセージは、次の 2 つのいずれかのメッセージ・タイプで送信できます。
- プレーン・テキスト・メッセージ (デフォルト)
- MIME - 本文フィールドに特定の HTML タグが含まれている通知は、自動的に MIME メッセージとして送信されます。本文フィールドでの HTML の使用を参照してください。
テンプレート内の変数
システムは、テンプレートを構文解析して、いくつの変数があるかどうか調べます (環境変数およびレジスター変数の使用を参照してください)。
特定のプロジェクトおよびステップ用のカスタム・テンプレート
用意された通知タイプに基づいて、カスタマイズされた通知テンプレートを作成できます。 カスタマイズされたテンプレートは、プロジェクト、またはプロジェクト内の個別ステップに関連付けられている必要があります。 特定のプロジェクトおよびステップ用の新規テンプレートの作成を参照してください。
「テンプレート」パネルについて
「テンプレート」パネルは、イベントに関する通知をセットアップする場合に使用します。 パネルを表示するには、
を選択します。
Rational® Build Forge® に用意されているすべてのテンプレートがパネルにリストされます。新規テンプレートを作成する場合は、 以下のフィールドに情報を入力します。
- タイプ
- メッセージのタイプ。既存のテンプレート・タイプを選択します。
- プロジェクト
- メッセージを送信するプロジェクトを指定します。
- ステップ
- メッセージを送信するプロジェクト内にあるステップを指定します。
「トランスレーション (Translations)」パネルについて
テンプレートで使用されるメッセージをセットアップするには、「トランスレーション (Translations)」パネルを使用します。このパネルを表示するには、
と選択して、リストからテンプレートを選択してください。そのテンプレートのトランスレーションのリストが表示されます。リスト内の各項目には、以下の情報が表示されます。- 言語
- これは必須です。メッセージの言語。
- 説明
- リスト内でトランスレーションのタイトルとして使用されます。
- 記入者
- オプション: メッセージの「記入者」フィールドで使用される E メール・アドレス。以下の E メール・アドレス・フォーマットがサポートされています。
username@host.com name username@host.com name "<username@host.com>" name <username@host.com> name "username@host.com"
説明:
username は、E メールのユーザー名です。
name は、任意のストリング (通常、何らかの形で名前を表すもの) です。
- タイトル
- 必須: メッセージの「タイトル」フィールドで使用されるストリング。これには、変数を含めることができます。
- 本文
- 必須: メッセージの本文。これには、変数を含めることができます。