3 通知テンプレートの管理

Oracle Identity Managerで発生したイベントに関する情報は、リクエスタ、受益者、管理者などのさまざまなユーザーに送信する必要があります。このイベントに関する情報は、通知電子メール・メッセージ形式の通知サービスを使用して送信されます。Oracle Identity Managerでは通知サービスを使用してすべての通知関連操作を実行できます。

イベントとは、Oracle Identity Managerで発生する操作で、ユーザー作成、リクエスト開始またはユーザーが作成した任意のカスタム・イベントなどが含まれます。イベントは、ビジネス操作またはエラー生成の一部として生成されます。イベント定義は、イベントを記述するメタデータです。イベントのメタデータは、機能コンポーネントでサポートされるすべてのイベント・タイプを識別して提供されます。たとえば、スケジューラ・コンポーネントの一部として、スケジュール・ジョブ実行の失敗とスケジューラの停止に対してメタデータを定義できます。ジョブが失敗するかスケジューラが停止されるたびに、そのイベントが発生します。

イベントで使用可能なデータを使用して、通知のコンテンツが作成されます。イベントに定義されたさまざまなパラメータにより、システムは適切な通知テンプレートを選択できます。イベントに対してさまざまなパラメータが定義されていると、システムがテンプレート設計時にすべてのイベント変数を使用可能にするものを決定しやすくなります。

通知テンプレートは、通知を送信するために使用されます。これらのテンプレートには、より詳細な通知を提供するために、使用可能なデータを参照する変数が含まれています。通知が送信されるチャネルは、通知プロバイダと呼ばれます。このリリースでは、電子メールのみを通知プロバイダとして使用できます。バックエンドでは、通知エンジンが通知の生成と通知プロバイダを利用した通知の送信を担当します。

注意:

通知の送信用に、名前がEmail ServerでタイプがMail ServerのITリソースを構成する必要があります。電子メール・サーバー設定はキャッシュされます。すでに構成されている電子メール・サーバーの詳細を変更した場合は、必要に応じてアプリケーション・サーバーを再起動するか、キャッシュを削除する必要があります。

表3-1に示すように、Oracle Identity Managerにはデフォルトの通知テンプレート・セットが用意されています。

表3-1 デフォルトの通知テンプレート

通知テンプレート	説明
バルク・リクエスト作成	バルク親リクエストの作成中に通知するためのテンプレート
ユーザー・セルフ・サービス通知の作成	新規ユーザーが作成された後に通知するためのテンプレート
終了日	報告先の終了日に達したときにマネージャに通知するためのテンプレート
生成されたパスワードの通知	Oracle Identity Managerによってパスワードが生成された後に通知するためのテンプレート
リクエスト作成	リクエスト作成中に通知するためのテンプレート
リクエスト・アイデンティティ作成	ユーザーの作成リクエスト中に通知するためのテンプレート
リクエスト・ステータス変更	リクエスト・ステータス変更中に通知するためのテンプレート
パスワードのリセット	パスワードがリセットされた後で通知するためのテンプレート
ユーザーが削除されました	終了日の期限切れにより報告先のユーザー・アカウントが削除されたときにマネージャに通知するためのテンプレート
プロキシ通知の追加	ユーザーのプロキシが追加された後で通知するためのテンプレート

次の各項で、通知テンプレートについて説明します。

イベント・メタデータの定義
通知テンプレートの作成
通知テンプレートの検索
通知テンプレートの修正
通知テンプレートの削除
通知テンプレートに対するロケールの追加と削除

3.1 イベント・メタデータの定義

各イベントに対して、通知エンジンで定義される特定のスキーマを持つXMLファイルを作成する必要があります。そのスキーマ(.xsdファイル)に準拠して、イベントの概要を定義するXMLファイルが作成されます。イベントが定義されると、そのイベントの通知テンプレートを定義できます。

イベント・ファイルは通知エンジンで定義されるスキーマ、NotificationEvent.xsdに準拠している必要があります。イベント・ファイルにはイベントに関する基本情報が含まれます。

注意:

NotificationEvent.xsdファイルは、MDSのiam\iam-product\features\notification\metadataディレクトリにあります。

次にイベントXMLファイルのサンプルを示します。

<?xml version="1.0" encoding="UTF-8"?>
<Events xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../metadata/NotificationEvent.xsd">
  <EventType name="User Created">
    <StaticData>
      <Attribute DataType="X2-Entity" EntityName="User" Name="Granted User"/>
      <Attribute DataType="X2-Entity" EntityName="User" Name="Grantee User"/>
      <Attribute DataType="91-Entity" EntityName="User Group" Name="User Grp"/>
    </StaticData>
      <Resolver class="oracle.iam.notification.DemoResolver">
      <Param DataType="91-Entity" EntityName="Resource" Name="ResourceInfo"/>
    </Resolver>
  </EventType>
