How to create a reference entity type

Create a reference entity type, define its attributes and link it to products. You need the Can manage reference entity types user permission and, for attributes, access to the Attributes administration area. The differences between reference entities, categories and reference data are explained in The differences between categories, reference data and reference entities.

Create the type

1. In the top bar, click the reference entities icon to the right of the channel selector. On a smartphone, select Reference entities from the menu.
2. In the Reference entities list, click Add new.
3. Under General Info, complete:
   • Key: the type's key. You cannot change it after saving. openlane does not check that it is unique: choose one that no other type uses;
   • Label: the name shown to users;
   • Show on menu: the type appears as an item in the top bar for all users;
   • Auto generate SKU: openlane generates the SKU for new reference entities using the type's key followed by a number. Without this option, you enter the SKU when creating the reference entity.
4. Click Save.

The message Reference entity type saved appears.

Define the type's attributes

1. In the Reference entities list, click the Attributes icon in the type's row. The list of attributes for the type opens.
2. Click Add attribute.
3. Complete Name, Label, Attribute type, Tab name and Group name as you would for a product attribute, as described in How to create an attribute. The supported types are listed in Attribute types, in the section on types for reference entities.
4. Set Read only, Show on filters, Show on left pane and, if needed, the groups under Hidden User Groups.
5. Click Save.

If the attribute type has configuration options, complete them as described in How to configure an attribute. To edit or delete attributes, you also need the Can edit all fields user permission. Reference entity attributes do not have validation rules.

Link the type to products

1. In the product entity type, create an attribute of type ReferenceEntityLinkValue, as described in How to create an attribute.
2. In the attribute configuration, select the type under Reference entity and set how linked reference entities are displayed. The options are described in Attribute configuration options.

You create reference entities of a given type from its list. Open it using the All … icon in the type's row, or from the menu item if the type has Show on menu enabled. Permissions to create, delete, import from Excel or bulk edit reference entities are set for each type in the user's permissions.

Delete a type

1. In the Reference entities list, click the Delete icon in the type's row.
2. Confirm.

The message Reference entity type deleted appears.