Modifier

Partager via

Configure the Help experience for finance and operations apps

  • Article

Important

Customers using Human Resources, the functionality noted in this article is currently available in both the stand-alone Dynamics 365 Human Resources and the merged Finance infrastructure. Navigation might be different than noted while we make updates. If you need to find a specific page, you can use Search.

In this article, you will find an overview of the components of the Help system for solutions with Dynamics 365 Finance, Dynamics 365 Supply Chain Management, Dynamics 365 Commerce, or Dynamics 365 Human Resources. The article also explains how to connect these components.

Help architecture

Finance and operations apps include conceptual overviews and other topics that are published to the Microsoft Learn site. This content can then be accessed from the in-product Help pane. The following illustration shows the parts of the Help system.

Help architecture.

The in-product Help system pulls articles from Microsoft Learn and other connected websites. It also pulls in task guides that are stored in Business process modeler (BPM) in Microsoft Dynamics Lifecycle Services (LCS).

Adding task guides

Note

The Task guides tab isn't currently available in Human Resources or Commerce. However, the task guides in the Getting Started experience in Human Resources remain available to cover basic functionality. For both Human Resources and Commerce, procedural Help is available on the Microsoft Dynamics 365 documentation site.

On the System parameters page, system admins can configure access to the relevant task guide libraries for an implementation.

Note

  • To configure Help, you must sign in by using an account in the same tenant as the tenant where the app is deployed.
  • An LCS library can't be connected from an instance of the app that is running on a local virtual hard drive (VHD).

System Parameters form with Help settings.

To configure task guides for a solution, follow these steps on the System parameters page.

Important

The first time that you open the Help tab, you must connect to Lifecycle Services. Be sure to select the link in the middle of the form, wait for the connection, close the dialog box, and then select OK to get to the System Parameters page.

Connect to LCS

  1. Select the Lifecycle Services project to connect to.
  2. Select the BPM libraries (within the selected project) to retrieve task recordings from.
  3. Set the display order of the BPM libraries. The display order defines the order in which task recordings from the libraries will appear in the Help pane.

After you complete these steps, you can open the Help pane and select the Task guides tab. You'll now see the task guides that apply to the page that you're currently on in finance and operations apps. If no task guides are found, you can enter keywords to refine your search.

Showing translated task guides

Translated task guides were first released in the May 2016 APQC Unified Library and in the Getting Started library. To view localized task guide Help, make sure that your Dynamics 365 solution is connected to the May 2016 library. Users can change the language that a task guide appears in by changing the language settings under Options > Preferences.

Note

Although many task guides have been translated, the client doesn't currently show the translated task guide names. Additionally, in the May 2016 library, translations are available only for the task guides that were released in February 2016. Microsoft will release an updated library that includes additional translations.

  • If a task guide has been translated, when you open that task guide all the text of the task guide will appear in your selected language.
  • If a task guide has not yet been translated, when you open it, only some of the text (the text of the controls) will appear in your selected language.

Adding custom Help

You can use task guides to create custom Help, or you can connect a custom Help website to the Help pane.

Create custom Help by using task guides

You can create custom Help for the supported apps by creating task recordings that reflect your implementation and then saving them to a Business process library in LCS. You can't create custom task guides for Human Resources.

If you're a partner, and you promote a library to a corporate library and include it in a solution, it will be available to your customers. You can also make a copy of the APQC Unified Library, and then open the task recordings in the copy, edit them, and save your changes. For more information, see Task recorder resources.

Connect a custom Help site

Finance and operations apps are rarely used in their out-of-box form. Instead, the solution is customized and extended to fit the organization's needs. You can also customize and extend the Help experience. For example, you can add custom Help to the in-product Help pane.

Microsoft has provided a toolkit to help you deploy and connect custom Help to the Help pane. Learn more at Custom Help overview.

See also

Help system
Custom Help overview
Task recorder resources
Create documentation or training with Task Recorder
Custom Help GitHub repository