Customizing product option forms

In Xperience, you can add any number of custom fields to product options. The custom fields allow you to specify additional properties for options. You can also create fields that are visible only if a specific value is selected in another field.

First, you need to add a field to the product option form. Then, enable the field on the alternative form of the SKU. If you want one of the fields to be dependent on another field, set dependencies.

Adding a field to the product option form

With a field related to SKUs, you can store additional information about the SKUs. You add a field through the field editor in the Modules application.

1. Open the Modules application.
2. Edit () the E-commerce module.
3. Switch to the Classes tab.
4. Edit () the SKU class.
5. Switch to the Fields tab.
6. Create a new field based on your needs.
   • Leave Standard field in Field type.
   • Clear the Display field in the editing form check box.
7. Click Save.
   

The system adds the field to the SKU form and also creates a record of the field in your database.

Enabling the field in an alternative form

By enabling the field in an SKU’s alternative Option form, you can work with the field from the administration interface when creating or modifying a product option.

1. Open the Modules application.
2. Edit () the E-commerce module.
3. Switch to the Classes tab.
4. Edit () the SKU class.
5. Switch to the Alternative forms tab.
6. Edit () one of the Option forms to which you want to add the custom field.
7. Switch to the Fields tab.
8. Select the custom field, which you want to enable, in the left list.
9. Select Display field in the editing form.
10. Set the form appearance based on your needs.
11. Click Save.
    

The system starts to display the custom field on the Options tab in details of every option of the chosen product option category type.

Setting visibility dependency between fields

If you want one field to be visible only when there is a specific value in another field, you need to set it while editing the fields. See the following example.

We sell T-shirts and every T-shirt has a printed label. There are two types of labels – predefined ones and custom ones. Every T-shirt has a drop-down list in which there are a list of predefined labels and “Custom label”. If a user selects “Custom label”, the form displays a textbox where users can type their custom label.

Since there are two types, we want to edit the attribute option form, where we create two new fields, one for predefined labels and one for custom labels.

Creating the fields

1. Open the Modules application.

2. Edit () the E-commerce module.

3. Switch to the Classes tab.

4. Edit () the SKU class.

5. Switch to the Fields tab.

6. Create a field for predefined labels:

   1. Click New field.
   2. Enter attributes of the field:
      • Field name: PredefinedLabels
      • Display field in the editing form: No (cleared)
   3. Click Save.
      

7. Create a field for custom labels:

   1. Click New field.
   2. Enter attributes of the field:
      • Field name: CustomLabels
      • Display field in the editing form: No (cleared)
   3. Click Save.
      

The system creates database records for both fields. However, they are not displayed anywhere.

Setting dependencies

1. While still editing the SKU class, switch to the Alternative forms tab.
2. Edit () the Option (Attribute) form.
3. Switch to the Classes tab.
4. Edit () the SKU class.
5. Switch to the Fields tab.
6. Select PredefinedLabels from the left list.
7. Edit attributes of PredefinedLabels:

   • Required: Yes (selected)

   • Display field in the editing form: Yes (selected)

   • Field caption: T-shirt label

   • Form control: Drop-down list

   • Data source: List of options

   • To the Data source textbox, enter these values:

     Copy

     
     
     
       1;T-shirt with label
       2;Label on T-shirt
       3;Printed label
       4;Custom label
     
     
       

   • Has depending fields: Yes (selected)

8. Click Save.
9. Select CustomLabels from the left list.
10. Edit attributes of CustomLabels:

    • Display field in the editing form: Yes (selected)

    • Field caption: Write your custom label

    • Visibility condition: PredefinedLabels == 4

      The number is 4 because it’s the number of “Custom label” in the Data source textbox.

    • (Optional) Enabled condition: PredefinedLabels == 4

    • Depends on another field: Yes (selected)

11. Click Save.
12. Using Move up () and Move down (), position both fields closely under SKUEnabled.
    • This ensures that the fields are visible.

The fields are now displayed on the product options page. The PredefinedLabels field is displayed always. When a user selects Custom label in PredefinedLabels, the CustomLabel field appears.

You can check the result if you navigate to the Product options application and edit a product option from a product option category from the Attribute type. There you can see the added and configured fields.