埋め込みヘルプ 企画
カスタム埋め込みヘルプを作成する前に、コンテンツを計画して、埋め込みヘルプフォームで使用される情報をメモします。慎重に計画することで、適切なページとロールにトピックが表示されるようになります。
各 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 が意図的に設定されています。