Versions Compared

Old Version 2

changes.mady.by.user Documenter

Saved on

compared with

New Version Current

changes.mady.by.user Documenter

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt

The Custom Fields features lets you add non-standard fields from create extra fields for these database tables: Articles, Banners, Categories, Products, Promotions and Users. 


Info
titleWhat is a custom field?

'field' is a database term. All the bits of information that your website uses are contained and managed in a database dedicated to your business. In this database, information is organised in a collection of tables. A table is a container for data of an identified contains data grouped for a function or feature your website needsuses. Some examples are Users, Products, and Orders. Think of the table as organised in a spreadsheet, with columns and rows. A column contains a data type relevant to that table. For instance, the 'Users' table will come with many standard columns - Email Address, User Name, Role, etc. When you read a row, you are looking at information ('a record') for an specific user. You can also think of a column as a field. A table has columns or fields that each contain a data type. Each row contains a record of values a single entity has for each data type.


When you add, edit or view a page in the CMS or on your website, you are accessing database fields and values entered for them. Some like Email Address and Default Customer Account for the User table are standard on your website. 

Image Added

Custom fields are fields that are not used or created in a standard on pages in the out-of-the-box version of the Customer Self Service eCommerce PlatformCV ECommerce platform. 


We recognise that your website may benefit from adding custom fields that are important to your business needs. You can add custom fields to certain tables in the CMSYour business may want to maintain or display data in non-standard fields for certain functions in the CMS or even on a website page (product or category-related only). You can create custom fields to these tables:

  • Articles
  • Banners
  • Categories
  • Products
  • Promotions
  • Users


The process for adding custom fields is simple: 

  1. Identify the table you want to create a custom field for. 
  2. Create the new custom field for the table. 
  3. Edit a table's record to include the new data.
  4. (For product or category custom fields only) Display the field on your website. Add the new product field widget to theProduct Detail and/or Product List templates. For a category field, add the category field widget to the Category template. See: Add Custom Field to Product or Category


Step-by-step

...

Guide

Multiexcerpt
hiddentrue
MultiExcerptNameCreate a User Custom Field
shouldDisplayInlineCommentsInIncludesfalse


    1. In the CMS, go to E-Commerce → Advanced Content → Custom Fields. 

    2. Select the Users table.

      Image Added
    3. The page will load, displaying any existing custom fields for the User table.

    4. Click the Add New Custom Field button. 

    5. In Add Custom Field Details, enter the field requirements (for display and entry of values by administrators): 
      • Field Name - a code to identify this field in the database. Alphanumeric only, with no spaces or special characters. Underscore ( '_ ') permitted.
      • Prompt - the field label displayed next to the field.
      • Help - additional information about the field displayed.
      • Data Type:
          • Text - alphanumeric characters, including spaces, special characters, and html.
          • Integer - whole numbers
          • Decimal - numeric data including fractional components
          • DateTime - calendar dates and times
          • Boolean - toggle for a 2 value option, e.g. True/False, Yes/No

      • Display Type - the interface displayed to Administrators on the page the field appears in. NOTE - Display Type options depend on the Data Type selected.

        Expand
        titleClick here for an explanation of display types...


        Tip
        titleWhat is...
        • integer -  a whole number
        • boolean - functionality that only has two possibilities: ON or OFF, YES or NO etc



        Display TypeAvailable for Data TypeExample
        Text BoxText, Integer, Decimal

        One line text box

        Image Added

        Multi-line Text BoxText

        Image Added

        HTML Text BoxText

        WYSIWYG content editor that allows the text to be formatted

        Image Added

        XML Text BoxText

        Image Added

        Dropdown ListText, Integer, Decimal

        Image Added

        Image SelectorText

        Image Added

        Numeric Text BoxInteger, Decimal

        Image AddedImage Added

        Date PickerDateTime

        Image Added

        Time PickerDateTime

        Image Added

        Date/Time PickerDateTime

        Image Added

        Check box (toggle)Boolean

        Image Added

        NOTE - displays as a toggle




      • Allow Unlimited Text - (for Text Display Type only) tick to allow unlimited amount of text 
      • Mandatory - tick to make the custom field required on the page it displays in.
      • Active - leave ticked for the field to be in use. Untick to make inactive. NOTE - The field must be active for use with Import Users.
        Image Added

    • Save the custom field. You can view the field on the Website Users Maintenance page for a user. Add the field to your CSV file by entering the 'CUS_' before the Field Name as a new column header. Example: for custom field 'testfield', enter it in the CSV file as 'CUS_testfield'.

