View Source

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

Overview

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

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. For instance, product details are stored in a table with specific fields for description, images, product code, and so on.

What if your business wants to be able to maintain an entire non-standard table online? This is what the Table Maintenance feature does. It provides a simple integrated way to 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 certain staff can access and edit online, such as an existing price book. Or the price book could be a completely new table that will be maintained and accessed entirely online. Both possibilities and more can be custom Table Maintenance solutions.

Once implemented by Commerce Vision, 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 page	Record page
This is an example of the Search List page. When the custom table was set up, permission to add records was enabled.	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.

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. 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

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

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.)

Click Configure.

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.

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 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 and edit 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.

To create a custom table:

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 tables With no pre-existing tables

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'.
Toggle Is Active ON or OFF. When active, the table's page is included in the CMS navigation bar, and its Search and Edit pages are visible. If inactive, the table page cannot be accessed in the CMS.

Configure the location of access to the table on the CMS navigation menu. It can be placed anywhere under any existing parent menu.

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

Add the page title name for the table. In Page Title, enter the heading name that will appears for the List Items and Records pages.

In Page Title Suffix, enter the description that is appended to the page title in the record details page. Default: the placeholder: {Description}. This retrieves the existing description of the table.

Click Save.

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

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

Fields configured No fields configured

Click the Configure Search & Edit Fields button.

To edit the fields, click the Configure Search & Edit Fields button. The Select Fields window, displaying all fields, now appears. You can do the following:
change the field name (Prompt) displayed to users (by editing each Prompt) NOTE - Field Names in the first column cannot be changed.
select which fields will be viewable and searchable on the Search List (by toggling ON/OFF each setting)
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 save your settings, click OK.

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