</Events>

サンプルXMLファイルでは、次のようになります。

EventType name要素は、イベントの名前です。
StaticData要素は、ユーザーがデータ依存でないパラメータを追加できるパラメータ・セットをリストします。つまり、この要素は通知が構成されるときに表示される統計データを定義します。統計データの例としてユーザー・エンティティがありますが、これは他のデータに依存せず、すべてのイベント・インスタンスと通知テンプレートで同じ属性セットを持ちます。

Param DataType要素は、ユーザーがデータ依存のパラメータを追加できるパラメータ・セットをリストします。データ依存または動的エンティティの例として、ユーザーがランタイム時に選択できるリソース・オブジェクトがあります。通知テンプレートは、リソース・オブジェクト用に構成されます。リソース・オブジェクト・フィールドに対応して、UIに検索が表示されます。ユーザーがイベント、たとえば「終了日通知」を選択すると、リゾルバ・クラスが呼び出されてフィールドが取得され、そのフィールドが「使用可能なデータ」リストに表示されます。このリストからユーザーはテンプレートで使用する属性を選択できます。

注意:

使用可能なデータとは、テンプレートにトークンとして組み込むことのできる属性のリストです。これらのトークンは、ランタイム時にリゾルバ・クラスによって渡される値と置き換えられます。使用可能なデータはリストに表示されます。

選択されたデータは単一の属性で、ユーザーは属性名をコピーして貼り付けることができます。選択されたデータの属性名は、「使用可能なデータ」リストで選択されたものと同じです。

検索でサポートされる動的エンティティは、ユーザー、リソースおよび組織です。これらのエンティティ名をParam DataType要素で指定する必要があります。

リゾルバ・クラスは、通知ごとに定義する必要があります。これは、通知作成画面で使用できるパラメータと、それらのパラメータを通知の送信時に置き換える方法を定義します。つまり、リゾルバ・クラスは、ランタイム時にデータを動的に解決し、UIに属性を表示します。

3.2 通知テンプレートの作成

注意:

発生する各イベントに対してXMLファイルを構成する必要があります。XMLファイルは、各イベントの動作を定義します。イベントに対してXMLを構成した後でのみ、そのイベント用の通知テンプレートを作成できます。

イベントXMLファイルの作成については、「イベント・メタデータの定義」を参照してください。

通知テンプレートを作成するには:

Oracle Identity Administrationにログインします。
「システム管理」タブをクリックし、次に「通知」タブをクリックします。
左ペインの「アクション」リストから、「作成」を選択します。
「作成」ページで、「テンプレート情報」セクションの下の次のフィールドに値を入力します。
- テンプレート名: テンプレート名を入力します。
- 説明テキスト: テンプレートの簡単な説明を入力します。
  
  注意:
  「説明テキスト」フィールドは翻訳できず、表示は英語のみになります。
「イベントの詳細」セクションの下で、次の内容を実行します。
- 「使用可能なイベント」リストから、通知テンプレートを作成するイベントを選択します。選択内容に応じて、他のフィールドが「イベントの詳細」セクションに表示されます。
- 「リソース」フィールドで、検索からリソースを選択します。これは、XML定義のParam DataType要素によって定義された動的データです。この要素の詳細は、「イベント・メタデータの定義」を参照してください。
「ロケール情報」セクションの下で、次のフィールドに値を入力します。

注意:
デフォルトのロケールの情報はPTY表に格納されており、そこから取得されます。
- エンコーディング形式を指定するには、UTF-8かASCIIのいずれかを選択します。
- 「メッセージの件名」フィールドに、通知の件名を入力します。
- 「タイプ」オプションから、メッセージを送信するデータ・タイプを選択します。「HTML」か「Text/Plain」のどちらかを選択できます。
- 「ショート・メッセージ」フィールドに、メッセージの要点を数語の単語で入力します。
- 「ロング・メッセージ」フィールドに、通知として送信されるメッセージを入力します。
すべてのフィールドに必要な値を入力し終わったら、「保存」をクリックします。
通知テンプレートの作成を確認するメッセージが表示されます。「OK」をクリックします。

3.3 通知テンプレートの検索

拡張管理を使用して、通知テンプレートの単純検索または拡張検索を実行できます。

通知テンプレートの単純検索を実行するには:

Oracle Identity Administrationにログインします。
「システム管理」タブをクリックし、次に「通知」タブをクリックします。
「検索」フィールドの横のアイコンをクリックします。図3-1に示すように、左ペインに既存の通知テンプレートがすべて表示されます。

図3-1 通知検索の結果

「図3-1 通知検索の結果」の説明
表示するテンプレートを選択します。選択した通知テンプレートの詳細が、右ペインに表示されます。

