---
title: "Install the Tenant Web Service"
slug: "install-the-tenant-web-service"
abstract: "Guide to installing the Tenant Web Service for Data Exchange Framework to enable the Tenant Service."
---
# Install the Tenant Web Service

The Data Exchange Framework (DEF) Tenant Web Service (TWS) enables you to use the Tenant Service to trigger data synchronization processes through web-based push notifications.

> [!note]
> TWS is only required if you want the Tenant Service functionality.

TWS is a web-based service and must be configured as a web site via IIS. There are two alternative ways of installing TWS:

- Manually
- Using PowerShell and Sitecore Installation Framework

After installing TWS, either manually or with PowerShell, you must configure the Tenant Service (TS) [connection strings](https://doc.sitecore.com/xp/en/developers/def/80/data-exchange-framework/configure-tenant-service-connection-strings.html "Configure Tenant Service connection strings").

> [!note]
> For information on how to configure a tenant when you have installed the service, refer to the .

<details>
<summary><h2>Requirements</h2></summary>

The topic assumes that you have installed the following on your Sitecore server:

- Sitecore 10.3
- DEF 8.0.0. This installation includes the basic Tenant Service functionality. This requirement is covered by [Installing Data Exchange Framework](https://doc.sitecore.com/xp/en/developers/def/80/data-exchange-framework/installing-data-exchange-framework.html "Installing Data Exchange Framework").

> [!note]
> You can confirm that the Tenant Service functionality is installed by opening the Content Editor and locating the */sitecore/templates/Data Exchange/Services/Tenant Service* item.

</details>

<details>
<summary><h2>Install manually</h2></summary>

> [!note]
> For information on how to create certificates, refer to the Set Up Client Certificates section of the Sitecore Experience Platform Installation Guide, available from the [Sitecore Downloads page](https://dev.sitecore.net/Downloads/Sitecore_Experience_Platform.aspx).

To install the TWS manually:

1. Download the `Sitecore Data Exchange Framework Tenant Web Service` package from the [Sitecore Downloads page](https://dev.sitecore.net/Downloads/Data_Exchange_Framework.aspx). It contains the `Sitecore Data Exchange Framework Tenant Web Service 8.0.0.scwdp.zip` file.
2. Extract the `.zip` file into the website IIS root folder. By default, this folder is located at `C:\inetpub\wwwroot\<service folder>`, where `<service folder>` is the name you choose for your tenant, for example, `my-tenant.service`.
3. Configure a [TS connection string](https://doc.sitecore.com/xp/en/developers/def/80/data-exchange-framework/configure-tenant-service-connection-strings.html "Configure Tenant Service connection strings").
4. Create and start the site in IIS. 

    > [!note]
    > When a TWS is set up as described above, you can access it by requesting the `http://[tenantservice]` URL. If the service is running successfully, you get a response showing the date and time.

</details>

<details>
<summary><h2>Install using PowerShell and Sitecore Installation Framework</h2></summary>

To install TWS using SIF installation files and PowerShell:

1. Download the `Sitecore Data Exchange Framework Tenant Web Service`  package from the [Sitecore download page](https://dev.sitecore.net/Downloads/Data_Exchange_Framework.aspx).
2. Download the `SIF installation scripts for Tenant Service` package from the [Sitecore download page](https://dev.sitecore.net/Downloads/Data_Exchange_Framework.aspx). It contains the following files:
    - `tenantservice-xp0.json` - an installation configuration file.
    - `createcert.json` - an installation configuration file.
    - `deploy.ps1` - a PowerShell deployment script.
3. Unzip the installation script files to a folder on your installation.

    > [!note]
    > The `deploy.ps1` script contains a `SitecoreTenantID` parameter that is used to create the necessary connection string for the Tenant Service. If you already have a Tenant Service, you can edit the `deploy.ps1` script and change the `SitecoreTenantID` parameter to the Tenant ID of the Tenant Service. You can also add or change the `SitecoreTenantID` in the `connectionstrings.config` file later.

4. Open a PowerShell console with administrator rights. Navigate to the folder where you unpacked the installation script files. Run the `deploy.ps1` script with the following syntax:

    ```text
    .\deploy.ps1 -scInstanceName "<sitecore instance>" -servicePackage "<path to tenantservice.scwdp.zip file>"
    ```

    The following table explains the parameters you must supply when running the script:

    | Parameter | Description | Example |
    | --- | --- | --- |
    | scInstanceName | The name of your Sitecore instance. The script automatically names the Tenant Service instance `<scInstanceName>.service`. If you want to give the Tenant Service a different name, you must use the manual installation procedure. | my-sitecore |
    | servicePackage | The location of the `Sitecore Data Exchange Framework Tenant Web Service` package. | `c:\tenant-scwdp.zip` |

5. Configure the necessary [connection strings](https://doc.sitecore.com/xp/en/developers/def/80/data-exchange-framework/configure-tenant-service-connection-strings.html "Configure Tenant Service connection strings").

</details>