How to manage a reference data list
This page is for administrators: the operations described require access to the administration area.
Create a reference data list, add and sort its values, and delete it when you no longer need it. You need access to the ReferenceData administration area. Some lists are used by openlane itself and must be edited with care: they are listed at the bottom of this page.
Create a list
- In the menu, select Admin, then Reference data.
- Click Add new.
- In Key, enter the list key. You cannot change it once saved.
- Click New value for each value and fill in:
- Key: the value key stored in products. You cannot change it once saved;
- Description: the text users see, which is the same in all languages;
- Sort order: the value's position in the list.
- Click Save.
A key, description and position are required for each value. openlane does not check that the list key is unique: before creating a list, check that no list with the same key already exists.
To use the list in an attribute, link it in the attribute configuration, as described in How to configure an attribute.
Edit values
- In the Reference data list, click the Edit icon in the list's row.
- Edit Description and Sort order, add values with New value, or remove values you no longer need using the Remove icon.
- Click Save.
openlane does not check whether a value is in use. If you remove a value, products that use it retain its key, which no longer matches any value in the list.
When there is more than one value, Sort by key and Sort by description appear. These sort the values alphabetically by key or description. Sorting uses the saved list and reloads the page: save any other changes first, or they will be lost.
Delete a list
openlane does not check whether an attribute uses the list. Deleting a list linked to an attribute causes errors in that attribute: only delete lists that are not in use.
- Open the list, remove all its values using Remove, then click Save.
- In the Reference data list, click the Delete icon in the list's row and confirm.
You cannot delete a list that still contains values: the message Unable to delete reference data because there are some values inside appears.
Lists used by openlane
openlane identifies these lists by their key. Their values depend on your installation and can be updated, but you must not delete or duplicate the lists.
| Key | Contents |
|---|---|
| Locale | The languages managed in openlane |
| Country | Countries |
| Brand | Product brands |
| AttributeSet | Product attribute sets |
| CategoryFamily | Category families |
| UserGroup | User groups, used for attribute permissions |
| ChannelType | Channel types |
| ValidationErrorClass | Error classes for validation rules |
The Locale and Country lists must each exist exactly once: if either is missing or duplicated, openlane will not load. For the same reason, do not create lists with the keys ReferenceDataKeyId, AvailableCountry, AvailableLocale or AdminArea, which openlane uses for its own lists.