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