Custom Fields

Custom fields record information that ONIX does not cover — internal codes, editorial notes, marketing flags — against your titles. Each field has a data type, optional allowed values and a default, can repeat, and can be mapped to an ONIX 2.1 and/or ONIX 3.0 element through an XPath so it is exported in your feeds. Categories group related fields.

Where to find it

• Settings menu: Custom Fields. Route: /preferences/custom-fields.
• Visible to accounts with access to Preferences.

Screen overview

1. Search — queries the server half a second after you stop typing.
2. Manage Categories, Add, Edit (exactly one row selected) and Delete (one or more rows).
3. Table — checkboxes (with a select-all in the header), Category, Field name, Description, Allowed values, Default value, Repeatable and XPath (a check mark when a path is defined). A paginator appears beyond 50 fields.

How to manage categories

1. Click Manage Categories.
2. Type a name in Category name and click Add (or press Enter).
3. Rename a category by editing its name directly in the list — the change is saved when you leave the field. Delete one with its trash button and confirm (Do you really want to delete this category?); its fields stay and simply lose their category.
4. Click Close. Everything done in this window is already saved.

How to add or edit a field

1. Click Add, or select exactly one row and click Edit.
2. Choose a Category (or leave No category) and the Type: Alphanumeric (the default), Checkbox, Date, Integer, Real, Time or HTML.
3. Enter the Field name (required — A field name is required.) and optionally a Description, the Allowed values (one per line), a Default value, and tick Repeatable if the field may occur several times on a title.
4. To export the field in your ONIX feeds, type the XPath (ONIX 2.1) and/or XPath (ONIX 3.0) of the element it maps to.
5. Click OK. The field is saved immediately.

How to delete fields

Tick one or more rows (or the select-all checkbox), click Delete and confirm (Do you really want to delete this custom field? / Do you really want to delete the selected custom fields?).

Tips

• XPaths are free text and are not checked by the Dashboard: a typo silently produces no mapping. Copy the path from an existing field when in doubt.
• Category changes are immediate and cannot be undone.

Frequently asked questions

Why can't I click Edit?

Edit needs exactly one selected row. Delete works with several.

How do I pick an ONIX tag instead of typing an XPath?

The tag picker is not available in the Dashboard yet. Type the XPath, or use the previous Preferences application.

Do I have to save in Manage Categories?

No. Adding, renaming and deleting a category is saved as you do it; Close simply closes the window.

What does the check mark in the XPath column mean?

At least one of the two ONIX XPaths (2.1 or 3.0) is filled in for that field.

Related

• Preferences overview
• Views
• Lock Profiles — custom fields appear there as the CustomFields node