Create or Edit Syndication Templates - EnterWorks - EnterWorks Process Exchange (EPX) - Precisely EnterWorks - 10.5

EnterWorks Classic Administration Guide

Product type
Software
Portfolio
Verify
Product family
EnterWorks
Product
Precisely EnterWorks > EnterWorks
Precisely EnterWorks
Precisely EnterWorks > EnterWorks Process Exchange (EPX)
Version
10.5
Language
English
Product name
Precisely EnterWorks
Title
EnterWorks Classic Administration Guide
Topic type
Administration
Configuration
First publish date
2007

Syndication templates are viewed, defined, and edited in the EnterWorks Classic UI, in the same manner in which Export templates are created, with the exception that the only available output formats are CSV, XLS, and XLSX.

To create or edit a syndication template:

  1. Open the Syndication Templates list.

NOTE: The Syndication Template list can be filtered by entering text into the Name, Root Repository, and/or Type fields at the top of the Exchange Template tab. Once you have entered the text you want to use for a filter, click the Apply button.

  1. The Action drop-down menu contains:

    1. New: Select to create a new template.

    2. Edit: Select to edit the selected templates.

    3. Edit Mappings: Select to define new attribute mappings or to edit existing mappings.

    4. Delete: Select to delete the selected template.

  2. The Utilities drop-down menu:

This option provides the ability to Import an existing template or to Export an existing template, if required. These options are used to move import or export templates from one environment to another, such as, exporting a template from the Development environment and importing it into the QA environment.

  1. Select the New option under the Action drop-down list.

  2. The Syndication Template Editor screen is then shown.

  1. Name: (Required; Multi-language) A name for the Syndication Template.

  2. Description: (Optional; Multi-language) A description for the template.

  3. Select the Output Type from the drop-down list. The options are:

    1. XLS

    2. XLSX

    3. CSV (common separated values)

  4. Validation Level: (Optional) Select the minimum validation level that records must meet to be included.

  5. Root Repository: Select the root repository from the drop-down list.

  6. Available Link Relationships: Click the Edit button to select linked repositories that have attributes you want to include in the template. The Edit Included Links of Template editor will appear.

  7. Use the + and buttons to the left of a repository’s name to show or hide that repository’s child repositories. Select the repositories you would like to include. In order to select a child repository, its parent repository must be selected.

  1. Click the Edit Details button to optionally identify that all or some of the dynamic (category) attributes should be appended to end of the export file in key value pair columnar format.

  • Include All Category Attributes: All category attributes will be included.

  • Include Some Category Attributes: You can how many attributes to include.

  1. Click the Save button (above) to go back to the Syndication Template Editor links:

  2. Click Return to go back to the Syndication Template Editor:

  3. EnterWorks can create an output file for each Taxonomy node rather than putting all the content in one output file. Each file will contain the specified global attributes plus the node’s category attributes. To do so, click the Edit button next to the Split File Control label. An editor window will appear. Select Split File Indicator, the repository, and the Taxonomy control attribute. These values may already be filled in for you.

  1. Click the Save button to go back to the Syndication Template Editor.

  2. Use the Advanced Call Out Function and Advanced Call Out Class Path for export file transformations (optional).

  3. Click the Save button to save your changes, then close the window to go back to the Syndication Template list.

  4. Select the Syndication Template that was just created.

  5. Select the Edit Mappings option from the Action drop-down list to define (or modify) the export file and identify where the data for the export is coming from in EnterWorks. The Syndication Template Mapping Editor will appear.

  6. Select the New option from the Action drop-down list to define a new column mapping.

  7. The Create New Syndication Template Mapping screen is shown.

  1. Enter the export column name in the Display name field.

  2. Check the Required Indicator checkbox, if applicable. This indicates that the attribute must have a value to output to the output file. If a value is not present, the record will be exported to the error output file. This setting is useful if an attribute is required by an outside syndication target but it is not required internally to EnterWorks.

  3. Select the Repository that contains the field to export.

  4. Select the Catalog Node that contains dynamic attributes, if applicable. Click the magnifying glass to show a list of nodes:

  1. The list can be filtered by using the Filter field below the attribute list.

  2. The Mapping editor allows you to build the VTL (Velocity Template Language) formula that will be used to create the attribute’s output. Select the source attribute (field) that will populate the target column. The field will be displayed in the Mapping editor.

For more information about VTL, see the EnterWorks Advanced VTL Mapping Guide at https://help.precisely.com.

Note: To concatenate fields together, choose multiple fields to include in the Mapping window, then add any separation characters, if required. The fields can be reordered within the window.

  1. Click the Preview tab to see what the mapping will look like. Use the fields on the bottom to enter test data into the fields.

  1. Click the Builder tab and click the Save button to go back to the Syndication Template Editor screen.

  1. One or more existing mapping items can be edited, copied, or deleted by selecting one or more mapping line items and selecting the desired action from the Action drop-down menu.

  2. To reorder the fields in the export template, select the Set Sequence option from the Action drop-down list. A window will appear that lets you reorder the fields.

  1. Drag and drop the fields to set the order of the fields in the export file.

  2. Click the Ok button.