MivaLabs Feed Builder is one compiled file. The download is a zip with the module and a README.
| Module | Download |
|---|---|
| MivaLabs Feed Builder | mivalabsfeedbuilder_1.0.0.zip |
The ready-made channel feeds are provisioning files. Download them one at a time from Ready-made channel files, or all at once as miva-feed-builder-provisioning.zip.
Install#
- In the admin, go to Settings > Domain Settings > Modules.
- Unzip the download, click Add Module and upload
mivalabsfeedbuilder_1.0.0.mvc. - Go to Settings > Utilities and click Install on MivaLabs Feed Builder.
The module does nothing in a store until it’s installed there: uploading it to the domain creates no tables, settings or tasks. After installing:
- Marketing > Feeds > Add Feed lists MivaLabs Feed Builder as a feed type. That’s the Feed Builder.
- Settings > Utilities has a MivaLabs Data Builder tab, which lists the Data Builder fields and is where you add them (see Set up a field).
- A scheduled task named “Regenerate Queued Feed Builder Feeds” is added. It is disabled and has no trigger. See Running and delivering feeds for when to turn it on.
- Data Builder fields need their own tasks (operation “Recompute Data Builder Field”). See Scheduled tasks.
Miva lists every feed module uploaded to the domain under Add Feed, installed or not, and a module can’t hide itself from that list. If the module isn’t installed in the store, choosing it shows “MivaLabs Feed Builder is not installed in this store” and the feed can’t be saved. Its scheduled tasks show the same message. Provisioning imports don’t install the module either; install it before importing.
Update#
Upload the new .mvc on Settings > Domain Settings > Modules with the module’s update option. Copying the file onto the server isn’t enough: Miva reads the module’s feature list when the file is uploaded.
What the install creates#
The Feed Builder part creates two tables. The table prefix is the store’s, for example s01_.
| Table | Holds |
|---|---|
FeedBuilderRegistry |
One row per Feed Builder feed: its code, trigger, page code, source and whether it uses category paths |
FeedBuilderQueue |
Feeds waiting to be rebuilt after a product change |
The Data Builder part creates three tables.
| Table | Holds |
|---|---|
FeedDataFieldRegistry |
One row per Data Builder field: its source, trigger, page code, format, field map and variant setting |
FeedData |
The stored value for each record. The value column is a text column, so long rows are never cut. |
FeedDataQueue |
Records waiting to be recomputed, with a priority |
Each feed or field also gets an admin page, coded FEEDBUILDER_<feed code> or FEEDDATAFIELD_<field code>. That page holds its settings. Edit Feed Builder (on the feed) and the field’s row on the MivaLabs Data Builder tab open it.
Uninstall#
Remove the module in two steps: uninstall it from each store, then delete it from the domain.
1. Uninstall from the store#
- Delete the MivaLabs Feed Builder feeds under Marketing > Feeds. Data Builder fields don’t need deleting first.
- Delete the module’s scheduled tasks under Settings > Store Settings > Scheduled Tasks: the feeds’ tasks and the Data Builder fields’ Recompute Data Builder Field tasks. “Regenerate Queued Feed Builder Feeds” can stay; uninstalling removes it.
- Go to Settings > Utilities and uninstall MivaLabs Feed Builder.
Miva refuses to uninstall a module while a feed or scheduled task uses it. The message names which: “is in use by one or more feeds” or “is in use by one or more scheduled tasks”.
Uninstalling deletes everything the module created in the store: every feed’s builder page, every Data Builder field with its page and stored values, the shared settings items, all five tables and the module’s scheduled tasks.
Export anything you want to keep first. A skin export includes every Feed Builder feed’s settings; see Running and delivering feeds.
2. Delete from the domain#
Once the module is uninstalled from every store, delete it under Settings > Domain Settings > Modules. While any store still has it installed, Miva reports “is in use by one or more stores, and cannot be deleted”.
Removing a module with SQL
If a module is removed by deleting rows in the database instead of uninstalling it, its tables stay behind. Installing it again then fails with errors such as Table s01_FeedBuilderRegistry already exists. Uninstall from the Utilities screen instead.