Loading...
Area: Optimizely B2B Commerce

Overview of Custom Properties

Recommended reading 

The Application Dictionary, housed within the Admin Console, manages entities that control such data as field names, field labels, language options, field length, and site security.

Note: The tables in the Admin Console are generic and are run from standard Odata. Since the data for the tables and custom properties are in different entities, there is no current way to include custom properties as columns in Admin Console tables.

Entities

Entities are outlines of objects in the Admin Console with various Custom Properties assigned to them. These entities are hard coded in B2B Commerce and cannot be created without custom coding.

Custom Properties

Custom Properties are attributes attached to entities that can be created without custom development. If the entity is displayed within the UI, then the Custom Properties will be fields and other content displayed on the page. Custom Properties, by default, are hidden and do not present themselves to the API unless otherwise restricted. This restriction must be set on BOTH the CanEdit and CanView on the permissions.

Control Types and Data Validators

Control Types are the UI elements displayed in the Admin Console, depending on the type of data retrieved. Common control types are dropdowns, toggle switch control, and text fields.

Data Validators are the ways the data found in the Control Type is validated. Common data validator properties are Regular Expression, MultiValueList, and DefaultValue.

Permissions

Site security is managed within the Application Dictionary. Each entity and their respective Custom Properties can be secured or made visible either at the entity level or the Custom Property level. Security also can be handled at the role level, with individual roles given access to pages or page entities depending on the given use case.

NOTE: Custom Properties configured in the Admin Console are stored within the Custom Properties table and are not extendable to other platforms, such as an ERP, without development time.
Do you find this information helpful? Please log in to provide feedback.

Last updated: Dec 11, 2020

Recommended reading