埋め込みヘルプ の詳細

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む4読むのに数分
  • 埋め込みヘルプは、ユーザーのロールに基づいて、ターゲットを絞ったヘルプコンテンツを UI ページでユーザーに提供します。一部の埋め込みヘルプコンテンツはベースインスタンスに付属しています。組織では、埋め込みヘルプコンテンツを追加または置換できます。

    埋め込みヘルプ の概要

    埋め込みヘルプを使用すると、ユーザーが必要とするヘルプを提供するだけでなく、ベースシステムにあるヘルプトピックのメリットを活用できます。新しい埋め込みヘルプコンテンツを追加したり、コンテンツを置き換えたりすることができます。コンテンツを置き換えるには、既存のトピックを非アクティブ化し、トピックを追加する必要があります。

    組織では、次のような理由で埋め込みヘルプコンテンツを追加または置換する必要があります。
    • カスタムアプリケーションのヘルプを提供するため。
    • ビジネスプロセスを説明するためのより具体的な手順または埋め込みビデオを提供します。
    • ページに埋め込みヘルプコンテンツが存在しない場合に、埋め込みヘルプコンテンツを提供する。
    • 英語以外の言語で埋め込みヘルプコンテンツを提供する場合 (デフォルト)。
    • ロールごとに異なるコンテンツを提供する。

    UI ページ名は、埋め込みヘルプコンテンツを識別します。ページ名を見つけるには、そのビューの URL でテーブル名を探します。たとえば、アセスメント測定基準タイプのリストビューのページ名は asmt_metric_type_list で、アドレス instancename.service-now.com/nav_to.do?uri=%2Fasmt_metric_type_list.do%3Fsysparm_userpref_module% にあります。フォームビューのページ名はasmt_metric_typeです。

    ベースシステムトピックのコンテンツは編集できません。ベースシステムのトピックでは、読み取り専用の [ServiceNow ヘルプ ] チェックボックスがオンになっています。 コンテンツを編集して変更を保存しようとすると、エラーメッセージが表示されます。ベースシステムトピックに表示される情報を変更するには、トピックのコピーを作成します。これにより、[ ServiceNow ヘルプ ] チェックボックスがオフになります。トピックをコンテンツで変更し、保存します。 カスタマイズされたコンテンツは ServiceNow ヘルプコンテンツよりも優先され、ユーザーがその UI ページのヘルプを開いたときに表示されます。

    埋め込みヘルプ のワークフロー

    データセンターには ServiceNow 、埋め込みヘルプ コンテンツが格納されるコンテンツ配信ネットワーク (CDN) が含まれています。ローカル (インスタンス) 埋め込みヘルプコンテンツ [sys_embedded_help_content] テーブルのトピックは、CDN から入力されます。CDN のヘルプ コンテンツは 30 日ごとに更新されます。

    ユーザーが UI ページにアクセスすると、ユーザーのロールにカスタムトピックが存在する場合は、埋め込みヘルププロセスにカスタムトピックが表示されます。カスタムトピックがない場合は、次の手順が実行されます。
    1. ブラウザーのキャッシュを最初にチェックし、キャッシュにコンテンツが存在する場合は表示します。次に、埋め込みヘルプコンテンツ [sys_embedded_help_content] テーブルで、ロールと修飾子 (該当する場合) を使用して、対応する埋め込みヘルプトピックがチェックされます。
      • トピックが見つかると、[ 最終同期 ] フィールドの日付を確認します。日付が 15 日以上経過している場合は、最終同期日とリソース ID とともに埋め込みヘルプキュー [sys_embedded_help_queue] テーブルに要求が置かれます。
      • トピックが見つからない場合は、現在の日付とリソース ID とともに埋め込みヘルプキュー [sys_embedded_help_queue] テーブルに要求が配置されます。
    2. ページが表示されてから 1 分以内に、システムは要求を処理し、CDN をチェックします。最初のケースでは、 最終同期 日以降にトピックが更新されたかどうかがチェックされます。いずれの場合も、1 分後にページを更新してコンテンツを表示します。
      • トピックが更新された場合は、更新されたトピックがテーブルにプルされ、 最終同期 日が更新されます。
      • トピックが更新されていない場合は、ローカルキャッシュされたトピックまたはデータベーストピックが表示され、 最終同期 日が更新されます。
    3. トピックがローカルデータベースになかった場合、CDN に存在する場合、トピックはテーブルにプルされます。存在しない場合、アクションはありません。

    管理者は、システムプロパティでデフォルトの 15 日間の同期期間を変更できます