通知テンプレートの作成

Documentation Menu
戻る

通知テンプレートの作成

利用可能 Liferay 7.4 U75+/GA75+

通知テンプレートにより、Liferayサービスの自動化された電子メールやユーザー通知を設計できます。 各テンプレートは、送信者、受信者、メッセージの内容を特定します。 テンプレートをデザインする際に、サポートされているエンティティを検索し、そのデータをメールに動的に挿入するフィールド参照を追加できます。

現在、通知テンプレートは、 オブジェクトアクションのみサポートしています。 しかし、コマースチャネルには、チャネルイベントに対する通知テンプレート機能が組み込まれています。 詳しくは、 メールを送信する をご覧ください。

important

メール通知設定を利用するには、インスタンスにメールサーバーが設定されている必要があります。 一度設定すると、インスタンスレベルで追加のメール通知設定にアクセスできます。

メール通知テンプレートの追加

  1. グローバルメニュー（Global Menu）を開き、 ［コントロールパネル］ タブに移動し、 ［通知テンプレート］ をクリックします。

  2. 追加(Add Button) をクリックし、 ［Email］ を選択します。

    追加ボタンをクリックし、［メール］を選択します。

    フィールド参照を使用することで、エントリーデータやユーザーデータを動的にメッセージに入力することができます。 用語の定義」セクションでは、オブジェクトの定義を選択して、そのサポートされているフィールドを参照することができます。 一般的な用語」セクションでは、通知アクションをトリガーしたユーザーのフィールドを参照するための用語を見つけることができます。 これらの参考用語は、必要に応じてテンプレートのフィールドで使用してください。 用語の定義 参考 をご参照ください。

    エンティティを検索して、サポートされているフィールドへの参照を追加します。

  3. ［Basic Info］で、テンプレートの名前と説明を入力します。

    ［Basic Info］で、名前と説明を入力します。

  4. ［Settings］で、メール送信者と受信者の連絡先を入力します。

    複数の受信者を追加する場合は、メールアドレスをカンマまたはスペースで区切ってください（例： test@liferay.com,learn@liferay.com, [%TICKET_AUTHOR_EMAIL_ADDRESS%] [%CURRENT_USER_EMAIL_ADDRESS%]）。

    ［Settings］で、送信者と希望する受信者の詳細を入力します。

  5. ［Content］で、件名を入力し、エディタータイプを選択し、メールの本文を作成します。

    タイプは、［Rich Text」または［FreeMarker Template］を選択します。

    ［Content］で、件名を入力し、メールの本文を作成します。

  6. (オプション）オブジェクトの添付フィールドを選択して、そのアセットをメール通知に含めます。

    important

    通知アクションに関連するオブジェクトエントリーからのアセットのみを添付できます。

    添付フィールドを選択して、そのアセットをメール通知に含めます。

  7. ［保存］ をクリックします。

作成後、オブジェクトアクションで通知テンプレートを使用できます。 詳しくは、オブジェクトアクションの定義をご覧ください。

ユーザー通知テンプレートの追加

  1. グローバルメニュー（Global Menu）を開き、 ［コントロールパネル］ タブに移動し、 ［通知テンプレート］ をクリックします。

  2. 追加(Add Button) をクリックし、 ［User Notification］ を選択します。

    追加ボタンをクリックし、［ユーザー通知］を選択します。

    フィールド参照を使用することで、エントリーデータやユーザーデータを動的にメッセージに入力することができます。 用語の定義」セクションでは、オブジェクトの定義を選択して、そのサポートされているフィールドを参照することができます。 一般的な用語」セクションでは、通知アクションをトリガーしたユーザーのフィールドを参照するための用語を見つけることができます。 これらの参考用語は、必要に応じてテンプレートのフィールドで使用してください。 用語の定義 参考 をご参照ください。

    エンティティを検索して、サポートされているフィールドへの参照を追加します。

  3. ［Basic Info］で、テンプレートの名前と説明を入力します。

    ［Basic Info］で、名前と説明を入力します。

  4. ［Settings］で、通知の受信者を決定します。

    定義済みの用語、ユーザー名、またはユーザーロールを使用できます。 複数の受信者を追加する場合は、値をカンマまたはスペースで区切ってください（例： [%TICKET_AUTHOR_ID%], [%TICKET_R_ASSIGNEE_USERID%]）。

    用語、個々のユーザー名、またはユーザーロールを入力して、受信者を決定します。

  5. ［Content］セクションで、通知のメッセージを入力します。

    定義された用語を使用して、動的に値を入力することができます。

    ［Content］セクションに、通知のメッセージを入力します。

  6. ［保存］ をクリックします。

作成後、オブジェクトアクションで通知テンプレートを使用できます。 詳しくは、 オブジェクトアクションの定義 をご覧ください。

用語の定義 参照

参照語を使用してユーザーやエントリーのデータにアクセスし、テンプレートのフィールドに動的に入力することができます。 通知アクション のトリガーとなるイベントに関与する任意のエントリーとユーザーを参照できます。

カスタムTicketオブジェクトが、Userシステムオブジェクトとの一対多の関係の子側にあるシナリオを考えてみましょう。 この関係によって、チケットの譲渡先が決定されます。 チケットオブジェクトに、エントリーの更新時にアサイニーに通知するための通知アクションを追加した場合、このアクションに使用するテンプレートは、更新されたチケットとアサイニーの両方のデータにアクセスできます。

用語は、カスタムおよびデフォルトのオブジェクトフィールドの両方で使用できます。

important

通知アクションのトリガーとなるイベントに直接関与したエントリーとユーザーのフィールドのみを参照することができます。

現在のエントリーのデフォルトの条件

これらの用語を使用して、現在のオブジェクトエントリに関する情報にアクセスします。

ラベル 条件
作成者のメールアドレス [%OBJECTNAME_AUTHOR_EMAIL_ADDRESS%]
作成者の名 [%OBJECTNAME_AUTHOR_FIRST_NAME%]
作成者 ID [%OBJECTNAME_AUTHOR_ID%]
作成者の姓 [%OBJECTNAME_AUTHOR_LAST_NAME%]
作成者のミドルネーム [%OBJECTNAME_AUTHOR_MIDDLE_NAME%]
作成者の接頭辞 [%OBJECTNAME_AUTHOR_PREFIX%]
作成者の接尾辞 [%OBJECTNAME_AUTHOR_SUFFIX%]
作成日時 [%OBJECTNAME_CREATEDATE%]
外部参照コード [%OBJECTNAME_EXTERNALREFERENCECODE%]
ID [%OBJECTNAME_ID%]
編集日時 [%OBJECTNAME_MODIFIEDDATE%]
ステータス [%OBJECTNAME_STATUS%]

現在のユーザーに対するデフォルトの条件

通知アクションのトリガーとなる現在のユーザーに関する情報にアクセスするには、これらの用語を使用します。

ラベル 条件
現在ユーザーのメールアドレス [%CURRENT_USER_EMAIL_ADDRESS%]
現在ユーザーの名 [%CURRENT_USER_FIRST_NAME%]
現在ユーザーの接頭辞 [%CURRENT_USER_PREFIX%]
現在ユーザーの姓 [%CURRENT_USER_LAST_NAME%]
現在ユーザーのミドルネーム [%CURRENT_USER_MIDDLE_NAME%]
現在ユーザーの ID [%CURRENT_USER_ID%]
現在ユーザーの接尾辞 [%CURRENT_USER_SUFFIX%]

関連トピック

Not finding what you're looking for?

Pardon our dust as we revamp and transition our product documentation to this site. If something seems missing, please check Liferay Help Center documentation for Liferay DXP 7.2 and previous versions.

Try Liferay's Help Center