カスタム ヘルプの概要
重要
Human Resources を使用している顧客の場合、この記事で説明した機能は、現在、スタンドアロン Dynamics 365 Human Resources とマージした Finance インフラストラクチャの両方で利用できます。 更新中は、記載されたナビゲーションと異なる場合があります。 特定のページを検索する場合は、検索を使用できます。
財務と運用アプリは、多くの場合、組織のニーズに合わせてカスタマイズおよび拡張されます。 ソリューションが Microsoft Dynamics 365 Finance、Dynamics 365 Supply Chain Management、または Dynamics 365 Commerce に基づいている場合、ソリューション固有および顧客固有のヘルプ コンテンツを財務と運用クライアントのヘルプ ウィンドウに接続できます。 この記事では、主要な手順と決定ポイントについて説明します。
メモ
財務と運用アプリのユーザーは、カスタム タスク ガイドを作成して、ソリューションの機能を説明する概念コンテンツを補うことができます。 これらの概念的な説明は、ヘルプとも呼ばれ、Microsoft、パートナー、および組織自体が提供できます。 詳細については、ヘルプ システム にアクセスしてください。
次の図およびこの記事一般では、ヘルプという用語を使用して、ハウツー ガイドを含めるか除外するかを概念的に説明します。 タスク ガイド という用語は、製品内のタスク ガイドを指します。
![カスタマイズされたヘルプ ソリューションと [ヘルプ] ウィンドウです。](../../fin-ops/get-started/media/help-architecture.png)
カスタム ヘルプ コンテンツ
通常、カスタム ヘルプ コンテンツは、次の 3 つのソースのいずれかから生成されます。
Microsoft ドキュメント リポジトリ
さまざまな GitHub リポジトリの Microsoft のコンテンツは、learn.microsoft.com サイトおよびこのサイトに使用されるツールに対して最適化されています。 これは、直接カスタマイズするのではなく、ローカル Web サイトの記事で補完することを目的としています。 ただし、ソリューションによっては、Microsoft のコンテンツのコピーが必要な場合があります。
既存のカスタマイズされた Dynamics AX コンテンツ
Dynamics AX カスタム ヘルプ コンテンツを変換して、Dynamics 365 で使用できるようにすることができます。
ソリューションに対して特別に作成された HTML ファイル
コンテキストに影響するヘルプや検索がカスタム ヘルプ ファイルの Metadata要件で正しく機能するためにHTMLファイルに追加する必要があるメタデータに関する詳細を します。
プロセス
エンドツーエンド プロセスは、顧客ソリューションとユーザーの期待によって異なります。 標準的なプロセスには、次の手順が含まれます:
- カスタム ヘルプ コンテンツを作成します。
- コンテンツを Web サイト に公開します。
- 検索サービスを使用してコンテンツにインデックスを付けます。
- カスタム ヘルプ ウィンドウを Web サイト と検索サービスに接続します。
Microsoftでは、コンテンツの表紙や、カスタム ヘルプを含むヘルプ ウィンドウの構成に役立つサンプル ツールおよびスクリプトが提供されています。 サンプルの場所を検索します https://github.com/microsoft/dynamics365f-o-custom-help/。
次の表は、ヘルプ エクスペリエンスを構成するために管理者が通常持つ主な目的の概要を示します。
| 目標 | 詳細情報 |
|---|---|
| 実際のソリューションを反映した、カスタマイズされた製品内ヘルプ エクスペリエンスをユーザーに提供したい。 | この記事の カスタム ヘルプ Web サイト セクションと、タスク レコーダーを使用したドキュメントやトレーニングの作成 にアクセスしてください。 |
| コンテンツを ヘルプ ウィンドウに追加したい。 | カスタム ヘルプ Web サイトを ヘルプ ウィンドウに接続する にアクセスしてください。 |
| 最初にDynamics用に作成されたコンテンツを再利用します AX。 | 「Reuse Dynamics 2012年のコンテンツ AX セクション してください。 |
| 別の関連言語のコンテンツを1つの言語で再利用します。 | ヘルプ 言語およびロケールのロケールロケールの してください。 |
| Microsoft Help コンテンツに寄稿したい。 | ヘルプへの貢献 にアクセスしてください。 |
カスタム ヘルプ Web サイト
製品がヘルプ コンテンツに接続する前に、製品内の ヘルプ ウィンドウをカスタマイズして、コンテンツが表示されるようにする必要があります。 カスタム ヘルプweb 接続ヘルプ ウィンドウで詳細を表示するを参照してください。
次の条件を満たす必要があります:
コンテンツは Web サイト で入手可能である必要があります。
コンテンツを既存の Web サイト に展開するか、コンテンツをホストする専用の Web サイト を設定できます。 Web サイトは非公開でも公開でもかまいませんが、コンテンツにアクセスするのにユーザーにサインインを要求しないことをお勧めします。
コンテンツには、検索サービスでインデックス付けされる必要があります。
検索サービス Generate何ものファイルを参照してください してください。
コンテンツには、適切なメタデータ プロパティが含まれる必要があります。
詳細については、セクションを参照してください。
カスタム ヘルプ ファイルのメタデータ要件
結果を返すには、状況依存ヘルプと全文検索用のトピックに次のメタデータが存在する必要があります。
| プロパティ | Description |
|---|---|
| タイトル | この値は、ヘルプ ウィンドウからの全文検索に使用されます。 |
| 説明 | この値は、ヘルプ ウィンドウからの全文検索に使用されます。 |
| ms.search.form | この値には、ページのアプリケーション オブジェクト ツリー (AOT) の名が含まれ、ヘルプ ウィンドウからの状況依存検索に使用されます。 |
| ms.locale | 値は、記事の言語を示します。 ヘルプ ウィンドウがコンテンツを検索するときに、現在のブラウザー ロケールに対してマップされます。 ターゲットのカスタム ヘルプ Web サイトに対して、言語のフォールバックを設定できます。 詳細については、 およびヘルプを参照してください。 |
| ms.search.scope | 値は、ヘルプ記事が表示されるクライアントを決定します。 1 つ以上の値を指定できます。 値には 、Core、Operations、Retail、および Human Resources が含まれます。 |
次の表では、ms.search.scope プロパティに指定できる値について説明しています。 1 つ以上の値を指定できます。 値は、ヘルプ記事が表示されるクライアントを決定します。
| 値 | Description |
|---|---|
| コア | この値が存在する場合、記事はヘルプ ウィンドウに表示されます。 それ以外の場合、記事はヘルプ ウィンドウに表示されません。 この値は、サポートされているすべての Dynamics 365 ソリューションのすべてのユーザーに対して、常に ヘルプ ウィンドウで使用可能でなければならない Microsoft コンテンツの一部に設定されます。 |
| 運用 | この値は、Finance または Supply Chain Management に基づくソリューションに適用されます。 |
| Retail | この値は、Commerce に基づくソリューションに適用されます。 |
| Human Resources | この値は、Dynamics 365 Human Resources に基づくソリューションに適用されます。 |
不要なメタデータ
次のプロパティは、将来の使用のために予約されています。
- ms.search.region – 最終的には、このプロパティを使用して、グローバルまたは実装の地域のいずれかのタグが付けられたコンテンツに表示されるコンテンツを制限できます。
- ms.search.validFrom – 最終的には、このプロパティを使用して、特定の日付以前にリリースされた製品のコンテンツに対して表示されるコンテンツを制限できます。
- ms.dyn365.ops.version – 最終的には、このプロパティを使用して、特定のバージョン以前の製品のコンテンツに対して表示されるコンテンツを制限できます。
- ms.search.industry – 最終的には、このプロパティを使用して、特定の業種のコンテンツに表示されるコンテンツを制限できます。
検索サービス用の複数のファイルの生成
ConvertHtmlToJson ツールは、HTML ファイルを JSON ファイルに変換します。 次に、JSON ファイルを Microsoft Azure検索サービスに追加すると、ヘルプ コンテンツへの状況依存リンクが生成されます。 このツールは次の場所 https://github.com/microsoft/dynamics365f-o-custom-help/。
JSON ファイルには、ターゲットのヘルプ ページが対象とするフォームと言語を識別するためにインデクサーが使用するメタデータが含まれています。
ConvertHtmlToJson.exe を実行するための構文は次のとおりです。
ConvertHtmlToJson.exe --h <path> -j <path> --v <true|false>
次のテーブルでは、パラメーターについて説明します。
| パラメーター | Description |
|---|---|
| h | 処理する HTML ファイルのパスを指定します。 |
| j | JSON ファイルを保存するフォルダを指定します。 フォルダーは既に存在している必要があります。 |
| 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に 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 メタデータ名を 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" />
必要なメタデータの説明については、カスタム ヘルプ ファイルの Metadata要件 してください。
HTML コンテンツ をMarkdown に変換
コンテンツを Markdown に変換するには、サード パーティのツールを使用します。 マイクロソフトは、HTML を Markdown に変換できるツールは提供していません。
コンテンツを Markdown に変換した後で、オープンソース ツールを使用して、Web サイトのコンテンツを生成できます。 Markdown を使用することで、さまざまな オープン ソース ツールにアクセスできます。 詳細については、ヘルプへの貢献 にアクセスしてください。
参照
カスタム ヘルプ Web サイトを [ヘルプ] ウィンドウに接続する
製品およびヘルプの言語およびロケール記述子
財務と運用アプリのヘルプ エクスペリエンスの構成
ヘルプ システム