Display the reference entities

To display the existing reference entities, click on the Entities menu.

No reference entity is created by default.

From this single place, you can:

• Create your 1st reference entity
• Define its properties (Properties tab)
• Define its records attributes (Attributes tab)
• Create and enrich its records (Records tab)
• Define its permissions, which user groups can view or edit this reference entity and its records (Permissions tab)

If a reference entity has already been created, simply click on it to access its information.

Create a reference entity

To create a reference entity, follow these steps:

1. Go to the Entities menu
2. Click on the Create button
3. Input the label of the reference entity in the current catalog locale
4. The code is automatically generated using the label, but it can also be updated (this code must be unique and may only contain letters, numbers and underscores)
5. Click on the Save button or press Enter to create the reference entity

Then you can define its properties (Properties tab) and define its records attributes (Attributes tab).

Define its properties

In the Properties tab, you can edit the label of the reference entity and upload an image used to identify the reference entity in the PIM.

You can also translate the label of the reference entity by switching the current catalog locale in the header.

Define its records attributes

In the Attributes tab, you can define what are the attributes for these reference entity records.  
For example, a Brand reference entity could be described by the following information:

• a code
• a label
• an image
• a country
• a designer
• a foundation date
• a photo
• a description

Add an attribute

To add an attribute, follow these steps:

1. Go to the Attributes tab of a reference entity
2. Click on the Add an attribute button
3. Input the label of the attribute in the current catalog locale
4. The code is automatically generated using the label but you can update it (this code must be unique and may only contain letters, numbers and underscores)
5. Select the attribute type:  
   
   • Image: for images attributes
   • Text: for text or text area attributes 
   • Number: for number attributes
   • Reference entity single link: to link a record to only one entity record
   • Reference entity multiple links: to link a record to several entity records
   • Single option: to define a list of options with a single choice
   • Multiple options: to define a list of options with multiple choices
6. If the attribute type is a reference entity single/multiple link, select the reference entity to link to this attribute in the list
7. Tick Value per locale if your record could have different values per locale for this attribute
8. Tick Value per channel if your record could have different values per channel for this attribute
9. Click on the Save button or press Enter to add the attribute

The attribute is now created and an edit pop-in opens with the attribute parameters depending on the attribute type.

Edit an attribute

To edit an attribute, follow these steps:

1. Go to the Attributes tab of a reference entity
2. Click on the Edit icon
3. An edit pop-in opens with the attribute parameters depending on the attribute type
4. You can translate the label of the attribute by switching the current locale in the header  
   
5. Depending on the attribute type, set the specific parameters of the attribute (see below the specific parameters)
6. Click on the Save button or press Enter to save the attribute parameters

EDIT AN IMAGE ATTRIBUTE

• Max file size (MB): maximum file size allowed in MB
• Allowed extensions: allowed files extensions (gif, jpeg, jpg, pdf, png...)

EDIT A TEXT ATTRIBUTE

• Maximum number of characters: maximum number of characters that an attribute value can have
• Text area: long text

If Text area:

• Rich Text Editor: activates the WYSIWYG feature to format the text

If not Text area:

• Validation rule: defines how the value should be validated (such as an URL, an email, or using a regular expression)

EDIT A NUMBER ATTRIBUTE

• Decimal values allowed: allows decimal values for this attribute
• Min value: the smallest value allowed
• Max value: the largest value allowed

EDIT A SINGLE/MULTIPLE OPTIONS ATTRIBUTE

• The Manage options button enables to manage the options of the list

EDIT A REFERENCE ENTITY SIMPLE/MULTIPLE LINK ATTRIBUTE

• Related reference entity: the reference entity linked to this attribute, this information cannot be updated

Manage the options

To define the options of a single/multiple options attribute, follow these steps:

1. Go to the Attributes tab of a reference entity
2. Click on the Edit icon of the attribute
3. An edit pop-in opens with the attribute parameters
4. Click on the Manage options button
5. A fullscreen opens to manage the options  
   

ADD OPTIONS

1. Write your option label
2. The option code is automatically generated using the label, but it can also be updated (this code must be unique and may only contain letters, numbers and underscores)
3. Write your next option label
4. Click on the Save button, the fullscreen is closed

TRANSLATE OPTIONS

1. Change the catalog locale using the switcher
2. Translate the option label
3. Translate the next option label
4. Click on the Save button, the fullscreen is closed  
   

REMOVE OPTIONS

To remove an option, click on the cross at the end of the option line.

Define the completeness

To define the attributes required for the completeness of a record:

1. Go to the Attributes tab of a reference entity
2. Click on the Edit icon of an attribute
3. Tick Required for completeness if this attribute is required for the completeness of a record
4. Click on the Save button or press Enter

If this attribute is not required for the completeness, untick Required for completeness.

Delete an attribute

To delete an attribute, follow these steps:

1. Go to the Attributes tab of a reference entity
2. Click on the Edit icon of the attribute you want to delete
3. An edit pop-in opens with the attribute parameters
4. Click on the Delete the attribute button
5. A confirmation pop-in opens to confirm that you want to delete the attributes
6. Click on the Delete button

Delete a reference entity

To delete a reference entity, follow these steps:

1. Go to the Properties tab of the reference entity you want to delete
2. In the top right corner of the header, click on ... for other actions and then Delete entity
3. A confirmation pop-in opens to confirm that you want to delete the reference entity
4. Click on the Delete button

Set rights on a reference entity

To set rights on a reference entity, please read this article.