Configuring Microsoft Dynamics NAV Portal Framework

  • Article

To install Microsoft Dynamics NAV Portal Framework for Microsoft SharePoint 2010, you run Microsoft Dynamics NAV 2013 Setup. Setup installs Microsoft Dynamics NAV Portal Framework on one or more SharePoint applications. During Setup, you provide configuration settings for the Microsoft Dynamics NAV Portal Framework, such as which Microsoft Dynamics NAV Server instance to connect to. These settings, along with other settings that are not available in Setup, are saved in the web.config file of the SharePoint web applications. After installation, you can change the configuration by modifying the web.config file of the SharePoint application.

About the web.config File

Each SharePoint application has its own web.config file. The web.config file is located in the physical path to the SharePoint application on the computer that is running Microsoft SharePoint Foundation Server 2010 or Microsoft SharePoint Server 2010. By default, the folder is c:\inetpub\wwwroot\wss\VirtualDirectories\<portnumber>. The portnumber indicates the port that is assigned to the web application. For information about how to identify a port number, see How to: Identify the Port Number of a SharePoint Application.

The web.config file is an .xml file that you can edit with a text editor, such as Notepad.

When you install Microsoft Dynamics NAV Portal Framework on a SharePoint application, the web.config file is modified to include a <DynamicsNAVSettings> element. The <DynamicsNAVSettings> element contains several settings that configure the communication between Microsoft Dynamics NAV Portal Framework and Microsoft Dynamics NAV Server.

Settings in the web.config File

The following table describes the settings that are available in the <DynamicsNAVSettings> element of web.config file.

Note

If the SharePoint application that is running Microsoft Dynamics NAV Portal Framework has one or more subsites, then you can use these settings to configure each subsite individually. For more information, see Configuring Subsites by Using the Location Element.

Setting Description

AllowNtlm

Specifies whether NT LAN Manager (NTLM) fallback is permitted for authentication.

To require Kerberos authentication, set this value to false.

Values: true, false

Default value: true

ClientServicesChunkSize

Sets the maximum size, in kilobytes, of a data chunk that is transmitted between Microsoft Dynamics NAV Portal Framework and Microsoft Dynamics NAV Server. Data that is transmitted between Microsoft Dynamics NAV Portal Framework and Microsoft Dynamics NAV Server is broken down into smaller units called chunks, and then reassembled when it reaches its destination.

Values: Between 4 to 80

Default: 28

ClientServicesCompressionThreshold

Sets the threshold in memory consumption at which Microsoft Dynamics NAV Portal Framework starts compressing data sets. This limits amount of consumed memory. The value is in kilobytes.

Default: 64

ClientServicesPort

Specifies the TCP port for the Microsoft Dynamics NAV Server. This is part of the Microsoft Dynamics NAV Server’s URL.

Values: 1-65535

Default value: 7046

ClientServicesProtectionLevel

Specifies the security services used to protect the data stream between the Microsoft Dynamics NAV Portal Framework and Microsoft Dynamics NAV Server. This value must match the value that is specified in the Microsoft Dynamics NAV Server configuration file. For more information, see Configuring Microsoft Dynamics NAV Server

Values: EncryptAndSign, Sign, None

Default value: EncryptAndSign

Company

Sets the company in Microsoft Dynamics NAV to connect to. If you do not define a company, then the last company used by the user is displayed.

Values: A company defined in the Microsoft Dynamics NAV solution.

For more information about companies, see How to: Create Companies.

Default value: none

HelpURL

Specifies the URL that is targeted by the Microsoft Dynamics NAV Help action that is available on Microsoft Dynamics NAV pages in the Microsoft Dynamics NAV SharePoint client. The Microsoft Dynamics NAV Help action is located on the General tab in the page ribbon. By default, the URL targets the Microsoft Dynamics NAV 2013 help in the MSDN library at www.msdn.com. This is a public web site, so to view the help, users must have permission to access the Internet or the default help URL as a minimum.

Default value: https://go.microsoft.com/fwlink/?LinkID=233742

Language

Sets the language version of the Microsoft Dynamics NAV SharePoint client. For more information about languages, see Multilanguage Development and Managing Languages and Regional Settings for the Microsoft Dynamics NAV SharePoint Client.

Values: A valid culture name for a language that is available for the Microsoft Dynamics NAV solution. The culture name has the format: nn-NN. nn is a lowercase two-letter code for the language and NN is an uppercase two-letter code for the country or region. For example, en-US is for English (United States) and en-GB is for English (United Kingdom), and da-DK is for Danish (Denmark). There are some languages that use a three-letter language code or a suffix to the region code. The locale must follow the RFC 1766 standard. For a list of the most common culture names, see CultureInfo Class.

Default value: en-US

Hh165816.Important(en-us,NAV.70).gifImportant
For the Spanish version of Microsoft Dynamics NAV, you must set the value to es-ES_tradnl.

Server

Specifies the name of the computer that is running the Microsoft Dynamics NAV Server.

Default value: localhost

ServerInstance

Specifies the name of the Microsoft Dynamics NAV Server instance that the Microsoft Dynamics NAV Portal Framework connects to.

For more information, see Managing Microsoft Dynamics NAV Server Instances.

Default value: DynamicsNAV70

