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

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：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. カスタム 埋め込みヘルプ コンテンツを追加の手順に従ってコンテンツを作成し、次の情報を含めます。
      • 名前 と ページ:修飾子を作成したページ ( ホームなど)。
      • 修飾子:入力した修飾子 ( sla_homepage など)。
      注:
      既存の埋め込みヘルプトピックをコピーし、コピーしたレコードに修飾子を入力することもできます。
    6. コンテンツを追加したページを開き、ヘルプパネルを開いて修飾子をテストします。
      注:
      埋め込みヘルプコンテンツにロールを追加した場合は、そのロールを持つユーザーとしてログインしていることを確認するか、そのロールを持つユーザーの代理操作をします。