The tenant service

Abstract

Overview of the tenant service that models synchronization processes in the Sitecore Data Exchange Framework.

The Data Exchange Framework Tenant Service (TS) models processes that can synchronize data between multiple systems. This guide covers how the TS works and how to use it.

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

  • Sitecore Data Exchange Framework. This includes the TS functionality.

  • Data Exchange Framework Tenant Web Service

These requirements are covered by the Installation Guide for Data Exchange Framework and the Installation Guide for Data Exchange Tenant Web Service, which you can download from the Sitecore download site.

The TS is an extension to the Data Exchange Framework (DEF). It facilitates the transfer of data between two systems:

  • The source system sends a request to a TS.

  • The target system receives the data.

Typically, one of the systems is Sitecore. However, the TS can be used to transfer data between any two systems.

The TS is a web-based API that works in a listener mode and allows third-party systems to push data into Sitecore. The TS listens for requests from a third-party system, whereas the DEF pipeline batches read data from the third-party system and push the data to the target system. 

For example, you can use the TS to handle the following:

Request

Source

Target

Create contact

CRM

Sitecore

Trigger goal

PIM

Sitecore

Submit form button

Sitecore Forms

CRM