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