Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

ccrz__E_Configuration__c

Represents a storefront or global configuration setting.

Compatibility

This reference applies to:

Release Managed Package Version API Version
B2B Commerce for Visualforce Winter ’21 4.13 12
B2B Commerce for Visualforce Spring ’20 4.12 11
B2B Commerce for Visualforce Summer ’19 4.11 10
B2B Commerce for Visualforce Spring ’19 4.10 9
B2B Commerce for Visualforce Summer ’18 4.9 8

API Usage

Class used with: ccrz.ccApiConfig

Fetch sizing: The ccrz.ccApiConfig.fetch method returns the ccrz.ccApiConfig.CONFIGURATIONS key, which contains records of this object. The key for each configuration record returned is moduleAPIname.configurationAPIname, such as ct.enabled.

The API doesn't return values from this object's fields.

Fields

CC Configuration Metadata
The metadata record for this specific configuration.
Usage Field Name Data Type
Input on object ccrz__ConfigurationMeta__c Lookup Relationship (ccrz__E_ConfigurationMeta__c)
Input or output with API (with any data size) The API doesn't return data for this field.
Configuration ID
A unique ID that associates the record with an external system.
Usage Field Name Data Type
Input on object ccrz__ConfigurationId__c Text (255)
Input or output with API (with any data size) The API doesn't return data for this field.
Name
The configuration's name, in the format storefront.page.module.configuration.
Usage Field Name Data Type
Input on object Name Text (80)
Input or output with API (with any data size) The API doesn't return data for this field.
Page Name
The page that the configuration applies to. This value is a page key defined in CC Admin global settings, such as hp for Home page and plp for Product List page.
Usage Field Name Data Type
Input on object ccrz__PageName__c Text (255)
Input or output with API (with any data size) The API doesn't return data for this field.
Sequence Priority
Internal use only. Don't modify the value that the managed package assigns to this field.
Usage Field Name Data Type
Input on object ccrz__SequencePriority__c Number (4, 0)
Input or output with API (with any data size) The API doesn't return data for this field.
Storefront
The storefront that the configuration applies to.
Usage Field Name Data Type
Input on object ccrz__Storefront__c Text (255)
Input or output with API (with any data size) The API doesn't return data for this field.
Text Value
The configuration's value.
Usage Field Name Data Type
Input on object ccrz__TextValue__c Text (255)
Input or output with API (with any data size) The API doesn't return data for this field.