Help

Tutorial

How to add a custom product template in Auctiva Commerce

Watch the Product Templates video tutorial.

Custom Product Templates allow you to customize specific product information. This is done by adding Merchant Fields and Customer Fields to a Product Template. These fields are used in a variety of ways throughout Auctiva Commerce administration and the storefront. This level of customization can greatly improve the way product information is displayed on the storefront.

What is a Product Template?

A Product Template is a customizable set of fields (i.e., Merchant Fields and Customer Fields) that both merchants and customers use to define certain details of a product. Typically, a Product Template is used across many different individual products that share similar qualities. A product must be assigned to a Product Template in order to use these additional input fields.

What is a Merchant Field?

A Merchant Field is a type of input field that allows you as a merchant to enter additional product information. The Merchant Field contains additional fields that will display on the storefront in the product's Description section when you enter a value for those fields. The Merchant Field information is also displayed in the Order Contents section of the Order Details page when an order is made. This shows the merchant exactly what has been ordered.

What is a Customer Field?

A customer field is an input field on the storefront that customers are prompted to enter when ordering a product. These fields can be used to leave special notes for orders, or to make various selections from a list of product options.

What is a Choice?

A Choice is a specific value that is a selectable option in a Merchant Field or Customer Field. The merchant will enter in the Choices for fields when creating a Product Template. A Choice contains other values that relate to the way a Choice is displayed. Those values are described later in this tutorial.

How to add a product template

If there is not a default product template that works with the different types of products on your store, follow these instructions to create a new Product Template:

Step 1. Add Product Template.
  • Go to Inventory> Product Templates.
  • In the Add Template box, enter the name for the template.
  • Click the Add button.
  • The Product Template is created and the Edit Product Template page is loaded.

How to create a Merchant Field to a Product Template

Merchant Fields need to be created for the Product Template. There are a variety of Merchant Fields. In Step 3, they are described in greater detail.

Step 1. View Edit Product Template page.

If the Edit Product Template page is loaded, skip to Step 2.

  • Go to Inventory> Product Templates.
  • Find the Product Template in the Product Template table.
  • Click the Edit icon for the Product Template to be edited. This will load the Edit Product Template page.
Step 2. Add Merchant Field.
  • Click on the Add Field button in the Merchant Fields section. The Add Field box will load.
Step 3. Select Input Type.
  • Input Type: Choose an Input Type. The various Input Type options only affect the way the Merchant sees the Merchant Field. Customers will only see the Name field and whatever values the Merchant has entered for each individual product in the Templates page. Here is list of the Input Type options:
    • Text Box: This option displays a Text Box field for merchants to type in characters. A Text Box field limits text by a maximum number of characters using the Max Length field. The Text Box Input Type is ideal for short text entries.
    • Text Area: This option displays a Text Area field for merchants to type in characters. Text Areas are different than Text Boxes, as their input field can display in administration at different sizes. This makes a Text Area ideal for long text entries.
    • Drop Down List: This option displays a list of Choices that drops down when activated. A Drop Down List is ideal for making a single selection from a short list of Choices.
    • List Box: This option displays a box with a list of Choices. A List Box is ideal for making a single selection from a long list of Choices.
    • Multiple List Box: This option displays a box with a list of Choices. A Multiple List Box is ideal for making multiple selections from a long list of Choices.
    • Radio Button: This option displays all available Choices with a Radio Button icon next to each Choice. A Multiple List Box is ideal for making a single selection from a set of Choices that are mutually exclusive.
    • Check Box List: This option displays all available Choices with a Check Box icon next to each Choice. A Check Box List is ideal for making multiple selections from Choices that are independent of each other.
  • Name: Enter the name for the Merchant Field. Customers will see this name in the product's Description section on the storefront. Merchants will see this field in administration, or they will see the Prompt field if a value is entered for Prompt.
  • Prompt: Enter in a prompt (optional). A prompt is a simple instruction for the Merchant. When a value is entered for the Prompt field, it replaces the Name field in administration. Customers always see the Name field on the storefront, even with a Prompt value entered.
  • Rows: Enter in the number of rows that the Merchant Field will display for the Choices. The Row field is only used for Text Area, List Box and Multiple List Box Merchant Fields. The Row field only affects the appearance of a Merchant Field in administration.
  • Columns: Enter in the number of columns that the Merchant Field will display for the Choices. The Column field is only used for Text Box, Text Area, Radio Button and Check Box List Merchant Fields. This Column value only affects the appearance of the Merchant Fields in the administration.
Step 4. Add Choices.
  • If the Input Type you chose from Step 3 is a Text Box or Text Area, skip this step and click the Save button to finish.

