Skip to content

Entity Attributes

Marius edited this page Aug 22, 2014 · 4 revisions

Entity Attributes

Each entity you add needs a set of attributes that define that entity. Like Name, Descriptin, Image and so on. If the entity is flat (one entity one table) these attributes will be called fields.

In this section of the UMC you can add as many attributes/fields as you like by clicking the Add Field/Attribute button.
Multiple attribute types are supported. See Attribute Type for more details.

attributes

The fields / attributes will be listed in your entity admin page in the order you enter them in the UMC. If you realized you want a different order you can simple drag & drop the attributes and change their order.

sort_order

For each attribute you need to fill in the following values :

  • Attribute code - this should be a unique lowercase string. Just like the product attributes. With this code the attribute/field is identified in the application. Not everything can be used as an attribute code. There are some restrictions.
  • Attribute label - This is the label of the attribute / field. It will be used in the backend forms, grids and in special cases on frontend.
  • Attribute Type - Select the desired attribute type
  • Attribute Scope - Select the attribute scope. This option is available only for EAV entities.
  • Note - The text you fill in here will be added as a note under the admin field of your attribute in the entity add/edit form. Leave empty for no note.
  • Acts as name - Each entity requires a special attribute, in order to identify it. Just like you identify a product by it's name or a blog post by its title. So you need to mark one and only one attribute / field as special. The values of these attributes will be used in frontend lists, backend lists, rss feeds. Only attributes of type text, int and decimal can behave as name.
  • Required - Mark the attribute / field as being required. image and file attributes cannot be marked as required.
  • Use WYSIWYG editor - This option is available only for textarea attributes. If you set this to Yes then you will have a WYSIWYG editor for this field in the admin add/edit form of your entity.
  • Show in admin grid - You can choose to show your attribute as a column in the entity admin grid. Not all attributes are allowed in the grid. File, Image and Textarea are not allowed.
  • Show in frontend - If you chose to create the frontend view files for your entity, this field will be available. If you select Yes, the value of the field will be displayed in the entity view page.
  • Show in widget - If you chose to create widgets for your entity, this field will be available. If you select Yes, the value of the field will be displayed in the view widget of the entity.
  • Show in rss - If you chose to create RSS feeds for your entity, this field will be available. If you select Yes, the value of the field will be displayed in the RSS feed.
  • Options source - This field is available only for dropdown and multiselect attributes. This determines the options you will have in the attribute:
    • Manually defined - allows you to manually fill in the values in the Options in select field.
    • Product attribute - it allows you to take the options already filled in for a product attribute. Useful if you need for example a color and you don't want to add your colors in 2 places.
    • Category attribute - Same as for the product attribute. The only difference is that you can use a category attribute
    • Customer attribute - Same as for the product attribute. The only difference is that you can use a customer attribute
  • Attribute code for option source - This is available for dropdown and multiselect attributes but not for attributes with a manually defined Options source. You need to fill in here the product/category/customer attribute code that will provide the options for your attribute
  • Options in select - This is available for the dropdown and multiselect attributes with a manually defined source. Just fill in the labels that should appear in the dropdown/multiselect
  • Default value - You can set a default value for each attribute type except file and image. On the add form of your entity you will see the these default values already filled in. For dropdown and multiselect attributes fill in one or more of the labels that you filled in in the Options in select field. All others will be ignored. For multiselect attributes, if you want 2 or more default values add them on separate lines.
Clone this wiki locally