埋め込みヘルプの詳細

  • リリースバージョン: Xanadu
  • 更新日 2024年08月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 日間の同期期間を変更できます