HomeGuides
Submit Documentation FeedbackJoin Developer CommunityLog In

Application Dictionary

This topic describes the application dictionary.

Synopsis

B2B Commerce Cloud is, at its core, an extensible platform. It is common to extend entities to support back office systems such as ERPs. In this chapter you will learn how to extend B2B Commerce Cloud entities using out of the box platform extensions.

The Application Dictionary is the backbone of the Admin Console, controlling field names, field labels, language options, field length and securing access and data requirements based on assigned User Roles. Because the Application Dictionary is so vital to the Admin Console (improper use will cause issues on your site), access to it is restricted to ISC_System, ISC_Admin, and ISC_Implementer roles.

The Application Dictionary is structured around the Entities within the Admin Console. There are multiple Properties within each Entity. Both Entities and Properties can be configured individually to be hidden, visible, and/or editable. This is important to understand, as it may be necessary to change these settings to expose certain Entities or Properties that are not exposed or editable by default.

Below are high-level descriptions of the various components of the Application Dictionary.

Entities

Entities are outlines of objects with various properties assigned to them in the Admin Console. These entities are hardcoded into the B2B Commerce Cloud and cannot be created without custom coding.

Properties

Properties are attributes attached to entities. If the entity is displayed within the UI, then the properties are fields and other content displayed on the page. Properties can be created without the need for custom development.

Control types and data validators

Control Types are the UI elements displayed in the Admin Console, depending on the type of data to be displayed. Common control types are drop-downs, toggle switch controls, 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 properties can be secured or made visible either at the entity level or the property level. Security also can be handled at the role level, with individual roles given access to pages or entities on a page 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?