次の方法で共有

カスタム ヘルプ Web サイトを [ヘルプ] ウィンドウに接続する

  • [アーティクル]

財務と運用ソリューションのカスタム ヘルプ コンテンツを提供する場合は、ヘルプ ウィンドウを拡張して、コンテンツを使用することができます。 Microsoft Visual Studio の財務と運用開発環境を使用して、この 1 回限りのコンフィギュレーションを完了します。 完了したら、ユーザーは、タスク ガイド、Microsoft ヘルプ コンテンツ、ヘルプ コンテンツのタブを選択できます。

カスタム ヘルプ Web サイト を製品内 ヘルプ ウィンドウに接続するプロセスには、次の手順があります:

  1. Visual Studio の ヘルプ ウィンドウを拡張します。
  2. 言語にインデックスを割り当てます。
  3. 言語のフォールバックをカスタマイズします。

重要

以下の手順には、Visual Studio で財務と運用アプリの開発ツールが必要です。 詳細については、Visual Studio の開発ツール を参照してください。

[ヘルプ] ウィンドウを拡張してカスタム ヘルプ インデックスを言語に割り当てる

このプロセスを完了するために必要なツールは、https://github.com/microsoft/dynamics365f-o-custom-help/ ダウンロード可能なリリースとしてのリポジトリで使用できます。 リリース で確認できます。

ヘルプ ウィンドウ拡張 フォルダーには、財務と運用開発環境で開くことができる AzureSearchCustomHelp ソリューションが含まれています。 このフォルダには、Visual Studio のソリューションにインポートできる HelppaneOption.axpp プロジェクトも含まれています。

[ヘルプ] ウィンドウを拡張する

  1. 財務と運用開発環境で、AzureSearchCustomHelp.sln ソリューションを開きます。

  2. Dynamics 365 メニューで、プロジェクトのインポート を選択します。

  3. ファイル名 フィールドで、HelppaneOption.axpp プロジェクトのパスを指定し、OK を選択してインポート プロセスを完了します。 参照が欠落しないように参照を更新します。

  4. HelppaneMacro ファイルで、次のパラメータの値を更新します:

    • [WebAppName] – Web アプリの作成 で作成した Web アプリの名前を指定します。 たとえば、MyCustomHelpWebApp を指定します。
    • 管理キー値 – Azure Cognitive Search サービスの管理キーを指定します。 キーは、Azure ポータル の検索サービスの左側にある 設定 の アクセス キー にあります。
    • [SearchServiceName] – 検索サービスの作成で作成した検索サービスの名前を指定します。 たとえば、mycustomhelpsearch を指定します。

    次の例は、HelppaneMacro ファイルのコンテンツを示します。

    #define.webApp('http://[WebAppName].azurewebsites.net/')
#define.queryApiKey('Admin key value')
#define.defaultstring('dashboard')
#define.searchservicename('[SearchServiceName]')
#define.CustomResultError('error')
#define.CustomTabPage('CustomTabPage')
#define.CustomHelp('Custom Help')
#define.CustomTitle('CustomTitle')
#define.htm('html')

  5. オプション: ヘルプ ウィンドウに表示されるユーザー インターフェイス (UI) の文字列を変更する場合は、Customhelppane.en-US.label.txt ファイルを編集します。

次に、カスタム ヘルプの検索インデックスが使用する言語を指定する必要があります。

このプロセスを完了するために必要なツールは、https://github.com/microsoft/dynamics365f-o-custom-help/ ダウンロード可能なリリースとしてのリポジトリで使用できます。 リリース で確認できます。

言語にカスタム インデックスを割り当てる

  1. ソリューションで Language.config ファイルを開きます。

  2. 一覧で、インデックスの言語を検索し、index=""、parentindex=""、または ultimateindex="" キーを使用してインデックス名を指定します。

    たとえば、英語 (米国) とドイツ語 (オーストリア) の検索インデックスを作成し、それぞれ myenusindex と mydeatindex という名前を付けたとします。 この場合、エントリは次のようになります。

    <add language="en-US" ultimateindex="myenusindex" />
<add language="de-AT" parentlanguage="de" index="mydeatindex" />

  3. オプション: 次のセクションで説明するように、インデックスの言語のフォールバックをカスタマイズします。

  4. AzureSearchCustomHelp ソリューションを構築します。

結果は、顧客プロジェクトの資産ライブラリまたは Microsoft Dynamics Lifecycle Services (LCS) のソリューション プロジェクトにアップロードするモデルです。

言語のフォールバックをカスタマイズする

言語のフォールバックとは、目的の言語が結果を返さない、または存在しない場合に、ヘルプウィンドウが追加の言語で検索を実行することを意味します。

メモ

追加の言語でカスタム インデックスを使用できる必要があります。

検索とフォールバックの順序には、次の優先順位があります:

  1. クライアントで設定されている言語 (たとえば、de-AT)
  2. その言語のparentlanguage属性で定義されている言語 (たとえば、<add language="de-AT" parentlanguage="de" index="mydeindex" />)
  3. ultimateindex 属性が設定されている言語 (たとえば、<add language="en-US" ultimateindex="myenusindex" />)

重要

parentlanguage 属性が設定されている場合は、対応する parentindex キーが必要です。

次のシナリオは、language="de" には parentindex="indexde" があり、de-DE と de-AT の両方が deの子孫であるため有効です。

<add language="de" parentindex="indexde"/>
<add language="de-DE" parentlanguage="de" index=""/>
<add language="de-AT" parentlanguage="de-DE" index="indexdeat"/>

次のセクションでは、コンフィギュレーションの例を示します。

1 つのロケールのヘルプ コンテンツ

このコンフィギュレーションでは、英語 (米国) のみのヘルプ コンテンツがあります。 クライアントが設定されているロケールに関係なく、ヘルプ コンテンツは英語 (米国) で表示されます。

<add language="en-US" ulitmateindex="indexenus"/>

複数のロケールのヘルプ コンテンツ

このコンフィギュレーションでは、フランス語、ドイツ語、英語 (米国) のヘルプ コンテンツがあります。 de ロケールに設定されているクライアントは、ドイツ語でヘルプ コンテンツを表示し、fr ロケールに設定されているクライアントは、フランス語でコンテンツを表示し、他のロケールに設定されているクライアントは、コンテンツを英語 (米国) で表示します。

<add language="en-US" ulitmateindex="indexenus"/>
<add language="fr" parentindex="indexfr"/>
<add language="de" parentindex="indexde"/>

クライアントが de または fr ロケールに設定されているが、それぞれドイツ語またはフランス語のコンテンツで結果が見つからない場合は、コンテンツが使用できる場合は、結果が英語 (米国) で表示されます。

親ロケールを使用するヘルプ コンテンツ

このコンフィギュレーションでは、ドイツ語、ドイツ語 (オーストリア)、英語 (米国) のヘルプ コンテンツがあります。 たとえば、オーストリアの機能に関連するトピックがいくつかありますが、それ以外はドイツ語のトピックを使用できます。

<add language="en-US" ulitmateindex="indexenus"/>
<add language="de" parentindex="indexde"/>
<add language="de-AT" parentlanguage="de" index="indexdeat"/>

クライアントが de-AT ロケールに設定されているが、ドイツ語 (オーストリア) コンテンツで結果が見つからない場合は、コンテンツが使用できる場合は、結果がドイツ語と英語 (米国) で表示されます。

参照

製品およびヘルプの言語およびロケール記述子
カスタム ヘルプの概要
財務と運用アプリのヘルプ エクスペリエンスの構成
ヘルプ システム