Administering the Service Components

Once you have deployed the solution, you can administer the major components of the service application using Central Administration (see the topic on PowerShell administration as well).

Part of the Service Application Starter Kit includes a Farm Scoped feature for administration of the core service components:

 farm scoped feature

Once the Farm feature is activated (it is activated by default when the solution is deployed), a custom action link will appear on the Application Management page in Central Administration, with a link to Manage Service:


Clicking the Manage Service link will bring you to a custom page to manage the Service, Service Proxy, and Service Instances. 

Install/Uninstall the Service and Service Proxy

The Service and ServiceProxy components of a service application are not normally exposed anywhere in the UI of SharePoint, and for out-of-box SharePoint services, it is just assumed that these pieces have already been installed on the farm via the initial setup or through a service pack or cumulative update. The Manage Service page of the Service Application Starter Kit gives visibility to these components for a custom service application, so that you can have fine grained control over these elements and view the current status.

Initially, neither the Service, ServiceProxy, or ServiceInstances are installed or provisioned when you deploy a project from the Service Application Starter Kit:

service not installed

To install the Service and ServiceProxy, click the Install button. If successful, you should see the status update accordingly.

service installed

To uninstall the Service and Service Proxy, click the Remove button. Note that uninstalling here will also uninstall any Service Instances, Service Applications, and Service Application Proxies. A confirmation dialog will prompt an administrator of this before performing the uninstallation:

service removal confirmation

Install/Start/Uninstall the Service Instances

Once you have installed the Service and Service Proxy, the Manage Service page will present a section displaying the current Service Instance statuses. Installing the Service and Service Proxy will also install the Service Instances to all the available servers in the farm (the Service Instances will all be in the Stopped state).

service instance status

Next to each server is the Manage link, which will take you to the Services on Server page for that particular server, where you can then Start the service instance.

The service instance on the services on server screen

Service Instance started

On the Services on Server page, the Service Instance name is a clickable hyperlink, which points back to the Manage Service page.

NOTE: You MUST restart the SharePoint Timer Service on non-local servers before starting the service instances on those servers. If you fail to restart the Timer service, your service instance will get stuck in the Starting state. For example, if you are on a server named SPServer01, and you start the service instance on that server, the service instance will start properly, but if you change the server or attempt to start the service instance on another server, the Timer service will not have your DLL in memory when it attempts to provision the service instance via timer job.

Once the Service Instances are installed on the servers in your farm, what happens if you ever add other servers later? Unlike the out-of-box services (which have the Products and technologies Configuration wizard to ensure that all service instances are installed on the new server), a custom service application has no such automation to install the Service Instance on the new server. This is why the Service Application Starter Kit includes an Install to New Servers button in the Service Instance Status section. Clicking this button will install the service instance on any servers in the farm that do not already have the Service Instance installed.

To uninstall the Service Instances, click the Remove button in the Service Status section. Removing the Service and Service Proxy will also remove the Service Instances from the farm.

Last edited Feb 19, 2013 at 7:35 PM by adamtoth, version 4


No comments yet.