カスタム ヘルプの概要

組織は、多くの場合、ニーズに合わせて財務アプリと運用アプリをカスタマイズおよび拡張します。 ソリューションが Microsoft Dynamics 365 Finance、Dynamics 365 Supply Chain Management、または Dynamics 365 Commerce に基づいている場合、ソリューション固有および顧客固有のヘルプ コンテンツを財務と運用クライアントのヘルプ ウィンドウに接続できます。 この記事では、主要な手順と決定ポイントについて説明します。

次の図およびこの記事一般では、ヘルプという用語を使用して、ハウツー ガイドを含めるか除外するかを概念的に説明します。 タスク ガイド という用語は、製品内のタスク ガイドを指します。

カスタム ヘルプ コンテンツ

カスタム ヘルプ コンテンツは、通常、次の 3 つのソースのいずれかから取得されます。

• Microsoft ドキュメント リポジトリ

  さまざまな GitHub リポジトリ内の Microsoft のコンテンツは、 learn.microsoft.com サイトと、このサイトで使用されるツール用に最適化されています。 これは、直接カスタマイズされるのではなく、ローカル Web サイトの記事で補足されることを意図しています。 ただし、ソリューションによっては、Microsoft のコンテンツのコピーが必要な場合があります。

• 既存のカスタマイズされた Dynamics AX コンテンツ

  Dynamics AX カスタム ヘルプ コンテンツを Dynamics 365 で使用できるように変換できます。

• ソリューション専用に作成する HTML ファイル

  コンテキスト依存ヘルプと検索を正しく動作させるためにHTMLファイルに追加する必要があるメタデータについては、カスタム ヘルプ ファイルのメタデータ要件セクションを参照してください。

プロセス

エンドツーエンド プロセスは、顧客ソリューションとユーザーの期待によって異なります。 標準的なプロセスには、次の手順が含まれます:

1. カスタム ヘルプ コンテンツを作成します。
2. コンテンツを Web サイト に公開します。
3. 検索サービスを使用してコンテンツにインデックスを付けます。
4. カスタム ヘルプ ウィンドウを Web サイト と検索サービスに接続します。

Microsoft には、コンテンツを変換し、カスタム ヘルプを含むようにヘルプ ウィンドウを構成するのに役立つサンプル ツールとスクリプトが用意されています。 サンプルは、 https://github.com/microsoft/dynamics365f-o-custom-help/ でご確認いただけます。

次の表は、ヘルプ エクスペリエンスを構成するために管理者が通常持つ主な目的の概要を示します。

カスタム ヘルプ Web サイト

製品がヘルプ コンテンツに接続する前に、製品内の ヘルプ ウィンドウをカスタマイズして、コンテンツが表示されるようにする必要があります。 詳細については、「 カスタム ヘルプ Web サイトをヘルプ ウィンドウに接続する」を参照してください。

次の条件を満たす必要があります:

• コンテンツは Web サイト で入手可能である必要があります。

  コンテンツを既存の Web サイト に展開するか、コンテンツをホストする専用の Web サイト を設定できます。 Web サイトはプライベートでもパブリックでもかまいませんが、ユーザーがコンテンツにアクセスするためにサインインする必要はありません。

• 検索サービスでは、コンテンツのインデックスを作成する必要があります。

  Generate JSON ファイルを生成して検索サービスで使用する セクションを参照してください。

• コンテンツには、適切なメタデータ プロパティが含まれる必要があります。

  詳細については、セクションを参照してください。

カスタム ヘルプ ファイルのメタデータ要件

状況依存のヘルプとフルテキスト検索の結果を確実に返すには、トピックに次のメタデータを含めます。

次の表では、 ms.search.scope プロパティに指定できる値について説明します。 1 つ以上の値を指定できます。 値によって、ヘルプ記事に表示されるクライアントが決まります。

不要なメタデータ

次のプロパティは、将来の使用のために予約されています。

