Versions Compared

Key

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


Excerpt
hiddentrue

Use, group and maintain field groups.


Customer Self Service features 'Field Groups', which allows fields from a database table to be grouped together. The Field Group can then be used to present the fields to a user on a particular page of the website. 


Examples of Field Groups in use would be: 

  • User Registration page
  • Checkout Address fields
  • User Maintenance screens
    User Maintenance - example of a Field Group

Step-by-step guide

To Create a Field Group:

  1. Login as an Administrator.
  2. Navigate to 'Settings' --> 'Field Groups' (/zFieldGroups.aspx).
  3. Click 'New'.
  4. Update values as follows:
    1. Table Name - the table name from the CSS Dictionary. Examples of common table names are PRODUCT, USER, CUSTOMER, PRONTOSALESORDER.
    2. Field Group Name - a unique code/name for the new Field Group.
    3. Field Group Description - a description for the use of the Field Group (e.g. 'User Administration').
    4. Lookup Description -  leave blank.
  5. Click 'OK' to save.
  6. Click 'Refresh Dictionary' to refresh the site's cache.
    Field Group - New entry 


Once the Field Group has been created, it can be populated with Fields.

To Add Field Group Fields: 

  1. Login as an Administrator. 
  2. Navigate to 'Settings' --> 'Field Groups' (/zFieldGroups.aspx).
  3. Search for the required Field Group.
  4. Select the record via radio button.
  5. Click 'Fields'; the Field list screen will load.
    Field Group fields 
  6. Click 'New' to add a new Field.
  7. Update values as follows:
    1. Field Name - select from the drop-down list. (If the required field does not already exist, it will need to be defined in the CSS Dictionary.)
    2. Field Sequence - the order in which the field will appear to the user.
    3. From Version - if required, specifies that this field should only be available in a specific version or later.
    4. Grid Formatter - restricts the field value to a particular data type (e.g. numeric, date, etc). Can be left at default / 'Please Select'.
    5. IsHidden - tick if the field should not be made visible to the user.
  8. Click 'OK' to save.
  9. Repeat Steps 6 - 8 as required.
  10. Click 'Refresh Dictionary' to refresh the site's cache.


To Maintain Field Group Fields:

  1. Login as an Administrator. 
  2. Navigate to 'Settings' --> 'Field Groups' (/zFieldGroups.aspx).
  3. Search for the required Field Group.
  4. Select the record via radio button.
  5. Click 'Fields'; the Field list screen will load.
  6. Select the required Field via radio button.
  7. Click 'Modify' to edit.
  8. Click 'Delete' to remove.
Warning

 It is recommended that field group fields are never deleted, but rather hidden (unless the field group has been created by the editing user). Otherwise, the field will be added back in during a site upgrade.


Info

When changes are made to Field groups, including creating and removing fields, the website's cache needs to be refreshed for the changes to be visible on the site.
After updating a field group or the field group fields, click the 'Refresh Dictionary' link. The Cache can also be refreshed by navigating to zDictionary.aspx and clicking the 'Refresh Cache' button.

Related help

Content by Label
showLabelsfalse
max5
spacesKB
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel in ("field-groups","reporting") and type = "page" and space = "KB"
labelskb-how-to-article field-groups