Created by potrace 1.16, written by Peter Selinger 2001-2019

Miva Developer Docs

1. Add the field#

  1. Install MivaLabs Feed Builder under Settings > Utilities if it isn’t installed yet.
  2. Open the MivaLabs Data Builder tab under Settings > Utilities. It lists every field.
  3. Click Add Field and fill in the new row (see the table below).
  4. Click Save Field. The new field’s page opens.
Box Enter
Name Shown in the field list and custom field lists. The code is used when it’s blank.
Code The custom field code that Feed Builder maps, for example google_merchant_data. Letters, numbers, _ and -, up to 36 characters.
Source Product or Category. This can’t be changed later. To switch, delete the field and add a new one.
Trigger Optional. See Scheduled tasks.

The field list#

The tab is a batch list like the other lists in the admin, with search, sorting and paging. Each row shows one field:

Column Shows
Name, Code The field’s name and custom field code
Source Product or Category
Output Format CSV, Tab-delimited, Pipe-delimited, JSON or XML
Variants Stored per variant, Product only, or n/a for a Category field
Mapped Fields How many fields are on the Mapping tab
Trigger The field’s Trigger name
Stored Values Records with a stored value
Queued Records waiting for the field’s task
Scheduled Tasks The field’s Recompute Data Builder Field tasks, and how many are enabled
Last Run When one of those tasks last ran

Check a field to work with it:

Button Does
Edit Field Mapping Opens the field’s page. One field must be checked.
Edit Field(s) Edits the name and Trigger in the list. Double-clicking a row does the same. The code and source can’t be changed.
Refresh All Records Queues every record of the checked fields and fires their Triggers, so their Queued Records tasks recompute them
Delete Field(s) Deletes each field’s page and stored values. Delete its scheduled tasks separately.

2. Map the fields#

The field’s page opens on the Mapping tab, which has these settings:

Setting Choices Notes
Source Shown, not editable Set when the field was created
Output Format CSV, JSON, XML Use the same format as the Feed Builder feed that writes this field
Delimiter Comma, Tab, Pipe CSV only. Use the same delimiter as the Feed Builder feed.
Store a value for each variant On or off Product source only. Stores a row for every variant as well as each product.

The field cards work the same as on Feed Builder’s Feed Fields tab: source, output name, transform, Main Image and Additional Images, constants and conditional output. Drag ☰ to reorder.

Value from#

With Store a value for each variant on, each card has a Value from choice:

Choice A variant’s row uses
Product / variant The variant’s own value, such as its code, price or stock
Master product The master product’s value, such as its description or brand

Products without variants read their own value either way.

The ready-made files use Master product for the description and brand, and Product / variant for everything else.

3. Check the preview#

Save, then open the Preview tab. It shows the stored value for the first 5 records. With variants on, it shows up to 3 variants under each product, marked ↳, with “(3 of N variants)” when there are more. The preview is the exact text that will be stored.

4. Fill it#

Nothing is stored until the field’s tasks run. Create the field’s tasks and run the All Products task once, or tick Refresh All Records on the field’s Settings tab and click Update. See Scheduled tasks.

Settings tab#

Setting Notes
Code, Source Shown, not editable
Name Change it and click Update
Trigger Change it and click Update. See Scheduled tasks.
Records How many records have a stored value, and how many are queued
Refresh All Records Queues every record when you click Update and starts the field’s Trigger, so its Queued Records task recomputes them

The field’s page also has Header and Footer tabs. Data Builder doesn’t write that text anywhere; each stored value is a single row. Put the column line, XML envelope or other wrapper on the Feed Builder feed that writes the field.

What gets stored#

  • Product source: every active product. With variants on, every variant of an active product too, even though variant parts are usually inactive.
  • Category source: every category.
  • When a product becomes inactive, its stored values are deleted.
  • When a product or category is deleted, its stored values are deleted.

Each value is stored in full; long descriptions are never cut.