Value writers

Abstract

Guide to how Sitecore Data Exchange Framework uses value writers to implement how to write values to an object.

A value writer is like a property setter method on a .NET class. It provides the implementation of the logic needed to write a value to an object.

Data Exchange Framework (DEF) comes with a set of standard value writers that can be used to configure various aspects of a synchronization process. The template for the generic value writer is located at /sitecore/templates/Data Exchange/Framework/Data Access/Value Writers/Value Writer.

You can install optional providers that include value writers designed specifically for the system the provider integrates.

Configuration

It is rare for the generic value writer to be used. In most cases, a specific type of value writer is used (for example, one that can set a property on an object). The configuration of any specific value writer depends on its type.

For information on the specific value writers in DEF and optional providers, please refer to the following list:

When to extend

You might need to design a custom value writer in the following cases:

  • if you are building a custom provider that involves working with a 3rd party API

  • if you want to simplify a configuration by encapsulating complex logic in a single value writer.