通知変数

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：4分

    • 通知変数を使用して、フィールド値、レコードへのリンク、システム環境設定へのリンクなど、通知の本文に動的な情報を表示します。

    構文

    次の構文を使用して通知変数を指定します。

    ${variable-name+variable-parameters}

    variable-name は、常に必要な部分です。variable-parameters 部分は、すべての通知変数ではサポートされていません。利用可能な場合、ほとんどの可変パラメーターはオプションです。変数名と使用可能なパラメーターについては、使用可能な通知変数のリストを参照してください。

    使用可能な変数

    システムでは、以下の通知変数を利用できます。

    表 : 1. 利用可能な通知変数
    変数 説明 利用可能なパラメーター
    ${field-name} 指定したフィールドの値を表示します。 なし
    ${image-field-name} レコードに関連付けられた画像を表示します。この変数は通常、画像要素のソースを指定するために HTML と共に使用されます。 なし
    • URI
    • ${URI_REF}
    		 現在のレコードへのリンクを表示します。
    • URI：このリンクのテキストは単語「リンク」です。
    • URI_REF：リンクのテキストはレコードの表示値です。
    注:
    これらの変数は、ワークスペース のレコードには適用されません。ワークスペース のレコードにリンクするには、通知の URL を出力するメールスクリプトを作成します。詳細については、「ワークスペース のレコードへのリンク」を参照してください。
    		 任意の有効な sysparm URL パラメーター。たとえば、
    • sysparm_scriptlet
    • sysparm_view
    • ${reference-field.URI}
    • ${reference-field.URI_REF}
    		 参照フィールドにリストされているレコードへのリンクを表示します。
    • URI：このリンクのテキストは単語「リンク」です。
    • URI_REF：リンクのテキストはレコードの表示値です。
    		 任意の有効な sysparm URL パラメーター。たとえば、
    • sysparm_scriptlet
    • sysparm_view
    ${CMS_URI} CMS ページ内の指定されたレコードへのリンクを表示します。 <CMS-site>/<CMS-page>：CMS ページへの必要な相対パス。
    ${notification:body} メール テンプレートまたはメール通知の本文内容を表示します。この通知変数を使用して、メール レイアウトで本文コンテンツを表示する場所を指定します。 なし
    $ {mail_script： スクリプト名 } 指定されたメール スクリプトを実行します。 なし
    ${NOTIF_UNSUB} この通知の登録解除のリンクを表示します。 link_text：引用符で囲まれたリンクとして表示するテキストを指定します。
    ${NOTIF_PREFS} 通知設定を行うためのリンクを表示します。 link_text：引用符で囲まれたリンクとして表示するテキストを指定します。
    ${comments:n}

    ターゲットレコードに対して行われた最新のコメントを表示します。表示するコメントの数は n です。たとえば、${comments:3} の場合、レコードに対して行われた最新の 3 つのコメントが表示されます。

    すべてのコメントを表示するには、変数 ${comments} を使用します。

    		 0 より大きい任意の数。
    ${comments_and_work_notes:n}

    ターゲットレコードに対して行われた最新のコメントと作業メモを表示します。表示するコメントと作業メモの数は n です。たとえば、${comments_and_work_notes:3} の場合、レコードと作業メモに対して行われた最新の 3 つのコメントと作業メモが表示されます。

    すべてのコメントと作業メモを表示するには、変数 ${comments_and_work_notes} を使用します。

    		 0 より大きい任意の数。

    例

    各通知変数が出力でどのようにレンダリングされるかを確認するには、次の例を参照してください。
    変数 例
    ${field-name}

    ソース： Incident ${number} - コメントが追加されました

    出力： Incident INC1000001 - コメントが追加されました
    ${image-field-name}

    ソース： <img src='${picture}?t=medium'/>

    出力：通知画像変数
    • ${URI}
    • ${URI_REF}

    ${URI} ソース：インシデントを表示するにはこちらをクリックしてください：${URI}

    ${URI} 出力：リンクテキストワード「リンク」が現在のレコードへのリンクとしてどのように機能するかを示す例

    ${URI_REF} ソース：インシデントを表示するにはこちらをクリックしてください：${URI_REF}

    ${URI_REF} 出力：表示されるリンクテキストがレコードの値である場合の表示例
    • ${reference-field.URI}
    • ${reference-field.URI_REF}
    ソース： 
    Click here to view Incident: ${URI_REF}
Click here to view Related Problem: ${problem_id.URI_REF}

    出力：参照フィールドにリストされているレコードへのリンクを示す例
    ${CMS_URI}

    ソース：${CMS_URI+ess/incident_detail}

    出力：ターゲット CMS ページへのリンク。例：https://<インスタンス名>.service-now.com/ess/incident_detail.do?sysparm_document_key=incident,46e18c0fa9fe19810066a0083f76bd56
    ${notification:body}

    ソース：メール本文の変数がメールレイアウトでどのように機能するか。

    出力：通知設定へのリンクの変数がどのように機能するか。
    $ {mail_script： スクリプト名 }
    ${NOTIF_UNSUB}
    ${NOTIF_PREFS}