Customising Entities and Attributes

Entities such as Customer, Product, Order, Shipping, and Payment have properties known as attributes. Attributes are used to define promotion rules in the rule builder. Customising entities and attributes allows you to make the rule builder more relevant to your business terminology and workflows.

Entities

Each entity can be customised in the following ways:

• Display Name (Alias): Change the name that appears in the rule builder. All standard attributes under that entity automatically reflect the display name.

  • Example: changing Order → Booking updates Order Total → Booking Total.

• Visibility: You can choose whether the entity is visible in the rule builder. Hidden entities do not appear to marketers configuring promotions.

Attributes

Attributes belong to entities and represent the individual data points that can be used in promotion rules. They can be customised in the following ways:

• Standard Attributes: These are predefined in the platform and are always associated with their entity. Changing an entity display name updates all related standard attributes. Standard attribute descriptions can be edited but will revert to the default if left blank.

• Custom Attributes: Attributes created for your business needs. You can edit their display name, description, and visibility in the rule builder.

Visibility: Attributes can be shown or hidden in the rule builder. This allows teams to focus only on the attributes relevant for creating rules.

Description: Descriptions appear in the rule builder to guide marketers when selecting attributes.

How to change an entity display name

You can update the name of any entity to make it more relevant for your business.

Steps:

1. From the side menu, go to Settings > Attributes.

2. On the Attribute List page, click the green Manage Entities button at the top.

3. Select the entity you want to rename (Order, Product, Customer, Shipping, Payment) from the drop-down.

4. Enter the new display name in the Display Name field.

5. Click Update to save your changes.

How to control entity visibility in the rule builder

You can choose whether an entity and all its attributes are visible in the rule builder. This is available for Customer, Shipping, and Payment entities.

Steps:

1. From the side menu, go to Settings > Attributes.

2. On the Attribute List page, click the green Manage Entities button at the top.

3. Locate the entity you want to show or hide.

4. Check or uncheck the Visible in Rule Builder checkbox.

   • Checked = entity and all its attributes are visible

   • Unchecked = entity and all its attributes are hidden

5. Click Update to save your changes.

How to edit an Attribute Description

You can update the description of both standard and custom attributes to provide more context in the rule builder.

Steps:

1. From the side menu, go to Settings > Attributes.

2. On the Attribute List page, locate the attribute you want to edit.

3. Click the hamburger menu on the right-hand side and select Edit.

4. In the Description field, enter your new text.

5. Click Update to save your changes.

How to control attribute visibility in the rule builder

You can choose whether an individual attribute is visible in the rule builder.

Steps:

1. From the side menu, go to Settings > Attributes.

2. On the Attribute List page, locate the attribute you want to change.

3. Click the hamburger menu and select Edit.

4. Check or uncheck the Visible in Rule Builder checkbox:

   • Checked = attribute is visible

   • Unchecked = attribute is hidden

5. Click Update to save your changes.
   
   

Summary

Customising entities and attributes ensures the rule builder reflects your business terminology and workflows. By adjusting display names, descriptions, and visibility, you can simplify promotion setup and help marketing teams focus on the attributes that matter. All changes are immediately reflected in the rule builder, making promotions easier to configure and reducing potential confusion.