での修飾子の使用 埋め込みヘルプ

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む3読むのに数分
  • 埋め込みヘルプ管理者は、修飾子を使用して、インスタンス内の共通ページのコンテンツをカスタマイズできます。

    始める前に

    必要なロール:embedded_help_admin

    このタスクについて

    すべてのホームページモジュールと多くのダッシュボードモジュールに対して home.do ページが開きます。URL で指定されたクエリ パラメーターによって、開くホームページが定義されます。

    組織が SLA ホームページに具体的な手順を提供するとします。カスタムの埋め込みヘルプコンテンツを作成し、修飾子を使用してその目標を達成することができます。 修飾子を作成し、作成したカスタム埋め込みヘルプコンテンツに関連付けます。

    手順

    1. 修飾子の情報を取得するには、新しいブラウザーウィンドウでモジュールを開き、クエリパラメーターをコピーします。
      クエリーパラメーターでは、単語間にハイフンやダッシュではなくアンダースコアが使用されていることに注意してください。
      URL のクエリパラメーターとモジュールリンクタイプを表示します

      また、モジュール リンクの種類の [引数 ] フィールドからクエリ パラメーターを選択することもできます。モジュールのリンクタイプを表示するには、アプリケーションナビゲーターでモジュールの横にある鉛筆アイコンをクリックし、[ リンクタイプ ] タブをクリックします。

    2. 移動先 埋め込みヘルプ > ヘルプ修飾子をクリックし、[ 新規] をクリックします。
    3. フォームに入力します。
      表 : 1. 埋め込みヘルプ修飾子フォーム
      フィールド 説明
      パス 埋め込みヘルプコンテンツを表示するページを入力します。.do は含めないでください。たとえば、SLA ホームページの場合は「 home」と入力します。
      クエリパラメーター

      クエリパラメーターまたはリンク引数を id=query_parameters の形式で入力します。

      警告:
      クエリ パラメーターに複数の単語が含まれている場合は、単語間にハイフンまたはダッシュではなくアンダースコアを使用します。ハイフンまたはダッシュを使用すると、システムはパラメーターの最初の単語のみを使用し、残りは無視します。
      フラグメント URL の末尾に #<string> を入力します。
      これは、インスタンス内のページの URL にはほとんど見られません。#<string>で終わるページのカスタムヘルプが必要な場合は、このフィールドに入力します。
      注:
      実証済みのプラクティスは、少なくともクエリパラメーターを含めることです。指定しない場合、カスタムヘルプは home.do ページごとに表示されます。クエリ パラメーター、フラグメント、またはその両方を使用できます。
      認定者

      使用する修飾子を入力します ( 例:sla_homepage)。埋め込みヘルプコンテンツレコードで使用する修飾子を記録します。

      警告:
      クエリ パラメーターに複数の単語が含まれている場合は、単語間にハイフンまたはダッシュではなくアンダースコアを使用します。ハイフンまたはダッシュを使用すると、システムはパラメーターの最初の単語のみを使用し、残りは無視します。
    4. [送信] をクリックします。
    5. カスタム 埋め込みヘルプ コンテンツを追加 手順に従ってコンテンツを作成し、次の情報を含めます。
      • 名前ページ: 修飾子を作成したページ ( 例: home)。
      • 修飾子: 入力した修飾子 ( sla_homepage など)。
      注:
      既存の埋め込みヘルプトピックをコピーして、コピーしたレコードに修飾子を入力することもできます。
    6. コンテンツを追加したページを開いてからヘルプパネルを開いて、修飾子をテストします。
      注:
      埋め込みヘルプコンテンツにロールを追加した場合は、そのロールを持つユーザーとしてログインしていることを確認するか、そのロールを持つユーザーの代理操作を行います。