• ms.search.region – 最終的には、このプロパティを使用して、グローバルまたは実装の地域のいずれかのタグが付けられたコンテンツに表示されるコンテンツを制限できます。
• ms.search.validFrom – 最終的には、このプロパティを使用して、特定の日付以前にリリースされた製品のコンテンツに対して表示されるコンテンツを制限できます。
• ms.dyn365.ops.version – 最終的には、このプロパティを使用して、特定のバージョン以前の製品のコンテンツに対して表示されるコンテンツを制限できます。
• ms.search.industry – 最終的には、このプロパティを使用して、特定の業種のコンテンツに表示されるコンテンツを制限できます。

JSON ファイルを生成して検索サービスで使用する

ConvertHtmlToJson ツールは、HTML ファイルを JSON ファイルに変換します。 その後、JSON ファイルを Microsoft Azure Search サービスに追加すると、ヘルプ コンテンツへの状況依存のリンクが生成されます。 ツールは、 https://github.com/microsoft/dynamics365f-o-custom-help/ にあります。

JSON ファイルには、ターゲットのヘルプ ページが対象とするフォームと言語を識別するためにインデクサーが使用するメタデータが含まれています。

ConvertHtmlToJson.exeを実行するための構文を次に示します。

ConvertHtmlToJson.exe --h <path> -j <path> --v <true|false>

次のテーブルでは、パラメーターについて説明します。

次の例では、詳細ログなしで JSON ファイルを生成します。

ConvertHtmlToJson.exe --h D:\D365-Operations\d365F-O\supply-chain\de -j D:\D365-Operations\json\supply-chain\de

Dynamics AX 2012 コンテンツの再利用

Dynamics AX 2012 のコンテンツがあれば、Dynamics 365 Finance、Dynamics 365 Supply Chain Management、Dynamics 365 Commerce で再利用できます。 ただし、カスタム ヘルプ環境で使用できるように、まず HTML ファイルを変換する必要があります。

run_ax2012.ps1 Windows PowerShell スクリプトは、カスタム ヘルプ環境で使用できるように AX 2012 HTML ファイルを変換します。 スクリプトにより、AX 2012 HTML ファイルに次の変更が加えられます:

• Microsoft.Help.F1 メタデータ名を ms.search.form に置き換えます。

• Title メタデータ名をタイトルに置き換えます。

• ファイル名拡張子を .htm から .htmlに変更します。

• 次のメタデータを追加します。

  <meta name="ms.search.region" content="Global" />
  <meta name="ms.search.scope" content="Operations, Core" />
  <meta name="ms.dyn365.ops.version" content="AX 7.0.0" />
  <meta name="ms.search.validFrom" content="2016-05-31" />
  <meta name="ms.search.industry" content="cross" />
  

スクリプトの実行

コマンド プロンプト ウィンドウからか、Windows PowerShell で直接次のコマンドを実行します。

PowerShell.exe -File run_ax2012.ps1 "Original file location" "New file location"

次のメタデータが使用されているか、インデックス作成中に使用できるように予約されています。

<meta name="title" content="Title of file" />
<meta name="ms.locale" content="locale" />
<meta name="ms.search.form" content="FormAOTName" />
<meta name="description" content="Description of file" />
<meta name="ms.search.region" content="Global" />
<meta name="ms.search.scope" content="Operations, Core" />
<meta name="ms.dyn365.ops.version" content="AX 7.0.0" />
<meta name="ms.search.validFrom" content="2016-05-31" />
<meta name="ms.search.industry" content="cross" />

必要なメタデータの説明については、カスタム ヘルプ ファイルのメタデータ要件セクションにアクセスしてください。

HTML コンテンツ をMarkdown に変換

コンテンツを Markdown に変換するには、サード パーティのツールを使用します。 Microsoft では、HTML を Markdown に変換できるツールを提供していません。

コンテンツを Markdown に変換した後で、オープンソース ツールを使用して、Web サイトのコンテンツを生成できます。 Markdown を使用することで、さまざまな オープン ソース ツールにアクセスできます。 詳細については、ヘルプへの貢献 にアクセスしてください。

参照

カスタム ヘルプ Web サイトを [ヘルプ] ウィンドウに接続する
製品およびヘルプの言語およびロケール記述子
財務と運用アプリのヘルプ エクスペリエンスの構成
ヘルプ システム