Create a template for a pipeline step

Abstract

How to specify which endpoint to read from by creating a pipeline step template in Sitecore Data Exchange Framework.

In this example, a pipeline step is used to read data from a text file. A template is needed to allow a user to specify which text file (endpoint) to read from.

Create a template

To create a template:

  1. In Sitecore Content Editor, navigate to Templates.

  2. In the menu ribbon, on the Home tab, in the Insert box, click New Template to add a new template.

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

    Field

    Value

    Name

    Read Text File Pipeline Step

    Base template

    Templates/Data Exchange/Framework/Pipeline Steps/Base Pipeline Steps/Base Pipeline Step

  4. Click Next.

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

  6. On the confirmation dialog, click Close.

Set an icon

To set an icon:

  1. In the Content Editor, in the content tree, select the new template.

    new-template-selected2.png
  2. Click the Content tab.

  3. Click the icon next to the title.

    icon2.png
  4. In the Change Icon dialog, in the Icon field, enter Office/32x32/element.png

  5. Click OK.

Add fields

To add fields:

  1. In the content tree, select the pipeline step template. Add a template section, and name it Endpoints.

  2. In Endpoints, add a template field, and name it EndpointFrom. Fill in the following fields:

    Field

    Value

    Name

    EndpointFrom

    Type

    Droptree

    Source

    query:./ancestor-or-self::*[@@templateid='{327A381B-59F8-4E88-B331-BEBC7BD87E4E}']//descendant-or-self::*[@@templateid='TEMPLATE-ID']

    Shared

    selected

    Important

    In the Source field, you must replace TEMPLATE-ID with the Item ID for the template named File System Endpoints Root. This template represents the folder used to store endpoint items for your provider.

    This template was created automatically when you used the Data Exchange Framework SDK to create the provider. The template is located at sitecore/templates/Data Exchange/Providers/File System/Folders/File System Endpoints Root. You can find the ID on the Content tab.

    The query in the Source field limits the droptree to the endpoints in the current tenant that are in the folder used to organize endpoints for this provider.

    The ID {327A381B-59F8-4E88-B331-BEBC7BD87E4E} is for the tenant template that is provided with the framework. You must not change this value.

  3. Select the Shared check box. Save the item.

    Note

    When you save the item, a message tells you that the item contains broken links. This is expected behavior related to the expression set in step 2. Click OK to continue.

    Broken links message