HomeGuides
Submit Documentation FeedbackJoin Developer CommunityLog In

Custom properties

This topic describes an overview of custom properties.

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.

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 Cloud 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 drop-downs, 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.


Did this page help you?