General tab page for output

The General tab is the default tab when the Output tab is selected. The General tab contains three individual sections that can be configured: Template library, Receivers, and Digital Catalog filter search.

Template library

The Template library is the section where Excel or Velocity templates can be added, replaced, extracted, or deleted. The library should contain all the different files needed for each receiver. The library will be used when the user selects a template in the receiver tab. A minimum of one template is required in the library before the channel can be used.

Excel template

Excel templates can be added, downloaded, replaced, or deleted. The Excel template allows you to quickly send one or multiple objects into a polished Excel output. In order for PDX to export attribute values correctly into the file, you must insert attribute tokens into the row just below the header row of the template. These tokens represent how each attribute on the template is actually stored in PDX. For example, an attribute on a template might be called 'Product Name,' but in PDX, the attribute will be stored as 'PRODUCT_NAME' (attribute ID in PDX). An attribute token consists of the attribute ID appearing between two open curly brackets ( {{ ) and two closed curly brackets ( }} ).

  • Add template: follow steps 1 – 3 that are listed in the screenshot below. The newly uploaded template will then appear in the list.

  • Replace template: First, click the icon beside the template you wish to replace. Then follow the remaining steps from 'Add template' instructions above. The new template will overwrite the old template.

  • Download template: click the icon to download a template.

  • Delete template: click the to delete a template. This action cannot be reversed.

A user can also input tags into Excel templates in order to ensure a specific output when downloading products. For example, a user can utilize regular attribute tags, language-specific attribute tags, and tags for composite attributes.

  • Regular attribute: regular attribute tag including underscore for spaces

  • Language-specific attribute: #language code after attribute name

  • Composite attributes: period between linked attributes

The screenshot below provides an example of these tags.

Velocity template

Velocity templates can be added in Excel or JSON format. Actions that can be performed for these templates are create, edit, or delete.

  • Add template: a new template can be added / created in either JSON or XML format. Click 'Add Velocity template' to add a new template.

    1. Template name: Enter template name, which is required prior to saving.

    2. Add template: This dropdown allows you to select a JSON or XML template type. This selection will populate the content described in step 3. Click the icon to navigate to the template editor documentation (https://pdx.stibosystems.com/#/template-editor-documentation), which provides additional information on creating templates.

    3. This section will be populated with the body of the template.

    4. Set template filename if desired. Click for more information on setting the file name. A default name ({{CHANNEL_NAME}}-{{TIMESTAMP}}.xml) can be used.

    5. Beautify output (optional): this feature will automatically format the template for improved readability.

    6. Save completed template.

Receivers

This section allows you to add or manage metadata attributes for your existing receivers. For more information on creating receivers, go to the Receivers tab for output topic here.

Digital Catalog filter search

Attributes that are available in the channel can be added to define the product filters in the Digital Catalog workspace.