Note: Merchants will be able to see all Choices created in a Merchant Field in administration. Choices only become viewable to a customer after a merchant selects the appropriate Choices for a product in the product's Product Template page.

  • Click on the Next button in the Add Field box. The Edit Field box will load.
  • Click on the Add Choice link. The Choices table will load.
  • Text: Enter in the name of the Choice, replacing "Choice 1" with your entry. On the storefront, customers will see the Text field of a merchant's selection, or they will see the Value field if a value is entered for Value. In administration, the Text field is always what the merchant sees.
  • Value: Enter in the Value for the corresponding Choice (optional). When a value is entered for Value, it replaces the Text field on the storefront.
  • Selected: Check this box if the corresponding Choice should be selected by default.
  • Click on the Add Choice box to add more Choices as necessary. To delete a Choice, click on the Delete icon.
  • Click on the Save button to finish.

This completes the task of adding a new Merchant Field to a custom Product Template. If necessary, add any Customer Fields to the Product Template. Otherwise, see the section below on how to assign a Product Template to a product.

How to add a Customer Field to a Product Template

Adding a Customer Field to a Product Template is very similar to adding a Merchant Field. The fundamental difference is that the Customer Field displays on the storefront to give customers the ability to input additional product information for their order. In this way, all the Choices created in a Customer Field are visible to the customer. When an order is made, the customer's selected Choices of the Customer Fields are recorded in the Order Contents section of the Order Details page.

Step 1. View Edit Product Template page.
  • If the Edit Product Template page is loaded, skip to Step 2.
  • Go to Inventory> Product Templates.
  • Find the Product Template in the Product Template table.
  • Click the Edit icon for the Product Template to be edited. This will load the Edit Product Template page.
Step 2. Add Merchant Field.
  • Click on the Add Field button in the Customer Fields section. The Add Field box will load.
Step 3. Select Input Type.
  • Input Type: Choose an Input Type. The various Input Type options affect the way the customer sees the Customer Field. Customers will only see the Prompt field and whatever Choices the merchant has entered. Here is list of Input Type options:
    • Text Box: This option displays a Text Box field for customers to enter in text. A Text Box field limits text by a maximum number of characters using the Max Length field. This Input Type is ideal for short text entries.
    • Text Area: This option displays a Text Area field for customers to enter in text. Text Areas are different than Text Boxes, as their input field can display on the storefront at different sizes. This makes this Input Type ideal for long text entries.
    • Drop Down List: This option displays a list of Choices that drops down when activated. This is ideal for making a single selection from a short list of Choices.
    • List Box: This option displays a box with a list of Choices. This is ideal for making a single selection from a long list of Choices.
    • Multiple List Box: This option displays a box with a list of Choices. This is ideal for making multiple selections from a long list of Choices.
    • Radio Button: This option displays all available Choices with a Radio Button icon next to each Choice. This is ideal for making a single selection from a set of Choices that are mutually exclusive.
    • Check Box List: This option displays all available Choices with a Check Box icon next to each Choice. This is ideal for making multiple selections from Choices that are independent of each other.
  • Name: Enter the name for the Customer Field. The Name field will only appear to the customer in the Order Contents section of the Order Details page when an order is placed.
  • Prompt: Enter the prompt. A prompt is a simple instruction for the customer. This becomes the name of the Customer Field on the storefront.
  • Rows: Enter in the number of rows that the Customer Field will display for the Choices. The Row field is only used for Text Area, List Box and Multiple List Box Customer Fields. This value affects the appearance of the Customer Field on the store front.
  • Columns: Enter in the number of columns that the Customer Field will display for the Choices. The Column field is only used for Text Box, Text Area, Radio Button and Check Box List Customer Fields. This value affects the appearance of the Customer Field on the storefront.
Step 4. Add Choices.
  • If the Input Type you chose from Step 3 is a Text Box or Text Area, skip this step and click the Save button to finish.
  • Click on the Next button in the Add Field box. The Edit Field box will load.
  • Click on the Add Choice link. The Choices table will appear.
  • Text: Enter in the name of the Choice, replacing "Choice 1" with your entry. The Text value is the name of the Choice that the customer will see.
  • Value: Enter in the Value for the corresponding Choice (optional). The Value will only appear in the order information.
  • Selected: Check this box if this Choice should be selected by default.
  • Click on the Add Choice box to add more Choices as necessary. To delete a Choice, click on the Delete icon.
  • Click on the Save button to finish.

How to assign a product to a Product Template

When a product is assigned to a Product Template, the additional fields will be editable in the product's Template page.

Step 1. View product.
  • Go to Inventory> Manage Inventory.
  • Navigate through the categories as necessary to find the product. Click on the Edit link of the product. The product's Details page should load.
  • Click on the Templates tab to load the product's Templates page.
Step 2. Assign Product Template.
  • Product Template: Choose the appropriate Product Template. The Product Template will load.
  • The fields that appear are the Merchant Fields that were created in the Product Template. Enter in the appropriate information for this product.
  • Click the Save button to finish.

This completes the task of assigning a product to a Product Template. Make sure to always check the storefront and review the changes. This is a good idea that ensures the values you've entered are indeed correct.

Tags

◄ Back to Help

Customer Support

If you have been unable to find the answer you were looking for using our Help documentation, please file a customer support request. We have customer support professionals ready to help you 24 hours a day, Monday - Friday (excluding major holidays.)