カスタム埋め込みヘルプを作成する前に、コンテンツを計画し、埋め込みヘルプフォームで使用される情報をメモします。慎重に計画することで、トピックが適切なページとロールに表示されるようになります。

次の例に示すように、各 UI ページには [ページ] フィールドで指定された埋め込みヘルプを表示できます。

埋め込みヘルプトピックを計画する際には、次のフィールドの使用方法を検討し、カスタムトピックに必要な値をメモします。

ページ

ご覧のようにページが表示されるときに URL に含まれる UI ページ名を特定してメモします。$mid_server_user のように、ページ名がドル記号で始まる場合は、ページ名にドル記号を含めます。ページの埋め込みヘルプトピックを作成する前に、ページ名を検索してコピー可能なファイルを見つけます。

修飾子

• 適切なロールを持つユーザーがページに移動すると、通常のコンテンツが表示されます。
• セットアップ コンテンツは、ガイド付きセットアップのリンクからページにアクセスすると表示されます。

ベースシステムに埋め込まれたヘルプトピックの多くは、ガイド付きセットアップ用です。セットアップコンテンツをコピーし、修飾子を通常に変更して、すべてのユーザーにヘルプをすばやく提供できます。

修飾子

多くのアプリケーションで使用されているカスタムヘルプが必要なページを特定します。 たとえば、すべてのホームページモジュールと多くのダッシュボードモジュールに対して home.do ページが開きます。 埋め込みヘルプアドミニストレーターは、修飾子を使用して、インスタンス内の共通ページのコンテンツをカスタマイズできます。

ロール

この埋め込みヘルプトピックへのアクセスを提供する最下位レベルのロールを指定します。 同じページに同じロールの対象となる別のトピックが存在する場合を除き、そのロールを含むすべてのロールにもコンテンツが表示されます。

たとえば、インシデントを入力するビジネスプロセスを説明する itil ロールの埋め込みヘルプコンテンツを追加すると、itil_admin ロールにもコンテンツが表示されます。itil_admin ロールで別のトピックを作成すると、itil_adminには itil コンテンツではなくそのコンテンツが表示されます。

製品

Enterprise トピックのコンテンツのみを書き込みます。Express トピックをコピーし、必要に応じてこのフィールドを Enterprise に変更できます。

バージョン

ベースシステムコンテンツは通常、現在のソフトウェアバージョンに指定されます。 カスタムアプリケーションのコンテンツを編集する場合、または組織のビジネスプロセスに関連する情報を提供する場合は、[ すべて] を選択します。

ドメイン

組織でドメインセパレーションを使用し、ヘルプコンテンツをカスタマイズする場合は、コンテンツが適用されるドメインを指定します。

ServiceNow ヘルプ

チェックボックスがオンの場合、このフィールドはベースシステムのトピックを示します。ベースシステムトピックは編集できませんが、コピーを作成してカスタムコンテンツを追加することはできます。

コンテンツ

書式設定ツールを使用して、コンテンツを書式設定できます。次のリストで制限について説明します。

• 埋め込みヘルプコンテンツに画像を含めることはできません。
• ビデオを埋め込むには、ソースコード <<>> ビューでビデオ情報をコーディングする必要があります。YouTube と Vimeo のビデオコンテンツがサポートされています。
• 関連情報リンクを追加するには、相対 URL ではなく、完全な URL を使用する必要があります。
• ベストプラクティスは、テキストのハイライト表示ツールを使用しないことです。ユーザーが選択したテーマによっては、色によってテキストが判読不能になる場合があります。
• 埋め込みヘルプに加えた変更は、別のインスタンスに自動的に展開されません。
• 埋め込みヘルプテーブルへの変更は更新セットではキャプチャされません。update_sync=false は意図的に設定されています。