Versions Compared

Key

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


Table of Contents

Overview

The Table Maintenance feature is available only to websites on versions 4.29+. As
Note
Note

 As a Table Maintenance solution is always custom, consultation with Commerce Vision is required to implement this feature. 


Table of Contents

Overview


Multiexcerpt
hiddentrue
MultiExcerptNameFeature Overview

Implement and maintain custom tables and fields for custom business functions or projects on your website. 

As you may know, much of the The content published on your website, whether for products, users etc, are stored as records in database tables. Each record contains data organised across several fields. Certain tables and fields come standard for functions and features of your Customer Self - Service eCommerce Platform website functions. For instance, a product 's details are stored in a table with various specific fields for description, images, product code, and so on. But every business is unique and for some functions, having custom fields or even custom tables might be the solution. In fact, your site may already be using some non-standard fields, e.g., through Field Groups. 


What if your business wants to be able to add and maintain records from a maintain an entire non-standard table online? The This is what the Table Maintenance feature does. It provides a simple integrated way to do just this create and maintain custom tables in the CMS. What a custom table is for depends on your specific business needs! It could be a table from the ERP that would be useful for your staff to access online. Or it certain staff can access and edit online, such as an existing price book. Or the price book could be a completely new table with a new function that will be maintained and accessed entirely online. Both possibilities and more can be custom Table Maintenance solutions.  


Once implemented by Commerce Vision, Table Maintenance lets Administrators can add one or more custom tables and records to the CMS, as well as set permissions for record maintenance and viewing. When a User first accesses a table's maintenance page (via the navigation menu), the list of all records are displayed. They can then find the record they want to view or update, then click Edit to enter into the record's details.


What the user can see and do in both the Search List and each record's page are set by the Administrators in Table Maintenance.

Search List pageRecord page

This is an example of the Search List page. When the custom table was set up, permission to add records was enabled. 

Image Added

This example is a record from our price book. Users with access can edit all fields since the Administrator has set them to editable. * indicates mandatory fields. 

Image Added


Configure Table Maintenance Settings