1. Create a New Custom Field  

  1. In the CMS, navigate go toE-Commerce → Advanced Content → Custom Fields. 

  2. Select the table you wish to add your custom field to (e.g. Categories, Products, Users).
    Image Removed
    Image Added
  3. The page will load, displaying any existing custom fields for the table you selected.

  4. Click the Add New Custom Field button. 

  5. Populate the In Add Custom Field Details as specified, enter the field requirements (for display and entry of values by administrators): 
    • Field Name  - a code to associate with identify this field in the database. Alphanumeric only, with no spaces or special characters. Underscore ( '_ ') permitted.
    • Prompt  - the field prompt/title which displays to Administrators on the Product Maintenance screenlabel displayed next to the field.
    • Help  - additional information which displays to Administrators on the Product Maintenance screenabout the field displayed.
    • Data Type:
        • Text - alphanumeric characters, including spaces, special characters, and html.
        • Integer - whole numbers
        • Decimal - numeric data including fractional components
        • DateTime - calendar dates and times
        • Boolean  - toggle for a 2 valuesvalue option, e.g. True/False
    • Allow Unlimited Text (for data type 'Text' only) - ticking this box removes the character limit from the field.
    • Length (for data type 'Text' only) - where unlimited data has NOT been allowed, this sets the maximum field length.
        • , Yes/No

    • Display Type

    2.  

    • - the interface

    3. which displays

    • displayed to Administrators on the

    4. Product Maintenance screen. Options here will change depending

    • page the field appears in. NOTE - Display Type options depend on the Data Type selected

    5. earlier. Possibilities include TextBox, DropDownList, and DateTimePicker.
  5. Mandatory - ticking this box makes the custom field required in Product Maintenance.
    6. Active - ticked by default. Leave as is. 
    Image Removed
  6. Click Save to create the custom field.

2. Edit a product (or category) to include this new data

    Navigate to Products & Categories → Product Maintenance (or Category Maintenance if you added the new field to the Category table).
    Search for the required product (or category) by Code or Description. 

    • .

      Expand
      titleClick here for an explanation of display types...


      Tip
      titleWhat is...
      • integer -  a whole number
      • boolean - functionality that only has two possibilities: ON or OFF, YES or NO etc



      Display TypeAvailable for Data TypeExample
      Text BoxText, Integer, Decimal

      One line text box

      Image Added

      Multi-line Text BoxText

      Image Added

      HTML Text BoxText

      WYSIWYG content editor that allows the text to be formatted

      Image Added

      XML Text BoxText

      Image Added

      Dropdown ListText, Integer, Decimal

      Image Added

      Image SelectorText

      Image Added

      Numeric Text BoxInteger, Decimal

      Image AddedImage Added

      Date PickerDateTime

      Image Added

      Time PickerDateTime

      Image Added

      Date/Time PickerDateTime

      Image Added

      Check box (toggle)Boolean

      Image Added

      NOTE - displays as a toggle




    • Allow Unlimited Text - (for Text Display Type only) tick to allow unlimited amount of text 
    • Mandatory - tick to make the custom field required on the page it displays in.
    • Active - leave ticked for the field to be in use. Untick to make inactive.
      Image Added

  2. To save the custom field, click Save.


2. Edit a record to include data from a custom field

Where a custom field displays depends on the table it was added to. 

TablePage
  • Articles
Article Maintenance → Edit Article 
  • Banners
Banner Maintenance → Edit Banner
  • Categories
Category Maintenance → Maintain Category
  • Products
Product Maintenance → Maintain Product
  • Promotions
Promotion Codes → Edit Promotion Code
  • Users

Website Users → Edit User


To add/edit custom field data, 

  1. Navigate to the page the custom field is on.

  2. Click Edit.

  3. Scroll to the Custom Fields section.
    Image Added

  4. Edit the data as required.
    Image Removed

  5. Click Save. 


3.

...

Enable website users to view the custom field

...

on your website. (For Products and Categories only)


  1. Navigate to Content → Standard → Pages & Templates.

  2. Select the page template you'd like to display the custom field on. In this example we'll use the Product Detail template.. 
    1. Custom Product fields are commonly displayed on the Product Detail Template.
    2. Custom Category fields are commonly displayed on the Product List or Category List Template. 

  3. Locate the appropriate zone for you want the custom field widgetto display in. The optimal location will depend on your layout.

  4. Click the Add Widget button.

  5. Search for the required widget (for example 'Product List Field' or 'Category List Field' widget). 

  6. Click the Add button. 
  7. The widget editing popup will appear for you to configure the options:
  8. Description - a descriptive reference for the Administrator on the layout page. This does not display on the front-end website.
  9. Layer - this widget can be rendered conditionally based on role or customer, or displayed under all conditions (All Pages).
  10. Product Field - select the new custom field from the drop-down list. The format will be the Field Name prefaced with 'CUS_'.
  11. Show Heading - tick this box to include a heading for this widget.
  12. Heading Text - the heading text displayed to the end user.
  13. Fallback Information - default text can be entered, to be displayed against products with no data in this field.
  14. Show Toggle - allows the content to be hidden by default, and displayed when the user clicks on the Heading.

    16. Show Inline Heading - allows the heading to be displayed in line with the field content (ignored when toggle is in use).
    Image Removed
  16. Configure options for field display:
  17. Click Save.


The custom field widget will now render on the relevant product relevant  template.



Related help

Content by Label
showLabelsfalse
max5
spacesKB
showSpacefalse
sortmodified
reversetrue
typepage
excludeCurrenttrue
cqllabel = "product_contentcustom-field" and type = "page" and space = "KB"
labelskb-how-to-article

...