Value accessors

Abstract

Guide to the value accessor in Sitecore Data Exchange Framework.

A value accessor is like a property on a .NET class. It provides the ability to read and/or write a value.

Data Exchange Framework (DEF) comes with a set of standard value accessors that can be used to configure data mapping, along with various aspects of a synchronization process. The template for the generic value writer is located at /sitecore/templates/Data Exchange/Framework/Data Access/Value Accessors/Value Accessor.

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

Configuration

You usually use a specific type of value accessor instead of the generic value accessor. A specific value accessor might be, for example, one that represents a property on an object. The configuration of any specific value accessor depends on its type.

However, all value accessors inherit the following fields. When these fields are used, they override the default behavior of the value accessor.

Field

Description

Value Reader

The value reader that is returned when the value reader is requested from the value accessor.

Value Writer

The value writer that is returned when the value writer is requested from the value accessor.

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

When to extend

You might need to design a custom value accessor 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 accessor.