Configuring Microsoft Dynamics NAV Help Server

Dynamics NAV Help deploys to a Dynamics NAV Help Server, which is a website that installs on the specified server. The website includes Search and other navigation, and it provides context-sensitive Help for Microsoft Dynamics NAV Web client and Microsoft Dynamics NAV Windows client. You can configure each client to access Help on any Dynamics NAV Help Server. Depending on your deployment architecture, you can choose to set up a dedicated Help Server that all clients connect to, or you can choose to deploy customer-specific Help Servers. You can deploy a Help Server under either http or https protocols.

Deploying the Help Server

The Dynamics NAV Help Server is an installation component that you can choose from the Custom option of Dynamics NAV Setup. When you choose to install the Help Server, a website is created on the specified server. If Internet Information Services (IIS) are not present on the server, Setup installs this and other prerequisites. When the Setup program is finished, the website is set up with a folder for each language in your version of Dynamics NAV. However, the Help content consists of many files, and therefore, the content is not fully available until after several minutes. Exactly how much time it takes to make the content available depends on the number of Help files that must be added to the website.

You can add solution-specific and customer-specific Help, and you can add as many languages to the Help Server as your deployment requires. When accessed from Dynamics NAV, Help displays in the language that the current client uses. If that language is not available, the Help Server defaults to English.

Configuration Settings

When you install the Dynamics NAV Help Server, you must specify the following information.

Field Description
Install location Specifies where the Dynamics NAV Help Server is installed, such as C:\inetpub\wwwroot.
Port Specifies the TCP listening port for the Dynamics NAV Help Server, such as 49000.

The valid range is 1-65535.

Then, when you install Microsoft Dynamics NAV Server, the Microsoft Dynamics NAV Windows client, or the Microsoft Dynamics NAV Web Server components, you must specify where the Help Server is located as described in the following table.

Field Description
Server Specifies the location of the computer that hosts the Dynamics NAV Help Server, such as MyWebServer.

If the value of the HelpServer setting starts with "http," then the HelpServer port setting is ignored and the entire value is used to create the base of the help url. This enable you to set up a server that uses https or that includes a subpath, as in the following examples:

https://myserver.com

-or-

http://myserver.com:45672/navhelp/financeapp

If the Help Server setting does not begin with "http," then Dynamics NAV will format the url as follows: http://<HelpServer value>:<HelpServerPort value>.
Port Specifies the TCP listening port for the Dynamics NAV Help Server, such as 49000.

For Microsoft Dynamics NAV Windows client users, this configuration is stored in the ClientUserSetting.config file. For more information, see Configuring the Windows Client.

Configuring the Website

The Dynamics NAV Help Server deploys as a website that you can configure like any other website. For example, you must make the website available to your users by granting them permission to access the website. By default, users that you set up in Dynamics NAV can access the website, because Dynamics NAV Setup enables Windows authentication and anonymous authentication. For example, if your Dynamics NAV deployment uses Windows authentication, you can add the relevant domain group to the IIS users group. If you want to use other types of authentication, you can set up NET authorization rules, for example.

The website for the Help Server contains several folders as described in the following table.

Folder Description
App_GlobalResources Contains the localized strings for the website itself.
bin Contains the Microsoft.Dynamics.Nav.WebHelp.dll assembly that provides core functionality for the Dynamics NAV Help Server.
css Contains the stylesheets for the website.
help Contains the Help content with a subfolder for each language module in your deployment, an en folder, and a local folder.

The locale-specific Help content is in locale-specific folders. For example, in the Danish version of Dynamics NAV, the Help Server website includes a da-DK folder with the Help content in Danish.

The en folder contains Help content in the non-locale-specific version. This is the version of the Help that Dynamics NAV defaults to if the client locale cannot be found.

The local folder contains pictures and other supporting files for the Help content.
images Contains icons for the website.
js Contains support files for the website.

Help is installed as CAB files, which self-extract when the installation is completed, such as htmlhelp.en.cab.

If you want to add your own Help content to the Help Server website, you can add the relevant HTML files to the relevant locale-specific folder.

Each locale-specific Help folder contains a ToC.xml file that defines the navigation pane on the website, the table of contents. If you want to add your Help content to the table of contents file, you can edit the ToC.xml file in the XML editor of your choice, such as Notepad or Visual Studio.

In a multitenant deployment, the Help links that open a specific page in Dynamics NAV do not work by default. To convert all of the hyperlinks in your existing Help, you can use a search-and-replace tool to find the links that look like this example:

<a href="DynamicsNAV:////runpage?Page=536" alt=  

and replace them with:

<a href="DynamicsNAV://///runpage?Page=536" alt=  

See Also

Microsoft Dynamics NAV Help Server
Help Table of Contents
Upgrading Your Existing Help Content
Configuring Microsoft Dynamics NAV
Configuring Microsoft Dynamics NAV Server
Configuring the Windows Client
Configuring the Microsoft Dynamics NAV Web Server and Client
Demo Option