E メール通知の送信

E メール通知サービスを使用して、実行したベースラインの完了状況を通知する自動 E メール通知を送信できます。

始める前に

E メール通知を送信するには、通知サービスをセットアップおよび構成する必要があります。

このタスクについて

通知サービスをインストールおよび構成した後、ベースラインの完了状況を通知する E メール通知を送信できます。

E メールを通知を送信するには、以下のステップを実行します。

手順

通知サービスを使用するために、タスク 2245「Sample Task: Send an Email Notification」の変更済みコピーを、通知を送信するポイントでベースラインのコンポーネントとして追加します。例えば、ベースラインが完了したときに E メール通知を送信する場合、ベースラインの最後のコンポーネントとしてタスクを追加します。タスクをコピーして、以下のように変更します。

タスク 2245「Sample Task: Send an Email Notification using Static Action Script Content」をコピーします。

関連度「True」以外のすべての関連度を削除し、アクション・スクリプトの詳細を変更し、以下のキーに固有の設定を含めることによって、タスクのコピーを変更します。以下の例に含まれているキーは、通知を送信するために最低限必要なキーを表しています。

// NOTIFICATION_START 
// to: "< your comma separated list of recepient email addresses goes here >"
// from: "< your single email address that will be shown as the sender of 
            the email goes here >" 
// subject: "< your email title goes here >" 
// body: "< your main email detail content goes here >" 
// NOTIFICATION_END

キーの完全なリストを以下の表に示します。

表 1. 通知のキー
キー	説明 (Description)
`to`	通知の送信先の E メール・アドレス。有効な値は、有効な E メール・アドレスのコンマ (,) 区切りリストです。これは必須キーです。
`from`	通知 E メールの送信者として表示される E メール・アドレス。この E メール・アドレスは存在する必要はありませんが、指定する値は有効な E メール・アドレス形式でなければなりません。これは必須キーです。
`subject`	E メールの件名として表示される通知の要約。任意のテキストがこのキーに対して有効な入力です。入力するテキストには、実行時に置換されるトークンを含めることができます。これは必須フィールドです。
`body`	E メールのメインの通知テキスト・コンテンツ。実行時に置換されるトークンを含む、任意のテキストをこのキーに対して入力できます。これは必須フィールドです。
`failure-trigger`	通知が送信されることになる失敗の回数を定義します。このキーを指定すると、指定した数の失敗が発生したときに通知が送信されます。このキーを省略すると、通知は完了時に送信されます。0 より大きい整数を入力してください。これはオプションのキーです。
`scope`	アクションが失敗したか正常に完了したかを判別する際に、結果状況についてどのアクションを検査するかを決定します。このキーを省略すると、これらの通知コンポーネントを含むアクションの結果が検査されます。有効な値は `parent` です。これは、通知コメントを含むアクションの代わりに、親ベースラインの結果を検査することを意味します。これはオプションのキーです。

タスクの変更済みコピーを保存します。
変更済みのコピーを、E メール通知送信の対象であるベースラインに追加します。

タスクの変更方法の全情報についてタスクの説明を確認し、ベースラインに含めます。サンプルが以下の「サンプル」セクションに記載されています。

ベースラインを実行します。ベースラインが完了すると、指定した E メール・アドレスに E メールによる通知が送信されます。

例

以下のサンプルは、キーの使用方法を示しています。

以下の通知コメントを伴ったタスクをコンポーネントとしてベースラインに追加すると、このタスク (コンポーネント) の完了時に電子メールが送信されます (たとえば、ベースラインの中間に追加すると便利です)。

// NOTIFICATION_START 
// to: "me@me.com, you@you.com"
// from: "noreply@bigfixteam.mycompany.com" 
// subject: "Basline component '{actionName}' has completed successfully" 
// body: "Baseline is 50% complete now" 
// NOTIFICATION_END

以下の通知コメントで構成されたタスクをコンポーネントとしてベースラインに追加すると、そのベースライン全体が完了した時に E メールが送信されます。

// NOTIFICATION_START 
// to: "me@me.com, you@you.com"
// from: "noreply@bigfixteam.mycompany.com" 
// subject: "Basline '{actionName}' with ID {actionID} has completed successfully" 
// body: "The Baseline is complete!" 
// scope: "parent"
// NOTIFICATION_END

上の 2 つの例は、静的に対象指定されたベースラインにのみ追加できます。グループ、プロパティー、または名前リストにより対象指定されたベースラインでは、通知送信は有効になりません。

静的または動的に対象指定されるベースラインでは、以下のサンプルを指定できます。

// NOTIFICATION_START 
// to: "me@me.com, you@you.com"
// from: "noreply@bigfixteam.mycompany.com" 
// subject: "Basline '{actionName}' with ID {actionID} has failed on 5 or more computers" 
// body: "Review the results of Baseline '{actionName}' (ID: {actionID})" 
// failure-trigger: "5"
// scope: "parent"
// NOTIFICATION_END