Install and configure Windows AppFabric for Enterprise Portal
Important
This content is archived and is not being updated. For the latest documentation, see Microsoft Dynamics 365 product documentation. For the latest release plans, see Dynamics 365 and Microsoft Power Platform release plans.
Applies To: Microsoft Dynamics AX 2012 R3
This topic provides sample configurations and settings for installing Windows Server AppFabric with Enterprise Portal for Microsoft Dynamics AX. AppFabric is required to run Enterprise Portal in a web farm with Microsoft Dynamics AX 2012 R2. AppFabric is not required for single-server Enterprise Portal deployments.
Windows Server AppFabric is a set of integrated technologies that make it easier to build, scale and manage Web and composite applications that run on Internet Information Services (IIS). AppFabric extends Windows Server to provide enhanced hosting, management, and caching capabilities for Web applications and middle-tier services. Enterprise Portal uses the AppFabric distributed, in-memory caching services to improve the performance and scalability of the application.
Important
This document includes sample settings and configurations to help you install AppFabric for Enterprise Portal. Depending on your hardware, software, and computing environment, you might select different settings and configurations from those specified in this document.
This topic includes the following sections
Install Windows Server AppFabric on a single server
Install Windows Server AppFabric in a cluster
Note
Previous versions of Windows Server AppFabric were called Velocity Server. This document includes code blocks that make reference to “Velocity”.
Install and configure Windows Server AppFabric on a single server
Use the following procedures to install Windows Server AppFabric single server and then run the configuration wizard. To install AppFabric in a cluster, see Install Windows Server AppFabric in a cluster in this document. The installation program provides the following functionality:
Enables you to select specific features to install.
Validates the operating system to make sure that the product is not installed in an unsupported state, and indicates which prerequisites have to be installed.
Installs AppFabric.
Enables you to remove specific AppFabric features or AppFabric as a whole. This makes sure that the computer can be left in a state in which the features or AppFabric can be reinstalled.
Creates the AppFabric Caching Service. Sets the services to a startup type of manual and a status of stopped.
The AppFabric Setup program sets configuration settings in the root (server level) Web.config file, the machine.config file, and the applicationHost.config file. You can configure AppFabric either immediately after installation, or in a separate process. Installing and configuring Windows Server AppFabric on a single server requires that you:
Run Setup
Run the configuration wizard
Configure cache settings with PowerShell
Install and configure the cache client
Validate deployment
Each of these processes is described in this topic.
Run Setup
Run one of the following Setup applications on the Enterprise Portal server:
For AppFabric 1.0, download and run the WindowsServerAppFabricSetup_x64_6.1.
For AppFabric 1.1, download and run the WindowsServerAppFabricSetup_x64.
On the Accept License Terms page, read the license terms, and then accept the terms and then click Next to continue, or do not accept the terms and then exit the setup wizard.
On the Customer Experience Improvement Program page, select Yes to participate in the Customer Experience Improvement program, or No not to participate, and then click Next.
Clear the Yes, download and install critical updates option.
On the Feature Selection page, select Caching Services and Cache Administration, and then click Next.
Caching Services
The distributed Caching Service and related components that enable you to prepare this host as a Caching Service, turning the server into the node of a cluster. You can create a new cluster or join this host to an existing cluster by using the Caching Service.
Cache Administration
Components that enable you to administer a cache cluster. You can select Cache Administration as an independent component, without other features selected. In that instance, you could use administration tools to administer the Caching Service installed on a separate computer.
Note
If prerequisite software has to be installed, the setup wizard will display the Platform Validation page after the Feature Selection page. You must install the missing prerequisites manually. If all prerequisites have already been installed, the setup wizard will continue to the Confirm Installation Selections page.
On the Platform Validation page, review the information and download any prerequisite software. Click the link for a component or a configuration issue for more information. After installing components and resolving issues, click Refresh to verify that the problem has been fixed and then click Next to continue with the setup wizard.
The Confirm Installation Selections page will display a list of the features that were selected in the Feature Selection page, and will be installed. It displays a list of the required Windows components and the AppFabric features that will be installed. Verify that the lists are correct, and then click Install to begin installation.
Note
The Application Server role is required for AppFabric. This role will be included in the list of the required Windows components even if it is already installed, and the installation wizard will verify that it has been installed.
On the Installation Progress page, you can monitor the progress of the installation.
On the Installation Results page, verify that the installation has succeeded. To display a list of recommended updates that you can install, click the Recommended Updates link. To run the configuration wizard, select the Launch configuration tool check box, and then click Finish to complete the installation wizard. Click Detailed Installation report to display a log of setup events.
Run the configuration wizard
This section describes recommended settings for Windows Server AppFabric with Enterprise Portal. The following table lists settings as they appear in the Windows Server AppFabric Configuration Wizard. For more information about the options or settings in the configuration wizard, see Configure Windows Server AppFabric.
Configuring Caching service parameters |
Suggested settings |
|---|---|
Set Caching Service configuration |
Select this option |
Caching Service configuration provider |
XML |
File share (UNC server share required: \\server\share) |
Create a file share on the C drive of the Enterprise Portal server. Configure permissions for the share as follows:
|
New cluster |
Select this option |
Cluster size |
Select Small (1-5 computers) |
Click Next to view the next page of the wizard.
Configure AppFabric Cache Node |
Suggested settings |
|---|---|
Node ports |
Retain default settings |
Windows firewall exceptions |
Select Windows Server AppFabric: AppFabric Caching Service |
Click Finish. When prompted, click Yes.
Configure cache settings with PowerShell
The procedure in this section uses PowerShell Cmdlts to configure cache settings. For more information, about these cmdlts, see AppFabric Caching PowerShell Cmdlts on MSDN.
Open the Caching Administration Windows PowerShell command prompt as an administrator.
Execute the Use-CacheCluster command to set the context of your PowerShell session to a particular cache cluster.
Execute the New-Cache command to create a new named cache. Make a note of the name you specified. You will enter this cache name in the next procedure.
Execute the Grant-CacheAllowedClientAccount command and specify the .NET Business Connector proxy (the account that is used by the Enterprise Portal application pool).
Execute the Start-CacheCluster command to start the cache.
Install and configure the cache client
Run the WindowsServerAppFabricSetup_x64_6.1.exe file on the Enterprise Portal server.
On the Feature Selection page, select Cache Client and clear all other options. Click Next.
Cache Client
The client libraries that enable you to use cache functionality in your applications during development or run time. You can install this component even if you are not installing the Caching Services.
Complete the setup wizard.
In Windows explorer, open the c:\inetpub\wwwroot\<Enterprise Portal web app> folder. Locate the web.config file and create a backup of this file in a different location.
Open the web.config file.
Locate the <configSections>. Add the following section tag:
<section name="dataCacheClient" type="Microsoft.ApplicationServer.Caching.DataCacheClientSection, Microsoft.ApplicationServer.Caching.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" allowLocation="true" allowDefinition="Everywhere" />Add the following AppFabric cache client tags to the web.config file after the </configSections>. Replace “Host_server_name” with the name of the name of the server where you installed Windows Server AppFabric. Replace “default” with the name specified when you executed the New-Cache command.
<!-- velocity --> <dataCacheClient> <localCache isEnabled="false" /> <hosts> <!--List of hosts --> <!-- Replace Host_server_name with velocity server name --> <host name="Host_server_name" cachePort="22233" /> </hosts> </dataCacheClient> <Microsoft.Dynamics> <AppFabricCaching CacheName="default" /> </Microsoft.Dynamics> <!-- velocity -->
Required configurations for AppFabric 1.1
If you installed AppFabric 1.1, you must choose Option 1 or Option 2 in this section and perform the procedures for that option. If you installed AppFabric 1.0, you can skip this section.
You must choose one of these options because AppFabric 1.1 DLLs are not stored in the Global Assembly Cache (GAC). If you run Enterprise Portal in an AppFabric 1.1 environment without performing the procedures for Option 1 or Option 2, Enterprise Portal returns an error.
Option 1: Add AppFabric codeBase tags to the web.config file This option is more complex than Option 2, but it reduces overall administration time and troubleshooting because you only have to perform the procedure one time.
Option 2: Copy AppFabric DLLs to the bin folder This option is a simple copy/paste, but if the AppFabric DLLs are ever updated, you must repeat this procedure with the updated AppFabric DLLs. Updated DLLs can include AppFabric hotfixes, updates, or version releases. If you do not repeat this procedure whenever AppFabric DLLs are updated, you might receive errors in Enterprise Portal.
Option 1: Add AppFabric codeBase tags to the web.config file
Use the procedures in this section to add tags to the Enterprise Portal web.config file.
Open the web.config file in Microsoft Visual Studio or a text editor, such as Notepad. By default, the file is located in the following directory on the Enterprise Portal server: C:\inetpub\wwwroot\wss\VirtualDirectories\80\web.config
Add the codebase tag for the following AppFabric DLLs:
Microsoft.ApplicationServer.Caching.Core.dll
Microsoft.ApplicationServer.Caching.Client.dll
Microsoft.WindowsFabric.Common.dll
Microsoft.WindowsFabric.Data.Common.dll
Important
The href attribute for the codeBase tag must specify the location of the AppFabric DLLs. By default, the DLLs are located in the following directory: C:\Program Files\AppFabric 1.1 for Windows Server\.
<runtime> <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1"> … <!-- velocity --> <dependentAssembly> <assemblyIdentity name="Microsoft.ApplicationServer.Caching.Core" publicKeyToken="31bf3856ad364e35" culture="neutral" /> <codeBase version="1.0.0.0" href="C:\Program Files\AppFabric 1.1 for Windows Server\Microsoft.ApplicationServer.Caching.Core.dll"/> </dependentAssembly> <dependentAssembly> <assemblyIdentity name="Microsoft.ApplicationServer.Caching.Client" publicKeyToken="31bf3856ad364e35" culture="neutral" /> <codeBase version="1.0.0.0" href="C:\Program Files\AppFabric 1.1 for Windows Server\Microsoft.ApplicationServer.Caching.Client.dll"/> </dependentAssembly> <dependentAssembly> <assemblyIdentity name="Microsoft.WindowsFabric.Common" publicKeyToken="31bf3856ad364e35" culture="neutral" /> <codeBase version="1.0.0.0" href="C:\Program Files\AppFabric 1.1 for Windows Server\Microsoft.WindowsFabric.Common.dll"/> </dependentAssembly> <dependentAssembly> <assemblyIdentity name="Microsoft.WindowsFabric.Data.Common" publicKeyToken="31bf3856ad364e35" culture="neutral" /> <codeBase version="1.0.0.0" href="C:\Program Files\AppFabric 1.1 for Windows Server\Microsoft.WindowsFabric.Data.Common.dll"/> </dependentAssembly> <!-- velocity --> … </assemblyBinding> </runtime>Search the web.config file for the following tag:
<system.web> <securityPolicy> <trustLevel name="WSS_Medium" policyFile="C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\config\wss_mediumtrust.config" />Open the directory specified in the trustLevel > policyFile section of this tag. For example: C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\config\
Make a copy of the wss_mediumtrust.config file in this directory. Rename the copy as wss_mediumtrust_appfabric.config.
Open the wss_mediumtrust_appfabric.config file.
Search the file for the following tag: class="FirstMatchCodeGroup"
Add the UnionCodeGroup section in a new <CodeGroup section beneath the “FirstMatchCodeGroup” section. Be sure to add it down to the first closing </CodeGroup> tag. The closing tag is not included in the following example:
<CodeGroup class="FirstMatchCodeGroup" version="1" PermissionSetName="Nothing"> <IMembershipCondition class="AllMembershipCondition" version="1" /> <CodeGroup class="UnionCodeGroup" version="1" PermissionSetName="FullTrust"> <IMembershipCondition class="UrlMembershipCondition" version="1" Url="file:///C:/Program Files/AppFabric 1.1 for Windows Server/*" />In the web.config file, search for the <system.web> tag.
Add the following tag in the <securityPolicy> section:
<trustLevel name="WSS_Medium_Custom" policyFile="C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\config\wss_mediumtrust_appfabric.config" />Search the file for the <trust originUrl="" level="WSS_Medium" /> tag.
Change the trust level to “WSS_Medium_Custom”. For example:
<trust originUrl="" level="WSS_Medium_Custom" />Save your changes in the file.
From the Run dialog, type iisreset to restart the web service.
Option 2: Copy AppFabric DLLs to the bin folder
Copy the following files from the C:\Program Files\AppFabric 1.1 for Windows Server directory:
Microsoft.ApplicationServer.Caching.Core.dll
Microsoft.ApplicationServer.Caching.Client.dll
Microsoft.WindowsFabric.Common.dll
Microsoft.WindowsFabric.Data.Common.dll
Paste these files into the following directory: C:\inetpub\wwwroot\wss\VirtualDirectories\80\_app_bin
From the Run dialog, type iisreset and press Enter.
Warning
If the AppFabric 1.1 DLLs are ever updated, for example if AppFabric 1.2 or 2.0 is released, then you must repeat this procedure with the updated DLLs.
Validate deployment
Use the following procedure to verify that the AppFabric cache stores Enterprise Portal session on the server.
On the AppFabric server, verify in the Windows Services console that AppFabricCachingService is running.
Open a Windows PowerShell command prompt as an administrator.
Execute the Get-CacheStatistics default command. The results should display all zeros.
Open Enterprise Portal and submit an Expense report.
Execute the Get-CacheStatistics default command again and verify that the cache displays values. This indicates that cache distribution is working.
Install and configure Windows Server AppFabric in a cluster
Use the following procedures to install Windows Server AppFabric in a cluster and then run the configuration wizard. The installation program provides the following functionality:
Enables you to select specific features to install.
Validates the operating system to make sure that the product is not installed in an unsupported state, and indicates which prerequisites must be installed.
Installs AppFabric.
Enables you to remove specific AppFabric features or AppFabric as a whole, making sure that the computer can be left in a state in which the features or AppFabric can be reinstalled.
Creates the AppFabric Caching Service. Sets the services to a startup type of manual and a status of stopped.
The AppFabric Setup program sets configuration settings in the root (server level) Web.config file, the machine.config file, and the applicationHost.config file. You can configure AppFabric either immediately after installation, or in a separate process. Installing and configuring Windows Server AppFabric on a single server requires that you:
Run Setup
Run the configuration wizard
Configure additional servers in the AppFabric cluster
Configure the cluster cache settings with PowerShell
Install and configure the cache client
Validate deployment
Each of these processes is described in this topic.
Run Setup
Download and run the WindowsServerAppFabricSetup_x64_6.1.exe file on the host server in the cluster.
On the Accept License Terms page, read the license terms, and then accept the terms and then click Next to continue, or do not accept the terms and then exit the setup wizard.
On the Customer Experience Improvement Program page, select Yes to participate in the Customer Experience Improvement program, or No not to participate, and then click Next.
Clear the Yes, download and install critical updates option.
On the Feature Selection page, select Caching Services and Cache Administration, and then click Next.
Caching Services
The distributed Caching Service and related components that enable you to prepare this host as a Caching Service, turning the server into the node of a cluster. You can create a new cluster or join this host to an existing cluster by using the Caching Service.
Cache Administration
Components that enable you to administer a cache cluster. You can select Cache Administration as an independent component, without other features selected. In that instance, you could use administration tools to administer the Caching Service installed on a separate computer.
Note
If prerequisite software must be installed, the setup wizard will display the Platform Validation page after the Feature Selection page. You must install the missing prerequisites manually. If all prerequisites have already been installed, the setup wizard will continue to the Confirm Installation Selections page.
On the Platform Validation page, review the information and download any prerequisite software. Click the link for a component or a configuration issue for more information. After installing components and resolving issues, click Refresh to verify that the problem has been fixed and then click Next to continue with the setup wizard.
The Confirm Installation Selections page will display a list of the features that were selected in the Feature Selection page, and will be installed. It displays a list of the required Windows components and the AppFabric features that will be installed. Verify that the lists are correct, and then click Install to begin installation.
Note
The Application Server role is required for AppFabric. This role will be included in the list of the required Windows components even if it is already installed, and the installation wizard will verify that it has been installed.
On the Installation Progress page, you can monitor the progress of the installation.
On the Installation Results page, verify that the installation has succeeded. To display a list of recommended updates that you can install, click the Recommended Updates link. To run the configuration wizard, select the Launch configuration tool check box, and then click Finish to complete the installation wizard. Click Detailed Installation report to display a log of setup events.
Run the configuration wizard
This section describes recommended settings for Windows Server AppFabric with Enterprise Portal. The following table lists settings as they appear in the Windows Server AppFabric Configuration Wizard. For more information about the options or settings in the configuration wizard, see Configure Windows Server AppFabric.
Configuring Caching service parameters |
Suggested settings |
|---|---|
Set Caching Service configuration |
Select this option |
Caching Service configuration provider |
SQL Server AppFabric Caching Service Configuration Store Provider |
New cluster |
Select this option |
Cluster size |
Select an option |
Click Next to view the next page of the wizard.
Specify settings to create and register an AppFabric Caching Service configuration database that uses the Microsoft SQL Server provider |
Suggested settings |
|---|---|
Register AppFabric Caching Service configuration database |
Select this option |
Create AppFabric Caching Service configuration database |
Select this option |
Enter required information in the Server and Database fields and then click OK.
Configure AppFabric Cache Node |
Suggested settings |
|---|---|
Node ports |
Retain default settings |
Windows firewall exceptions |
Select Windows Server AppFabric: AppFabric Caching Service |
When prompted, click Yes.
Configure additional servers in the AppFabric cluster
On each server in the cluster, repeat the procedures that are described in this section for running Setup and running the configuration wizard. In the configuration wizard, you must select the following options
Configuring Caching service parameters |
Suggested settings |
|---|---|
Set Caching Service configuration |
Select this option |
Caching Service configuration provider |
SQL Server AppFabric Caching Service Configuration Store Provider |
Join cluster |
Select this option |
Click Next to view the next page of the wizard.
Specify settings to create and register an AppFabric Caching Service configuration database that uses the Microsoft SQL Server provider |
Suggested settings |
|---|---|
Register AppFabric Caching Service configuration database |
Select this option |
Create AppFabric Caching Service configuration database |
Clear this option |
Enter the same information that you previously specified in the Server and Database fields and then click OK.
Configure the cluster cache settings with PowerShell
The procedure in this section uses PowerShell Cmdlts to complete the process of configuring the cache. For more information, about these cmdlts, see AppFabric Caching PowerShell Cmdlts on MSDN.
Open a Windows PowerShell command prompt as an administrator.
Execute the Use-CacheCluster command to set the context of your PowerShell session to a particular cache cluster.
Execute the New-Cache command to create a new named cache. Make a note of the name you specified. You will enter this cache name in the next procedure.
Execute the Grant-CacheAllowedClientAccount command and specify the .NET Business Connector proxy (the account that is used by the Enterprise Portal application pool).
Execute the Set-CacheConfig command and specify –Secondaries parameter
Export the configuration with this command: Export-CacheClusterConfig and specify a name for the file.
Open the file that you just created and add the following configuration to the <advancedProperties> section:
<transportProperties maxBufferSize="1000000000" />
Import the configuration with this command: Import-CacheClusterConfig
Execute the Start-CacheCluster command to start the cache.
Install and configure the cache client
Run the WindowsServerAppFabricSetup_x64_6.1.exe file on the Enterprise Portal server.
On the Feature Selection page, select Cache Client and clear all other options. Click Next.
Cache Client
The client libraries that enable you to use cache functionality in your applications during development or run time. You can install this component even if you are not installing the Caching Services.
Complete the setup wizard.
In Windows explorer, open the $\inetpub\wwwroot\ folder. Locate the web.config file and create a backup of this file in a different location.
Open the web.config file.
Locate the <configSections>. Add the following section tag:
<configSections> <!-- velocity --> <section name="dataCacheClient" type="Microsoft.ApplicationServer.Caching.DataCacheClientSection; Microsoft.ApplicationServer.Caching.Core, Version=1.0.0.0; Culture=neutral, PublicKeyToken=31bf3856ad364e35" allowLocation="true" allowDefinition="Everywhere" /> <sectionGroup name="Microsoft.Dynamics"> <section name="Session" type="System.Configuration.SingleTagSectionHandler, System, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" /> <section name="ServerState" type="System.Configuration.SingleTagSectionHandler, System, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" /> <section name="AppFabricCaching" type="System.Configuration.SingleTagSectionHandler, System, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" /> </sectionGroup> <!-- velocity -->Add the following dataCacheClient tag to the web.config file after the </configSections>. Replace each instance of “Host_server_name” with the name of a server. Replace “default” with the name specified when you executed the New-Cache command.
<!-- velocity --> <dataCacheClient> <localCache isEnabled="false" /> <hosts> <!--List of hosts --> <!-- Replace Host_server_name with velocity server name --> <host name="Host_server_name1" cachePort="22233" /> <host name="Host_server_name2" cachePort="22233" /> <host name="Host_server_name3" cachePort="22233" /> </hosts> </dataCacheClient> <Microsoft.Dynamics> <AppFabricCaching CacheName="default" /> </Microsoft.Dynamics> <!-- velocity -->
Validate deployment
Use the following procedure to verify that the AppFabric cache stores Enterprise Portal session on the server.
On the AppFabric server, verify in the Windows Services console that AppFabricCachingService is running.
Open a Windows PowerShell command prompt as an administrator.
Execute the Get-CacheStatistics default command. The results should display all zeros.
Restart the web service on the Enterprise Portal server.
Open Enterprise Portal and submit an Expense report.
Execute the Get-CacheStatistics default command again and verify that the cache displays values. This indicates that cache distribution is working.