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

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む4読むのに数分
  • たとえば、カスタムアプリケーションがあり、ユーザーにヘルプを提供する場合は、新しいカスタム埋め込みヘルプトピックを作成できます。

    始める前に

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

    このタスクについて

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

    手順

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

      URL のページ名

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

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

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

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

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

      このフィールドは、管理者がフォームを表示するように設定した場合にフォームに表示されます。

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

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

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