Skip to content

Settings

Overview

Platform settings are collected and delivered to Settings module by all platform modules. Each module can add settings to a standard UI by declaring them in the module manifest.

In VC3 settings are declared in ModuleConstants.cs

Example

public static SettingDescriptor ModuleNameEnabled { get; } = new SettingDescriptor
{
    Name = "ModuleName.ModuleNameEnabled",
    GroupName = "ModuleName|General",
    ValueType = SettingValueType.Boolean,
    DefaultValue = false
};

To view the Platform settings go to VC admin->More->Settings.

Settings

Standard UI allows to view and edit simple settings. As an example, Catalog module settings are displayed on the screenshot below:

Catalog Settings

Settings Description

  1. Name- The system name of the setting. Example, "Catalog.ImageCategories";
  2. Group Name- Defines a named group of settings. Can contain multiple setting elements. Example, "Catalog|General";
  3. Value type- Supported types are: string - for short text (up to 512 characters); secureString - for short text masked with asterisks or circles in UI; text - for long text (longer than 512 characters); integer; decimal; boolean;
  4. Allowed value (optional)- Defines a list of allowed values. Can contain multiple value elements. User can select one of the values in standard UI;
  5. Default Value- Defines the default value which will be returned by GetValue() method if the value has not been stored in database yet.
  6. Is Dictionary- is a Dictionary field type.

You can see the settings definition code: Example


Last update: June 23, 2020