This article applies to the following workspace types
Nutrition Labelling Enterprise
Advanced export lets you extract detailed information about the resources in your workspace, laid out the way you need. For example, you could export the energy, protein and sodium per 100g of every recipe in your private label range.
- Export templates are saved layouts. They control which files are included in the export, and which columns appear and in what order.
- Exports are the files produced each time you run an export. They are listed on the Exports tab, where you can download them.
- Filters decide which resources are included in an export.
To learn how to build filters and produce filter results, see the Advanced filtering article.
Run an export
Exports are run from Workspace settings, under Export data. There are three ways to start one.
| Start from | How | Steps |
|---|---|---|
| The Exports tab | Select New export | Filter, then Results, then Template |
| A filter result | Select Export on a completed filter result | Results, then Template |
| An export template | Select Queue export in the template's card menu | Template (already chosen), then Filter, then Results |
Start a new export
- Go to Workspace settings and select Export data.
- Select New export.
- Filter: choose a saved filter or build a new one. See the Advanced filtering article.
- Results: check the resources that matched, then select Next.
- Template: choose a saved export template or build a new one (see Create an export template below).
- Select Run and review your filter, filter results and export template.
- Select Start export.
The export appears on the Exports tab. Large exports can take a few minutes.
Download an export
- Go to Workspace settings, select Export data, then select the Exports tab.
- Find your export. Its status updates automatically while it runs.
- When the status is Completed, download the file.
An export containing only resources.csv downloads as a CSV file. An export containing more than one file downloads as a .zip file.
Create and manage export templates
Saved export templates are shared with everyone in the workspace and can be reused for any export.
Create an export template
- Go to Workspace settings, select Export data, then select the Export templates tab.
- Select New template.
- Enter a Name and, optionally, a Description to give users extra context.
- In the Files panel, select the files to include (see Files in an export below).
- Choose the columns to include in resources.csv:
- In the column list on the left, tick each column to include. Columns are added to the end of your selection. Use Search to find a column by name, or tick a group to add all of its columns.
- Drag columns in the selected list on the right to set their order. The export follows this order exactly.
- If you have selected nutrients, choose the nutrient bases (see Nutrient bases below).
- Save the template.
If you build a template while running an export, it is used for that export only. To add it to the template library, select Save export template for reuse and give it a name.
Columns you can add to resources.csv
| Group | Includes | Examples |
|---|---|---|
| Fields | Values stored on a resource, grouped by tab | Name, description, resource type, label declaration type |
| Nutrients & components | Calculated nutrients and components enabled in the workspace, grouped by nutrient category | Energy, protein, sodium, gluten, soy |
| Legacy columns | Copies of columns under their previous column names, for backwards compatibility. Hover over the information icon next to a legacy column to see its current name. | DocID, RefID, Folder |
When a search is active, ticking a group only adds the columns that match the search.
Calculated Health Star Rating (HSR) stars are fields, not nutrients. Find them under Fields in the Health Star Rating section.
Nutrient bases
When you include nutrients, use the Nutrient basis dropdown at the top right of the template builder to choose how their values are expressed. There are four bases: per 100g (default), per serve, per 100mL and Total.
- Bases apply to every selected nutrient, and each basis produces its own column. For example, Energy with per 100g and per serve selected produces two columns.
- Columns for each nutrient are kept together. Drag the bases to set the column order within each nutrient.
- If you select any nutrients, at least one basis must be ticked before you can save the template or start the export.
Every nutrient is handled the same way, including allergens and other non-numeric values. For example, an allergen with three bases selected produces three columns with the same value in each.
Files in an export
| File | Contents | Included |
|---|---|---|
| resources.csv | Customisable. One row per resource, with the columns you selected. | When any columns are selected |
| ingredients.csv | Not customisable. One row per ingredient line, including weight in grams. Select the ingredients.csv card in the template builder to see its columns. | When ticked in the Files panel |
| ingredientcontributions.csv | Not customisable. One row per ingredient declaration with a characterising ingredient percentage. Select the ingredientcontributions.csv card in the template builder to see its columns. | When ticked in the Files panel |
A selected file is still included if it has no rows, for example ingredients.csv when none of the exported resources have ingredients.
Manage export templates
Each template card shows the template's name, description and number of columns. Hover over the column count to see the column names.
- Star a template to mark it as a favourite.
- Use the card menu to Open, Edit, Duplicate, Delete or Queue export.
- Open a template to see its columns in export order.
Permissions, limits and things to know
- Saved export templates and the export history are visible to everyone in the workspace.
- Exports are produced as CSV files. Exports with more than one file download as a .zip file.
Troubleshooting and FAQs
Some nutrient columns in my export are blank. Foodworks only calculates nutrients that are enabled in the workspace. If a template includes a nutrient that has since been turned off, the column is still included so your file layout doesn't change, but it is left blank. When you edit the template, these nutrients are listed under Not enabled in this workspace. Turn the nutrient back on in the workspace's enabled nutrients and run the export again.
I cannot save my template, or Start export is greyed out. Check that the template includes at least one column or file, and that at least one nutrient basis is ticked if you have selected any nutrients.
Why does each allergen appear in several columns? Bases apply to every selected nutrient, including allergens, and each basis produces its own column. To get one column per allergen, select only one basis.
A column name has changed and my automation has stopped working. Add the matching column from Legacy columns, which uses the previous column name.
I built a template during an export but cannot find it in the library. Templates built during an export are only saved to the library if you select Save export template for reuse and give them a name.
ingredients.csv is empty. None of the resources in the export have ingredients, for example if the filter only returned raw materials.
My export failed. Select Retry on the Exports tab. If the export template has been edited since the export first ran, you are warned that the columns may differ from the original export.
Why can't my Professional workspace use advanced export? Advanced export is part of Nutrition Labelling Enterprise. Professional workspaces cannot use it.
Comments
Please sign in to leave a comment.