カスタム 埋め込みヘルプ コンテンツを追加

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間:4分
  • たとえば、カスタムアプリケーションがあり、ユーザーにヘルプを提供する場合などに、新しいカスタム埋め込みヘルプトピックを作成できます。

    始める前に

    必要なロール:embedded_help_admin または admin

    このタスクについて

    ユーザー向けのコンテンツを作成するときは、次の制限に注意してください。
    • 埋め込みヘルプコンテンツに画像を含めることはできません。
    • ビデオを埋め込むには、ソース コード <<>> ビューにビデオ情報をコーディングする必要があります。YouTubeとVimeoのビデオコンテンツがサポートされています。
    • 関連情報リンクを追加するには、相対 URL ではなく完全な URL を使用する必要があります。
    • ハイライトテキストツールは使用しないのがベストプラクティスです。ユーザーが選択したテーマによっては、色によってテキストが判読できなくなる場合があります。
    • 埋め込みヘルプに加えた変更は、別のインスタンスに自動的に展開されません。
    • 埋め込みヘルプテーブルへの変更は更新セットにキャプチャされません。update_sync=false が意図的に設定されています。
    注:
    埋め込みヘルプレコードは、構成可能ワークスペース内のヘルプセンターコンテンツを作成するためにも使用されます。詳細については、「構成可能なワークスペースの ヘルプセンター コンテンツの作成」を参照してください。

    手順

    1. 移動先 すべて > 埋め込みヘルプ > ヘルプコンテンツ.
    2. [New] をクリックします。
    3. フォームに入力します。
      フィールド 説明
      名前 埋め込みヘルプトピック名を入力します。一般的な名前は、適用されるページのタイトルです。
      ページ このコンテンツが役立つ UI ページを .do ファイル拡張子なしで入力します。

      URL のページ名

      注:
      構成可能なワークスペースの ヘルプセンター コンテンツの作成で説明されているように埋め込みヘルプレコードを使用してヘルプセンターに表示する場合は、[名前] フィールドと [ページ] フィールドに同じ値を入力し、[ページ] フィールドでスペースをアンダースコアに置き換えます。
      修飾子 修飾子 (通常は [標準]) を選択します。
      • 適切な ロールを持つユーザーがページに移動すると、通常のコンテンツが表示されます。
      • セットアップ コンテンツは、ガイド付きセットアップのリンクからページにアクセスすると表示されます。
      ロール トピックが記述されているロールを選択します。

      同じページにそのロールを対象とする別のトピックが存在しない限り、そのロールを含むすべてのロールにもコンテンツが表示されます。詳細については、「埋め込みヘルプ ロール」を参照してください。

      アクティブ このコンテンツを表示するには、このチェックボックスをオンにします。コンテンツを使用できないようにするには、たとえば、UI ページでアクセスする前に他のユーザーにレビューしてもらう場合など、チェックボックスをオフにします。
      製品 Enterprise がデフォルトであり、変更しないでください。
      修飾子 共通 UI ページのカスタム埋め込みヘルプを提供する修飾子。

      たとえば、すべてのホームページモジュールと多くのダッシュボードモジュールに対して home.do ページが開きます。この埋め込みヘルプレコードに入力する前に修飾子を作成します。

      注:
      動的 ID は、埋め込みヘルプ修飾子ルートパラメーターでサポートされています。たとえば、fragment フィールドに $dynamic_value$ を追加すると、値が変更されても、同じ URL でコンテンツを使用できるようになります。これは、同じページに異なる言語を選択した場合に発生する可能性があります。
      バージョン インスタンスの現在のバージョンと異なる場合は、バージョンを選択します。カスタムアプリケーションのコンテンツまたは組織のビジネスプロセスに関連する情報を提供するには、[ すべて] を選択します。
      順序 必要に応じて、デフォルトのロールを変更します。順序は、選択したロールに基づきます。デフォルトの順序の優先度の数値の詳細については、「 埋め込みヘルプ ロール」を参照してください。
      ドメイン 該当する場合は、このコンテンツが使用されるドメインを指定します。

      このフィールドは、アドミニストレーターがフォームで表示するように設定している場合に、フォームに表示されます。

    4. [ コンテンツ ] フィールドに、必要に応じて HTML 書式設定ツールを使用してテキストを入力します。
      リンクを追加する場合は、Web ページへの完全な URL を入力します。ターゲットとして [新規ウィンドウ] (_blank) を選択することをお勧めします。
      注:
      埋め込みヘルプトピックに画像を追加しないでください。画像は、レコードが保存されるとコンテンツセクションから削除されます。

      埋め込みビデオを追加するには、「 ヘルプトピックにビデオコンテンツを埋め込む」を参照してください。

    5. オプション: テーブル、ビデオ、または関連リンクの下に別の行を追加するには、改行アイコン () をクリックします。
    6. [Submit (送信)] を選択します。