Convert Dynamics AX custom Help for use in Dynamics 365

If you have existing content from Microsoft Dynamics AX 2012, you can reuse it for Dynamics 365 Finance, Dynamics 365 Supply Chain Management, and Dynamics 365 Commerce. However, you must first transform the HTML files so that they can be used in the custom Help environment.

Converting AX 2012 content

The Microsoft Custom Help Toolkit includes a Windows PowerShell script, run_ax2012.ps1, that can transform AX 2012 HTML files so that they can be used in the custom Help environment. The script makes the following changes to the AX 2012 HTML files:

  • Replace the Microsoft.Help.F1 metadata name with ms.search.form.

  • Replace the Title metadata name with title.

  • Change the file name extension from .htm to .html.

  • Add the following metadata.

    <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" />
    

Running the script

You can run the following command from a Command Prompt window, or you can run the script directly in Windows PowerShell.

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

The following metadata is currently used, or it's reserved so that it can be used during indexing.

<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" />

For a description of the required metadata, see Metadata requirements for custom Help topics.

Moving to Markdown

To convert your existing content to Markdown, you can use various third-party tools, such as PanDoc and the Writage plug-in for Word.

After you've converted your content to Markdown, you can use open-source tools such as DocFx to generate content for your website. In general, by working in Markdown, you gain access to a wide range of open-source tools. For more information, see Extend, customize, and collaborate on the Help.

See also

Custom Help overview
Custom Help Toolkit
Extend, customize, and collaborate on the Help