Requirement to Install and Deploy on Central Administration Server with SharePoint Foundation Web Application Service Started

Due to the extensive amount of integration needed to transform SharePoint into an industrial-strength extranet platform, ExCM has been built as a custom SharePoint Farm Solution.  SharePoint Farm Solutions offer the broadest and deepest range of development options when it comes to extending out-of-the-box SharePoint.

 

Farm Solutions that you have installed in your SharePoint Farm can be viewed on the Solution Management page in Central Administration (Central Administration > System Settings > Farm Management > Manage Farm Solutions) :

 

Extranet Collaboration Manager in Solution Management

 

Like most custom SharePoint Farm solutions, ExCM consists of many different custom components that are added to your farm to enable its functionality.

 

The types of components that ExCM deploys to your SharePoint farm includes:

 

 

The deployment of these components (or copying them out to each server in the farm) is handled by SharePoint's native Farm Solution Deployment Timer Job.  When you deploy a custom Farm Solution to your farm, this Timer Job unpacks the Farm Solutions file (which is a .wsp file, and essentially is just a cabinet file) and reads the contained "manifest.xml" file to know where to deploy each of the components in your farm.

 

Microsoft has designed the Farm Solution Deployment Timer Job to deploy the components of a custom Farm Solution ONLY to servers in your farm that have the Microsoft SharePoint Foundation Web Application service started:

 

SharePoint Foundation Web Application in Services on Server

 

 

If a server in your farm has the Microsoft SharePoint Foundation Web Application service stopped, the Farm Solution Deployment Timer Job will bypass that server.  

 

Also, if you "stop" the Microsoft SharePoint Foundation Web Application sevice on a server, any custom Farm Solution files that have previously been deployed to that server will be automatically undeployed from that server by SharePoint's Farm Solution Deployment Timer Job.  So, you can't start the service in order to deploy a custome Farm Solution to a server and then stop it because you don't want the service running on that server.  If you do that, your custom Farm solution will disappear from that server.

 

Therefore, since ExCM adds new components to Central Administration (see in the list above) the only way that those components will ever be successfully deployed to Central Administration is if one of these conditions are true:

 

  1. Your Central Administration website is hosted on one of your Web Front-end (WFE) servers (by default WFE servers will have the Microsoft SharePoint Foundation Web Application service started), 

OR,

 

  1.  If your Central Administration website in not hosted on a WFE (or can't be moved to a WFE), you have the Microsoft SharePoint Foundation Web Application service started on the Central Administration server.

 

Key Point:  Either way, for the above reasons, ExCM requires that you install and deploy it on the server in your farm that is running the Central Administration website AND that the Microsoft SharePoint Foundation Web Application service is started on that server.  To meet this requirement, you can either A) make sure that the Central Administration website is running on a WFE, or B) you can make sure that the Microsoft SharePoint Foundation Web Application service is started on the CA server if it is not a WFE.

In some documentation on TechNet for SharePoint, Microsoft advocates not running Central Administration on a WFE and not starting the Microsoft SharePoint Foundation Web Application service on the CA server.  Unfortunately, that guidance will not work in a scenario where you need to deploy a custom Farm Solution that installs custom components into Central Administration.

 

Microsoft acknowledges this fact in this text on another TechNet page titled "Plan service deployment in SharePoint":

 

Microsoft SharePoint custom Farm Solution requirements

Microsoft SharePoint custom Farm Solution requirements

 

 

Here some other articles on the web that discuss Farm Solution deployment and this particular issue in more detail:

 

By a well-respected SharePoint consultant:

 

http://nikpatel.net/2012/02/24/deactivate-sharepoint-foundation-web-application-service-on-central-admin-or-deploy-custom-solutions-from-central-admin/

 

By a well-known Microsoft engineer (this article is not specifically about this particular case, but points out the root cause of the issue - which is the SharePoint out-of-the-box Farm Solution deployment architecture):

 

https://samlman.wordpress.com/2015/03/01/beware-of-default-solution-deployments-for-custom-claims-providers-in-sharepoint-2010/

 

Finally, in SharePoint 2016 & 2019, it is notable that Microsoft automatically starts the SharePoint Foundation Web Application service on ALL servers in a SharePoint Farm that is managed by the new MinRole feature.  See these pages on TechNet for more details:

 

Overview of MinRole Server Roles in SharePoint Server

 

Description of MinRole and Associated Services in SharePoint Server

 

 

©2019 PremierPoint Solutions. All Rights Reserved. 

 

 

Create your own Knowledge Base