Product Documentation

Install the SharePoint 2013 web service

Jun 05, 2015
Updated: 2014-08-15

Install the SharePoint 2013 web service on the SharePoint 2013 front-end web servers in your environment.

You can install the SharePoint 2013 web service using the graphical interface of the Services Manager Setup Tool or through the command line. After the installation process is finished, you can enable the service and continue configuration through the control panel.

To install the SharePoint 2013 web service using the graphical interface

The installation process includes preliminary configuration to create the web service account and IIS application pool, and define the service port.

This task assumes the Services Manager installer is running and the Select Deployment Task page is displayed.

  1. On the Select Deployment Task page, select Install CloudPortal Services Manager.
  2. On the Install CloudPortal Services Manager page, select Add Services.
  3. On the Add Services page, select Install Services.
  4. Accept the License Agreement and then click Next.
  5. On the Select Web Services page, select SharePoint 2013 Web Service. Click Next.
  6. On the Review Prerequisites page, review the list of software that will be installed to support the web service and then click Next.
  7. On the Ready to Install page, click Install.
  8. After the installation finishes, click Finish.
  9. On the Add Services page, select Configure Services.
  10. On the Installed Services page, click Configure next to the SharePoint 2013 Web Service item. The Configuration Tool attempts to contact the Encryption Service to retrieve the encrypted key. If the service cannot be contacted, the Configuration Tool prompts you to import the encrypted key using a key file. To generate the key file, see Generate and export keyfiles for the Encryption Service.
  11. If required, import the Encryption Service key file:
    1. In Key File Path, click Browse and locate the key file you generated from the Encryption Service web site.
    2. In Password, enter the password that was specified when the key file was generated. Click Next.
  12. On the Configure IIS page, enter the following information and then click Next:
    • Auto-generate credentials: Select this check box to allow the Configuration Tool to generate service account credentials automatically.
    • User name: Enter a user name for the SharePoint web service account. The default user name is csm_sp2013_svc. This field is unavailable when you elect to auto-generate credentials.
    • Password: Enter a password for the SharePoint web service account. This field is unavailable when you elect to auto-generate credentials.
    • Create if doesn't exist: Leave this check box selected to allow the web service account to be created if it does not already exist in Active Directory.
    • Service port: Enter the port used by the SharePoint web service. The default port is 8095.
  13. On the Summary page, review the configuration information. If you want to change anything, return to the appropriate configuration page. When the summary contains the settings you want, click Next. The Configuration Tool configures the SharePoint web service, imports the Encryption Service key, and displays progress.
  14. Click Finish and then click Exit to close the Configuration Tool.

After you install the web service, continue the configuration using the Services Manager control panel. For more information, see Configure the SharePoint 2013 service.

To install the SharePoint 2013 web service using the command line

When you install the SharePoint 2013 web service from the command line, you perform two actions:
  • Install the web service and create the required Services Manager directory where the web service resides.
  • Perform initial configuration of the web service using the Configuration Tool.
  1. On the SharePoint 2013 server, log on as an administrator.
  2. Open a command line window and navigate to the CortexSetup directory on the Services Manager installation media.
  3. At the command prompt, enter CortexSetupConsole.exe /Install:SharePoint2013. The Setup Tool installs the web service and returns the command prompt.
  4. At the command prompt, enter install-locationServicesSharePoint2013ConfigurationSharePointConfigConsole.exe and specify the following properties:
    Property Description
    /UserName:username The application pool ID. Usually, this is the SharePoint administrator user. This parameter is optional if you are using /GenerateCredentials.
    /Password:password The application pool password. This parameter is optional if you are using /GenerateCredentials.
    /ServicePort:port Inbound port to be used and added to the CortexServices web site. Default = 8095
    /AutoCreateUser:True | False Optional. Create the service account in Active Directory.
    /GenerateCredentials:True | False Optional. Generate the password for the service account.

    Install-location denotes the web service installation directory on the local computer. The default directory is C:Program Files (x86)CitrixCortex.

    The Configuration Tool performs initial configuration of the web service and returns the command prompt.

Sample command string

The following command performs the initial configuration of the web service.
install-locationServicesSharePoint2013ConfigurationSharePointConfigConsole.exe
 /UserName:shpt_svc_acct /Password:password /ServicePort:8095

When the installation process is finished, configure the SharePoint 2013 service through the Services Manager control panel. For instructions, see Configure the SharePoint 2013 service.