通知テンプレートの拡張検索を実行するには:

Oracle Identity Administrationの左ペインで、「拡張検索」をクリックします。図3-2に示すように、「拡張検索」ページが表示されます。

図3-2 「拡張検索」ページ

「図3-2 「拡張検索」ページ」の説明
次の一致オプションのいずれかを選択します。
- すべて: このオプションを選択すると、検索はAND条件で実行されます。つまり、ユーザー入力されたすべての「検索」フィールドに基づいて検索操作が行われます。ユーザー入力がない「検索」フィールドは考慮されません。
- いずれか: このオプションを選択すると、検索はOR条件で実行されます。つまり、指定された選択基準のいずれかに一致する場合に検索操作が成功します。
「テンプレート名」、「イベント名」、「件名の詳細」フィールドで検索基準を指定します。これらのフィールドのうち、検索に含めたくないフィールドは、そのフィールドの横にあるアイコンをクリックして削除できます。検索に含めるフィールドを追加するには、「フィールドの追加」をクリックして、リストからフィールド名を選択します。
「検索」をクリックします。図3-3に示すように、検索結果表にテンプレート名、イベント名、件名の詳細についての詳細が表示されます。

図3-3 拡張検索の結果

「図3-3 拡張検索の結果」の説明

3.4 通知テンプレートの変更

通知テンプレートを変更するには:

Oracle Identity Administrationにログインします。
「システム管理」タブをクリックし、次に「通知」タブをクリックします。
「検索」フィールドの横のアイコンをクリックします。左ペインに既存の通知テンプレートがすべて表示されます。変更するテンプレートを選択します。図3-4に通知テンプレートの詳細を示します。

図3-4 通知テンプレートの変更

「図3-4 通知テンプレートの変更」の説明
目的の値を変更し、「保存」をクリックします。
通知テンプレートの変更を確認するメッセージが表示されます。「OK」をクリックします。

3.5 通知テンプレートの削除

通知テンプレートを削除するには:

Oracle Identity Administrationにログインします。
「システム管理」タブをクリックし、次に「通知」タブをクリックします。
「検索」フィールドの横のアイコンをクリックします。左ペインに既存の通知テンプレートがすべて表示されます。削除するテンプレートを選択します。
「アクション」リストから、「削除」をクリックします。削除操作の確認を求めるメッセージが表示されます。「OK」をクリックします。削除操作を確認するメッセージが表示されます。

3.6 通知テンプレートに対するロケールの追加と削除

通知テンプレートにロケールを追加するには:

Oracle Identity Administrationにログインします。
「システム管理」タブをクリックし、次に「通知」タブをクリックします。
「検索」フィールドの横のアイコンをクリックします。左ペインに既存の通知テンプレートがすべて表示されます。ロケールを追加するテンプレートを選択します。
「アクション」リストから、「ロケールの追加」を選択します。「ロケールの追加」ページが表示されます。「ロケール名」フィールドで、このフィールドの横のアイコンをクリックしてリストからロケールを選択します。ロケールの選択後、「確認」をクリックします。「次へ」をクリックします。「ロケール情報」ページが表示され、追加したロケールがページのタブとして表示されます。

「ロケール情報」セクションで、「通知テンプレートの作成」のステップ6の説明に従って、すべてのフィールドに値を指定し、「保存」をクリックします。ロケールがテンプレートに追加されます。

注意:

通知は、通知テンプレートに追加されたすべてのロケールに送信できます。ユーザーは、ユーザー・プリファレンスで指定されたのと同じロケールで通知を受け取ります。ユーザー・プリファレンスでロケールが指定されていない場合は、通知はデフォルトのロケールで送信されます。デフォルトのロケールは、インストール時にOracle Identity ManagerデータベースのPTY表に指定されたものです。

通知テンプレートからロケールを削除するには:

Oracle Identity Administrationの左ペインで、検索結果表からテンプレートを選択し、「アクション」リストから「ロケールの削除」を選択します。あるいは、テンプレートを右クリックして「ロケールの削除」を選択することもできます。
「ロケールの削除」ページで、「ロケール名」フィールドの横のアイコンをクリックし、リストからロケールを選択します。テンプレートに複数のロケールが含まれている場合のみ、テンプレートからロケールを削除できることに注意してください。テンプレートに関連付けられたロケールが1つのみの場合は、ロケールを削除することはできません。「保存」をクリックします。

ロケールの削除を確認するメッセージが表示されます。「OK」をクリックします。

注意:

デフォルトのロケールは削除しないでください。ユーザー優先ロケールが設定されていない場合や、通知テンプレートにユーザー優先ロケールに一致するロケール・テンプレートが含まれていない場合でも通知が必ず送信されるようにするためには、これが必要です。