埋め込みヘルプ 計画
カスタムの埋め込みヘルプを作成する前に、内容を計画し、埋め込みヘルプフォームで使用される情報をメモします。慎重に計画することで、適切なページとロールに対してトピックが表示されるようになります。
次の例に示すように、各 UI ページには、[ ページ ] フィールドで指定された埋め込みヘルプを表示できます。
埋め込みヘルプトピックを計画する際には、次のフィールドがどのように使用されるかを検討し、カスタムトピックに必要な値をメモします。
- ページ
- 次のようにページが表示されるときに URL で見つかった UI ページ名を特定してメモします。ページ名が $mid_server_user のようにドル記号で始まる場合は、ページ名にドル記号を含めます。ページの埋め込みヘルプ トピックを書き込む前に、ページ名を検索して、コピーできるファイルを見つけます。
- 修飾子
- 通常の コンテンツは、ページに移動する適切なロールを持つユーザーに表示されます。
- セットアップ コンテンツは、ガイド付きセットアップのリンクからページにアクセスすると表示されます。
ベースシステムに埋め込まれたヘルプトピックの多くは、Guided Setup 用です。セットアップの内容をコピーし、[モディファイヤ]を[標準]に変更すると、すべてのユーザーにヘルプをすばやく提供できます。
- 認定者
- 多くのアプリケーションで使用されているカスタム ヘルプが必要なページを特定します。 たとえば、すべてのホームページモジュールと多くのダッシュボードモジュールに対して home.do ページが開きます。 埋め込みヘルプ管理者は、修飾子を使用して、インスタンス内の共通ページのコンテンツをカスタマイズできます。
- ロール
- この埋め込みヘルプトピックへのアクセスを提供するには、最低レベルのロールを指定します。 そのロールを対象とする別のトピックが同じページに存在しない限り、そのロールを含むすべてのロールにもコンテンツが表示されます。
たとえば、インシデントを入力するビジネスプロセスを説明する itil ロールに埋め込みヘルプコンテンツを追加すると、itil_adminロールにもそのコンテンツが表示されます。itil_admin ロールで別のトピックを作成すると、itil_adminには itil コンテンツの代わりにそのコンテンツが表示されます。
- 製品
- エンタープライズトピックのコンテンツのみを書き込みます。必要に応じて、 Express トピックをコピーし、このフィールドを [エンタープライズ ] に変更できます。
- バージョン
- 通常、ベースシステムのコンテンツは現在のソフトウェアバージョンに指定されます。 カスタムアプリケーションのコンテンツを編集する場合、または組織のビジネスプロセスに関連する情報を提供する場合は、[ すべて] を選択します。
- ドメイン
- 組織でドメイン分離を使用していて、ヘルプコンテンツをカスタマイズする場合は、コンテンツが適用されるドメインを指定します。
- ServiceNow ヘルプ
- チェックボックスがオンになっている場合、このフィールドはベースシステムトピックを示します。ベースシステムトピックを編集することはできませんが、カスタムコンテンツを追加するためのコピーを作成することはできます。
- コンテンツ
- 書式設定ツールを使用して、コンテンツの書式設定を行うことができます。次の一覧では、制限事項について説明します。
- 埋め込みヘルプコンテンツに画像を含めることはできません。
- ビデオを埋め込むには、ソース コード <<>> ビューにビデオ情報をコーディングする必要があります。YouTube と Vimeo のビデオコンテンツがサポートされています。
- 関連情報リンクを追加するには、相対 URL ではなく完全な URL を使用する必要があります。
- ベスト プラクティスは、ユーザーが選択したテーマによっては色によってテキストが判読できなくなる可能性があるため、テキストの強調表示ツールを使用しないことです。
- 埋め込みヘルプに加えた変更が、別のインスタンスに自動的に展開されることはありません。
- 埋め込みヘルプテーブルへの変更は更新セットにキャプチャされず、update_sync=false が意図的に設定されます。