カスタム 埋め込みヘルプ コンテンツの追加
たとえば、カスタムアプリケーションがあり、ユーザーにヘルプを提供する場合などに、新しいカスタム埋め込みヘルプトピックを作成できます。
始める前に
このタスクについて
- 埋め込みヘルプコンテンツに画像を含めることはできません。
- ビデオを埋め込むには、ソース コードの <<>> ビューにビデオ情報をコーディングする必要があります。YouTube と Vimeo のビデオコンテンツがサポートされています。
- 関連情報リンクを追加するには、相対 URL ではなく完全な URL を使用する必要があります。
- ベスト プラクティスは、ユーザーが選択したテーマによっては色によってテキストが判読できなくなる可能性があるため、テキストの強調表示ツールを使用しないことです。
- 埋め込みヘルプに加えた変更が、別のインスタンスに自動的に展開されることはありません。
- 埋め込みヘルプテーブルへの変更は更新セットに取り込まれず、意図的に update_sync=false が設定されます。
注:
埋め込みヘルプレコードは、構成可能ワークスペース内のヘルプセンターコンテンツを作成するためにも使用されます。詳細については、「構成可能なワークスペースの ヘルプセンター コンテンツの作成」を参照してください。
手順
-
フォームに入力します。
フィールド 説明 名前 埋め込みヘルプトピック名を入力します。一般的な名前は、適用されるページのタイトルです。 ページ このコンテンツが役立つ UI ページを .do ファイル拡張子なしで入力します。 
注:構成可能なワークスペースの ヘルプセンター コンテンツの作成で説明されているように、埋め込みヘルプレコードを使用してヘルプセンターに表示する場合は、[名前] フィールドと [ページ] フィールドに同じ値を入力し、[ページ] フィールドのスペースをアンダースコアに置き換えます。修飾子 モディファイヤ(通常は [標準](Normal))を選択します。 - 通常の コンテンツは、ページに移動した適切なロールを持つユーザーに表示されます。
- セットアップ コンテンツは、ガイド付きセットアップのリンクからページにアクセスすると表示されます。
ロール トピックが記述されているロールを選択します。 そのロールを含むすべてのロールにも、そのロールをターゲットとする別のトピックが同じページに存在しない限り、コンテンツが表示されます。 詳細については、次を参照してください。 埋め込みヘルプ ロール
アクティブ このコンテンツを表示するには、チェックボックスをオンにします。UI ページでアクセスする前に誰かにレビューしてもらう場合など、コンテンツを使用できないようにするには、このチェックボックスをオフにします。 製品 [エンタープライズ ] がデフォルトであり、変更しないでください。 修飾子 共通 UI ページにカスタム埋め込みヘルプを提供する修飾子。 たとえば、すべてのホームページモジュールと多くのダッシュボードモジュールで home.do ページが開きます。この埋め込みヘルプレコードに入力する前に、修飾子を作成します。
注:動的 ID は、埋め込みヘルプ修飾子のルートパラメーターでサポートされています。たとえば、フラグメントフィールドに$dynamic_value$を追加すると、値が変更された場合でも、同じ URL でコンテンツを利用できるようになります。これは、同じページに異なる言語を選択した場合に発生する可能性があります。バージョン インスタンスの現在のバージョンと異なる場合は、バージョンを選択します。カスタムアプリケーションのコンテンツ、または組織のビジネスプロセスに関連する情報を提供するには、[ すべて] を選択します。 順序 必要に応じて、デフォルトのロールを変更します。順序は、選択したロールに基づいてデフォルト設定されます。既定の順序優先順位の数値の詳細については、「 埋め込みヘルプ ロール」を参照してください。 ドメイン 該当する場合は、このコンテンツが使用されるドメインを指定します。 このフィールドは、アドミニストレーターがフォームを表示するように設定した場合に、フォームに表示されます。