Change attribute settings
How to update the configurable properties and analyzer tests for an export template attribute.
Use the attribute's Properties dialog to update the configurable properties of an existing export template attribute.
You cannot rename an attribute: sites that use the export template may already refer to it. To use another name, add a new attribute with that name and delete the old one, if it is optional. The new attribute starts without the old one's settings and analyzer tests, and sites have to map data to it again.
Update attribute properties
Go to Export templates in the Developer Portal, find the export template, and open its setup page.
In the section Attributes and analyzer tests, find the attribute and select its properties icon. The attribute's Properties dialog opens.
Update the properties available for the attribute. Depending on the template and attribute configuration, these can include:
| Property | Description |
|---|---|
| Type | Choose Optional, Mandatory, or Conditional. A conditional attribute becomes mandatory when its configured conditions are met. See Conditionally mandatory attributes to learn how to configure conditions |
| Delta Key | Identifies a product across site runs. The platform uses the selected attribute values to match a product in the current run with the same product in the previous run. Use a stable identifier, such as a product ID or SKU. You can set it while delta updates are off. A delta export template with attributes needs at least one Delta Key. See Delta settings |
| Delta Ignore | Excludes the attribute from delta change detection. Changes to this attribute alone do not move a product into the file for changed items. Shown only when delta updates are on |
| Unique attribute | Marks the attribute whose value must be unique in the exported file. Rows with the same value are reduced to one. See Unique attribute |
| Automap Ignore | When a site adds the export template, Automap does not connect the site's imported data to this attribute in the Dataflow. Connect it manually instead. See Alias for how Automap works |
| Description | A description of the attribute for people who edit the export template. Not shown in the Productsup platform |
| Example | An example value for people who edit the export template. Not shown in the Productsup platform |
| Format | The expected format of the values, for people who edit the export template. Values are not checked against it, and it is not shown in the Productsup platform |
| Alias | The name of the attribute in the site's Dataflow. See Alias |
Select Save in the dialog.
Alias
Alias is the name of the attribute in the Intermediate stage of the Dataflow of each site that uses the export template. If Alias is empty, the attribute name is used. The export stage of the Dataflow and the exported file always use the attribute name.
- When a site adds the export template, Automap connects each attribute to the Intermediate attribute named by its Alias. For example, the attribute
item_price[0].valuewith the Aliaspricegets its values from the Intermediate attributeprice. - Automap only connects attributes that are not connected yet. If you add or change an Alias after sites added the export template, the new Intermediate attribute appears in their Dataflow, but the attribute keeps its existing connection. To use the new Intermediate attribute, connect it in the site's Dataflow.
- Attributes with the same Alias share one Intermediate attribute, even across different exports of a site. The site maps that attribute once, and every attribute with that Alias gets the value.
- The Automap connections menu in the Dataflow matches attributes by name and does not use the Alias.
- The Alias
idhas one extra use: when nothing else is set, the platform uses theidattribute as the product ID for A/B test splits and click tracking. Exports work without it.
Unique attribute
Mark an attribute as Unique attribute when its value must be unique in the exported file, for example a product ID. At export time, rows with the same value are reduced to one:
- The first row in the data is kept, with all its values.
- Later rows with the same value are dropped, without a warning or log entry.
- Nothing is combined across rows.
- Empty values count as the same value, so all rows with an empty value are reduced to one too.
If you mark several attributes as unique, only the full combination of their values counts.
Delta settings
A delta export sends only products that changed since the previous site run. Delta Key and Delta Ignore control how the platform identifies products and detects changes.
Delta Key is always shown in the Properties dialog, so you can set it before you turn on delta updates. While delta updates are on, you can also view and change the Delta Keys of all attributes in the Delta Key list in Advanced settings. Both places show the same Delta Keys. Delta Ignore shows only when Delta export? is Yes in the export template's Advanced settings.
These rules apply:
- A delta export needs at least one Delta Key. The Developer Portal does not let you remove or delete the last Delta Key while delta updates are on, in the Properties dialog or in Advanced settings. Make another attribute the Delta Key first, or turn delta updates off.
- An attribute cannot be both Delta Key and Delta Ignore.
Set Delta Key on an attribute that holds a stable identifier, such as a product ID or SKU. The platform uses this value to match products between site runs. You can set Delta Key on several attributes; together they identify a product.
Use Delta Ignore for attributes that change frequently without representing a meaningful update. When enabled, a change to that attribute on its own does not move the product into the file for changed items.
Caution
The first site run after you change Delta Ignore reports every product as changed. The platform compares that run against a baseline built under the previous configuration, so the run behaves like a full export. Later runs return to normal delta behavior.
These settings belong to the export template, not to an individual site. Every site using the template is affected, including the full export on the first run after a change to Delta Ignore.
Change detection also compares internal values that are not template attributes and cannot be marked Delta Ignore. Using Delta Ignore reduces unwanted entries in the file for changed items, but it cannot guarantee eliminating them.
Manage analyzer tests
Analyzer tests belong to a specific attribute, but you manage them separately from the Properties dialog.
In the attribute's row, select Add analyzer test in the Analyzer tests column. The Configure Analyzer Test pop-up opens for that attribute.
Configure the analyzer test, then select Save. See Add an analyzer test to an attribute for the available test types and setup instructions.
Save and publish template changes
After saving the attribute properties or analyzer tests in their dialogs, select Save in the section Attributes and analyzer tests to save your export template changes. To make the changes available in the Productsup platform, select Publish. See Publish export template changes.
How is this guide?