NOTE - This guide assumes that Commerce Vision has configured the required custom tables and fields to be made available for selection in the CMS.   Configuration of settings is available only to Administrators. Table Maintenance settings are used to add and arrange available tables so they are displayed in the CMS menu as you want them, and to select what functions are available online (to each table's fields) to maintain records.In order to demonstrate the feature's functionality, the examples shown use generic fields.  


Table Maintenance settings are configured by Administrators. 

1. Enable Table Maintenance

  1. In the CMS, navigate to Settings → Feature Management → Advanced.  

  2. Toggle ON Table Maintenance to enable it in the CMS. (If you have any tables set up already, they will now be visible in the CMS navigational menu.)

  3. Click Configure.  


  4. In the Table Maintenance Features Settings screen, toggle ON Enable Table Maintenance to switch on Table Maintenance on your site and enable Table Maintenance settings.


  5. To save this setting,  click Save or Save & Exit. Table Maintenance is now enabled in the CMS and on your website.

2.

...

Create and configure a table


NOTES - Table Maintenance must be enabled (Step 1). Available tables from the ERP have been flagged for editing only by Commerce Vision. They cannot be created or deleted.

...

This step allows you to add or edit a table, configure its location on the CMS navigation bar, and set record access and editing functions.  When a table is added, the system creates a Searchable searchable List page for all its records. The User can select an available record to view or edit it. Depending on settings, they can also create new records

In the Tables panel of the Table Maintenance Features Settings screen, click Add Table
Image Removed 

...

and

...

edit

...

In this example, each line represents an added table. To edit a table, click its Edit button.   

...

Image Removed

    

existing ones. As a simple example, we will create two price books using two custom tables, one for B2B customers and the other, B2C ones.


Whether you're adding or editing a table, you will be taken to the Custom Table Header page. Here, you can

...

:
(i)

...

select the custom table
(ii) make the
table

...

active (

...

or not) in the CMS

...

,
(ii) place the table

...

somewhere on the CMS navigation menu,
(iii) enter the page title for the table

...

when it displays in the Search list and records pages,
(iv) what fields Users can search by when looking up records,
(v) the range of functions available for each field for record maintenance.  

(i) Make a table page active/inactive 

...


...

To create a custom table:

  1. In the Tables panel of the Table Maintenance Features Settings screen, any custom tables already set up are listed and can be edited or deleted. Each line represents an added table.

    To edit a table, click its Edit button. Since we are adding a new table, click Add Table

    With pre-existing tablesWith no pre-existing tables

    Image Added

    Image Added


  2. The first step is to select a table. Scroll down to the bottom of the page and select a table from Table available for maintenance. Here will select the 'Product Table'.
    Image Added
  3. Toggle Is Active ON or OFF. If  When active, the table's page is included in the CMS navigation bar, and its Search and Edit pages to be displayed in the CMSare visible. If inactive, the table page cannot be accessed in the CMS and is hidden on your website.

...


  1. Configure

...

  1. the

...

  1. location of access to the table on the

...

  1. In Table Available for Maintenance, select an available table.

    CMS navigation menu. It can be placed anywhere under any existing parent menu. 

    Expand
    titleClick here to view an example...

    Image Added


    1. In Sequence, add a number. This
    orders
    1. is the
    appearance
    1. order of the table as
    a menu
    1. an item on the parent menu when there are more than one menu
    item
    1. items.
     In
    1. In Page Icon, select an icon to display next to the menu item name.
    In
    1. In Menu Group, select the CMS
    main
    1. parent menu under which this table will be grouped. 
    2. In Menu Parent Item, enter the name of parent menu item.
    In
    1. In Menu Label, enter the name of table as menu item.
    Expand
    titleClick here to view an example...

    Image Removed

...


  1. Add the page title name for the

...

When a User first enters a table's maintenance page, they see the records list. They can then find the record they want to view or update, then click Edit to enter into the record's details. What the user can see and do in both the Search List and record detail page are set here.

To configure fields:

  1. In Table Available for Maintenance, select an available table.
    In Page Title, enter a the heading name that will appears for the table page.
    In List Items and Records pages.
    Image Added

  2. In Page Title Suffix, enter the record description that is appended to the page title in the record details page. Default: the placeholder: {Description}. This retrieves the existing description of the record from the databasetable
    Expand
    titleClick here for an example...

    Image Removed

...

  1. Image Added

  2. Click Save.

  3. Configure fields for the Search and Edit record pages.  In Table Maintenance Tables, click Edit for a table.
    Image Removed
    Scroll down to the (Or just continue after step 7 if creating a new table)

  4. In Search and Edit Fields

    section.  You will see a summary of the field names and prompts (what names Users will actually see) and access and editing permissions for the Search Fields and the Edit Fields.
    Image Removed

    , any existing configurations for the fields will be displayed. (If no fields have been configured, the panel is blank.)


    Fields configuredNo fields configured

    Image Added

    Image Added




  5. Click the Configure Search & Edit Fields button. 

  6. To edit the fields, click the Configure Search & Edit Fields button. The Select Fields window, displaying all fields, now appears.  


    Image Removed

    You can do the following:

    1. change

      the

       the field name (Prompt) displayed to users (by editing each Prompt) NOTE - Field Names in the first column cannot be changed. 

    2. select which  which fields will be viewable and searchable on the Search List (by toggling ON/OFF each setting)
    3. select select which fields will be viewable, can be edited (or Read Only), and must not be blank (Mandatory) (by toggling ON/OFF each setting).
    To

    1. Image Added
  7. To save your settings, click OK.   

  8. When you have finished configuring the table, click Save or Save & Exit to save any changes. 


Once your tables have been set up as you want them, its records can be accessed via the navigational menu by Users with Table Maintenance RolesCMS navigation menu.

Allow a CMS User access to Table Maintenance

Administrators can specify which CMS Users can access to Table Maintenance. This is based on Role settings. 

...

Refer to the CMS User guide for help in setting a Role for a CMS User, 


Additional Information

Multiexcerpt
hiddentrue
MultiExcerptNameAdditional Info
--

...

Minimum Version Requirements


Multiexcerpt
MultiExcerptNameMinimum Version Requirements

4.31 

Multiexcerpt include
MultiExcerptName4.29
PageWithExcerptLTS 2021 actual min. versions


Prerequisites


Multiexcerpt
MultiExcerptNamePre reqs



Self Configurable


Multiexcerpt
MultiExcerptNameSelf Configurable

Yes after initial consultation


Business Function


Multiexcerpt
MultiExcerptNameBusiness Function

Content


BPD Only?


Multiexcerpt
MultiExcerptNameBPD Only

Yes


B2B/B2C/Both


Multiexcerpt
MultiExcerptNameB2B/B2C/Both

Both


Ballpark Hours From CV (if opting for CV to complete self config component)


Multiexcerpt
MultiExcerptNameBallpark Hours From CV (if opting for CV to complete self config component)

Contact Commerce Vision


Ballpark Hours From CV (in addition to any self config required)


Multiexcerpt
MultiExcerptNameBallpark Hours From CV (in addition to any self config required)

Contact Commerce Vision


Third Party Costs


Multiexcerpt
MultiExcerptNameThird Party Costs

n/a


CMS Category


Multiexcerpt
MultiExcerptNameCMS Category

 --


Related help

Content by Label
showLabelsfalse
max5
spacesKB
showSpacefalse
sortmodified
reversetrue
typepage
excludeCurrenttrue
cqllabel = "custom-field" and type = "page" and space = "KB"
labelshow-to cms settings

...