構成可能なワークスペースの ヘルプセンター コンテンツの作成

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:5分
  • ヘルプセンターコンテンツを作成して、ユーザーが構成可能ワークスペース内で作業しているページに関する有用な情報を提供します。

    始める前に

    ガイダンスレコードを作成する前に埋め込みヘルプレコードを作成または編集するには、「 カスタム 埋め込みヘルプ コンテンツの追加 」の手順に従って新しいコンテンツを作成するか、既存のコンテンツを変更する コピーからカスタム 埋め込みヘルプ を追加 に従います。

    必要なロール:admin

    このタスクについて

    ヘルプセンターコンテンツを作成するには、ガイダンスレコードと埋め込みヘルプレコードの 2 つのレコードタイプを作成または変更します。ガイダンスレコードにより、埋め込みヘルプレコード内のコンテンツを ヘルプセンターに表示できます。この手順では、 ヘルプセンターに既存の埋め込みヘルプコンテンツを表示できるようにする方法について説明します。

    手順

    1. ヘルプセンターガイダンスを作成している構成可能ワークスペースページに移動します。
    2. ページの URL ( <instance name>.service-now.com/now/sow/home など) をコピーするか、メモしておきます。
    3. 統一ナビゲーションメニューの [ヘルプを表示] アイコン () を選択して、ヘルプセンターを展開します。
    4. ヘルプセンターの一番下までスクロールし、[Add New Content (新しいコンテンツを追加)] を選択します。
      ガイダンスフォームを含む新しいタブが表示されます。
    5. ガイダンスフォームのフィールドに入力します。
      表 : 1. ガイダンスフォーム
      フィールド 説明
      名前 ヘルプセンターに表示されるガイダンスのタイトル。
      タイプ [埋め込みヘルプ] を選択します。
      ロール ガイダンスを表示するために必要なユーザーロール。
      注:
      選択したロールにのみ関連するヘルプコンテンツがサポートされています。たとえば、ITIL ロールを持つユーザーには、ITIL ロールに対して作成されたヘルプのみが表示されます。以前は、すべてのロールについてすべてのヘルプが表示されていました。
      アプリケーションルート

      ターゲットとするワークスペース ページの URL の一部。 now/<yourpagename> 形式。

      前にメモした URL を参照し、URL のこの部分を入力します (例: now/sow)。

      URL からアプリケーションルートを識別する方法の詳細については、以降 の例 を参照してください。

      すべてのワークスペースページをターゲットにするには、アプリケーションルートとコンテキストフィールドに sn_allを使用します。

      埋め込みヘルプコンテンツ ヘルプセンターでユーザーに表示されるガイダンスのコンテンツ。既存の埋め込みヘルプレコードを選択するか、「 カスタム 埋め込みヘルプ コンテンツの追加」の説明に従って新しい埋め込みヘルプレコードを作成します。
      コンテキスト

      ターゲットとするワークスペースページの URL で、アプリケーションルートの直後にある値。たとえば、 now/sow/home では、コンテキストは home です。

      先ほどメモした URL を参照し、[Application Route] フィールドに入力した値の直後の単語のみを指定します。値はワークスペースによって異なり、 リストレコードが含まれる場合もあります。

      URL からコンテキストを識別する方法の詳細については、次の手順 の例 を参照してください。

      特定のワークスペース内のすべてのページのヘルプコンテンツをターゲットにするには、適切なワークスペースアプリケーションルートを使用し、コンテキストフィールドに sn_all を入力します。

      説明 ガイダンスの説明。[名前] フィールドに指定されたタイトルの下に簡単な説明として ヘルプセンター に表示されます。
      ルートパラメーター

      ユーザーがワークスペース内で特定のリストまたはレコードタイプを表示しているときにのみガイダンスを表示する詳細構成。

      ユーザーが特定のリストを表示しているときにガイダンスを提供するには、前にメモした URL を確認し、 list-id/d03d64feebd1301080de83402a5228f1 などのリスト ID 番号を探します。次に、ルート パラメーターを {"params":{"listId":"d03d64feebd1301080de83402a5228f1"}} の形式で入力します。

      ユーザーが特定のレコードタイプを表示しているときにガイダンスを提供するには、前にメモした URL を確認し、レコード名 ( record/problem など) を探します。次に、ルート パラメーターを {"params":{"table":"problem"}} の形式で入力します。

      ユーザーが関連レコード (別のレコード内からアクセスするレコード) を表示しているときにガイダンスを表示するには、URL で 2 番目のレコード名 ( sub/record/incident など) を探します。次に、ルート パラメーターを {"params":{"table":"incident"}} の形式で入力します。

      URL からルート パラメーターを識別する方法の詳細については、次の手順 の例 を参照してください。

      アプリケーション アプリケーションのスコープ。
      ステータス ガイダンスのステータス。ガイダンスをヘルプセンターに表示する準備ができたら、[公開済み] を選択します。
      アクティブ ガイダンスがアクティブであることを示します。ガイダンスが公開されたら、これがオンになっていることを確認します。
      ServiceNow が作成されました ガイダンスが ServiceNow によって作成されたことを示します。ServiceNow 専用に予約されています。
      バージョン ガイダンス用の現在のファミリーリリースバージョン。
    6. [送信] を選択します。

    でのリストのガイダンスの作成 構成可能ワークスペース

    ユーザーが特定のリストを表示しているときにガイダンスを表示するには、URL を確認し、 list-id/7ae4da1ec3013010965e070e9140dd66 などのリスト ID 番号を探します。次に、 {"params":{"listId":"7ae4da1ec3013010965e070e9140dd66"}} の形式でルート パラメーターを入力します。

    図 : 1. リストのルートパラメーター
    ガイダンスレコードフィールドで使用される URL の一部を強調表示したラベル付き画像。

    のレコードのガイダンスの作成 構成可能ワークスペース

    ユーザーが特定のレコードタイプを表示しているときにガイダンスを提供するには、URL を確認してレコード名 ( record/problem など) を探します。次に、ルート パラメーターを {"params":{"table":"problem"}} の形式で入力します。

    図 : 2. ルート パラメーターのレコード タイプ
    ガイダンスレコードフィールドで使用される URL の一部を強調表示したラベル付き画像。

    での関連レコードのガイダンスの作成 構成可能ワークスペース

    ユーザーが関連レコード (別のレコード内からアクセスするレコード) を表示しているときにガイダンスを表示するには、URL で 2 番目のレコード名 ( sub/record/incident など) を探します。次に、ルート パラメーターを {"params":{"table":"incident"}} の形式で入力します。

    図 : 3. ルートパラメーター関連レコード
    ガイダンスレコードフィールドで使用される URL の一部を強調表示したラベル付き画像。