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.
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:
Using PowerShell and Sitecore Installation Framework
After installing TWS, either manually or with PowerShell, you must configure the Tenant Service (TS) connection strings.
For information on how to configure a tenant when you have installed the service, refer to the .
The topic assumes that you have installed the following on your Sitecore server:
DEF 8.0.0. This installation includes the basic Tenant Service functionality. This requirement is covered by Installing Data Exchange Framework.
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.
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.
To install the TWS manually:
Sitecore Data Exchange Framework Tenant Web Servicepackage from the Sitecore Downloads page. It contains the
Sitecore Data Exchange Framework Tenant Web Service 8.0.0.scwdp.zipfile.
.zipfile 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,
Configure a TS connection string.
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.
Install using PowerShell and Sitecore Installation Framework
To install TWS using SIF installation files and PowerShell:
Sitecore Data Exchange Framework Tenant Web Servicepackage from the Sitecore download page.
SIF installation scripts for Tenant Servicepackage from the Sitecore download page. It contains the following files:
tenantservice-xp0.json- an installation configuration file.
createcert.json- an installation configuration file.
deploy.ps1- a PowerShell deployment script.
Unzip the installation script files to a folder on your installation.Note
deploy.ps1script contains a
SitecoreTenantIDparameter 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.ps1script and change the
SitecoreTenantIDparameter to the Tenant ID of the Tenant Service. You can also add or change the
Open a PowerShell console with administrator rights. Navigate to the folder where you unpacked the installation script files. Run the
deploy.ps1script with the following syntax:RequestResponseshell
.\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:
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.
The location of the
Sitecore Data Exchange Framework Tenant Web Servicepackage.
Configure the necessary connection strings.