Create a template for an endpoint

Abstract

How to create a template for an endpoint in Sitecore Data Exchange Framework.

Data synchronization processes are modeled using the Sitecore Content Editor. This lets people use a familiar interface for doing the configuration.

This configuration requires a template that you can use to represent a text file that Sitecore can read from.

Create a template

To create a template:

  1. In Sitecore Content Editor, navigate to Templates.

  2. In the menu ribbon, click New Template to add a new template.

    New template option in menu ribbon
  3. Enter the following values:

    Field

    Value

    Name

    Text File Endpoint

    Base template

    Templates/Data Exchange Framework/Endpoints/Base Template/ Base Endpoint

  4. Click Next.

  5. In the Location dialog, select Templates/Data Exchange/Providers/File System/Endpoints. Click Next.

  6. In the confirmation dialog, click Close.

Set an icon

To set an icon:

  1. In the Content Editor, select the new template.

    Text File Endpoint template in content tree
  2. On the right side of the window, click the Content tab.

  3. On the Content tab, click the icon next to the title.

    Title icon
  4. In the Change Icon dialog, in the Icon field, enter Office/32x32/cloud.png

  5. Click OK.

Add fields

In the text file endpoint, you must configure the settings that tell Sitecore how to parse the text file. For example, you can specify if data is on a single line or multiple lines, which column seperator the file uses, and whether the file contains a line with column headers.

To add these settings:

  1. Navigate to Data Exchange/Providers/File System/Endpoints/Text File Endpoint.

  2. Add a template section. Name it Settings.

  3. On the Builder tab, in the Settings section, add the following template fields:

    Name

    Type

    Shared

    Path

    Single-Line Text

    selected

    ColumnSeparator

    Single-Line Text

    selected

    ColumnHeadersInFirstLine

    Checkbox

    selected

  4. Save the item.