ServicePrincipalNameRequired

If this parameter is set to true, then the Microsoft Dynamics NAV Portal Framework can only connect to a Microsoft Dynamics NAV Server instance that has been associated with a service principal name (SPN).

If this parameter is set to false, then the Microsoft Dynamics NAV Portal Framework attempts to connect to the configured Microsoft Dynamics NAV Server service, regardless of whether that service is associated with an SPN.

For more information about SPNs, see How to: Set Up Delegation on the Microsoft Dynamics NAV Portal Framework.

Default: false

SessionTimeout

Specifies the maximum time that a connection between the Microsoft Dynamics NAV Portal Framework and the Microsoft Dynamics NAV Server can remain idle before the session is stopped.

On a SharePoint site, this setting determines how long an open Microsoft Dynamics NAV page can remain inactive before it closes. For example, when the SessionTimeout is set to 20 minutes, if a user does not take any action on a page within 20 minutes, then the page closes and it is replaced with the following message: The page has expired and the content cannot be displayed.

The time span has the format [dd.]hh:mm:ss:

  • dd is the number of days

  • hh is the number of hours

  • mm is the number of minutes

  • ss is the number of seconds

Default value: 00:20:00

ShowReportViewerExportOptions

Specifies whether to show the options for saving a report as a Microsoft Excel, Microsoft Word, or Acrobat (PDF) file in the Print Preview for Microsoft Dynamics NAV reports on SharePoint sites.

If this parameter is set to true, then the save as Excel, Word, and PDF options appear in the Print Preview.

Default: false

Hh165816.note(en-us,NAV.70).gifNote
To display reports, Microsoft Report Viewer must be configured in the web.config file of the SharePoint application. Microsoft Report Viewer is configured by default. For more information, see How to: Configure Microsoft Report Viewer for the Microsoft Dynamics NAV Web Client and SharePoint Client.

UnknownSpnHint

Specifies whether to use server principal name when establishing the connection between the Microsoft Dynamics NAV Portal Framework and Microsoft Dynamics NAV Server. This setting is used to authenticate the Microsoft Dynamics NAV Server, and it prevents the Microsoft SharePoint Foundation server from restarting when it connects to Microsoft Dynamics NAV Server for the first time. You set the values that are based on the value of the ServicePrincipalNameRequired key.

Value: The value has the following format.

(net.tcp://<NavServer>:<Port>/<ServerInstance>/Service)=NoSpn|SPN

  • NavServer is the name of the computer that is running the Microsoft Dynamics NAV Server.

  • Port is the port number on which the Microsoft Dynamics NAV Server is running.

  • ServerInstance is the name of the Microsoft Dynamics NAV Server instance.

  • NoSpn|SPN specifies whether to use an SPN. If the ServicePrincipalNameRequired key is set to false, then set this value to NoSpn. If the ServicePrincipalNameRequired key is set to true, then set this value to Spn.

Default value: (net.tcp://localhost:7046/DynamicsNAV70/Service)=NoSpn

If you set this key to the incorrect value, then during startup, the Microsoft Dynamics NAV Portal Framework will automatically determine a correct value. This will cause the Microsoft SharePoint Foundation Server to restart.

Hh165816.note(en-us,NAV.70).gifNote
For most installations, you do not have to change this value. Unlike the Microsoft Dynamics NAV Windows client, this setting is not updated automatically. If you want to change the default value, then you must change it manually.

Configuring Subsites by Using the Location Element

When you install Microsoft Dynamics NAV Portal Framework on a SharePoint application, Microsoft Dynamics NAV Portal Framework is also deployed on any subsites of the application. Subsites use the same web.config file as the parent site. This means that, by default, subsites use the same Microsoft Dynamics NAV settings as the root site. There may be instances when you want subsites to use different Microsoft Dynamics NAV settings than the root site. For example, you can have the subsites use a different Microsoft Dynamics NAV company or language.

The following list includes the Microsoft Dynamics NAV settings that you can configure for subsites:

  • Company

  • Language

To change the Microsoft Dynamics NAV settings individually for a subsite, you add the following elements to the <configuration> element in the web.config file.

<location path="site1">
  <DynamicsNAVSettings>
  </DynamicsNAVSettings>
</location>

In the <DynamicsNAVSettings> element, include an <add key="" value="" /> element for each setting that you want to change. For example, the following code illustrates how to specify a different Microsoft Dynamics NAV Server, company, and language for two subsites: site1 and site2.

<configuration>
  <!-- additional elements -->
  
  <DynamicsNAVSettings>
    <!-- root NAV settings -->
  </DynamicsNAVSettings>
  <location path="site1">
    <DynamicsNAVSettings>
      <add key="Company" value="Company1"/>
      <add key="language" value="fr-FR"/>
    </DynamicsNAVSettings>
  </location>
  <location path="site2">
    <DynamicsNAVSettings>
      <add key="Company" value="Company2"/>
      <add key="language" value="da-DK"/>
    </DynamicsNAVSettings>
  </location>
  <!-- additional elements -->
</configuration>

See Also

Tasks

How to: Install Microsoft Dynamics NAV Portal Framework

Concepts

Microsoft Dynamics NAV Portal Framework for Microsoft SharePoint
Configuring Microsoft Dynamics NAV Server