Install the Tenant Web Service
Guide to installing the Tenant Web Service for Data Exchange Framework to enable the Tenant 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.
Note
For information on how to configure a tenant when you have installed the service, refer to the developer documentation.
The topic assumes that you have installed the following on your Sitecore server:
Sitecore 10.2
DEF 7.0.0. This installation includes the basic Tenant Service functionality. This requirement is covered by 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.
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.
To install the TWS manually:
Download the
Sitecore Data Exchange Framework Tenant Web Service
package from the Sitecore Downloads page. It contains theSitecore Data Exchange Framework Tenant Web Service 7.0.0.scwdp.zip
file.Extract the
.zip
file into the website IIS root folder. By default, this folder is located atC:\inetpub\wwwroot\<service folder>
, where<service folder>
is the name you choose for your tenant, for example,my-tenant.service
.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.
To install TWS using SIF installation files and PowerShell:
Download the
Sitecore Data Exchange Framework Tenant Web Service
package from the Sitecore download page.Download the
SIF installation scripts for Tenant Service
package 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
The
deploy.ps1
script contains aSitecoreTenantID
parameter that is used to create the necessary connection string for the Tenant Service. If you already have a Tenant Service, you can edit thedeploy.ps1
script and change theSitecoreTenantID
parameter to the Tenant ID of the Tenant Service. You can also add or change theSitecoreTenantID
in theconnectionstrings.config
file later.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:.\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
Configure the necessary connection strings.