ccrz__E_PageLabel__c

Represents a page label record, which defines buyer-facing text on the storefront, such as headings, buttons, and error messages. Each page label record is specific to one storefront and one locale.

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.ccApiI18N

Fetch sizing: The ccrz.ccApiI18N.fetchPageLabels method returns the ccrz.ccApiI18N.PAGE_LABELS output, where each page label includes only the following fields:

  • Page Label Name
  • ValueRT

Fields

Page Label Name
The name of the page label record.
Usage Field Name Data Type
Input on object Name Text (80)
Input or output with API (with any data size) pageLabelName String
Page Name
The name of the storefront page where the page label applies. The value All specifies that the page label applies to all pages, where applicable.
Usage Field Name Data Type
Input on object ccrz__PageName__c Text (80)
Input or output with API (with any data size) The API doesn't return data for this field.
PageLabelId
A unique ID that associates the record with an external system.
Usage Field Name Data Type
Input on object ccrz__PageLabelId__c Text (255)
Input or output with API (with any data size) The API doesn't return data for this field.
Sequence
Formula that determines the relative priority of the page label record by trying to match a specific page name, storefront, and locale.
Usage Field Name Data Type
Input on object ccrz__Sequence__c Formula (Number)
Input or output with API (with any data size) The API doesn't return data for this field.
Storefront
The storefront where the page label applies. If the value of this field is Global, the page label applies to all storefronts.
Usage Field Name Data Type
Input on object ccrz__Storefront__c Text (50)
Input or output with API (with any data size) The API doesn't return data for this field.
ValueRT
The text of the page label for a specific storefront, locale, and page name.
Usage Field Name Data Type
Input on object ccrz__ValueRT__c Text Area (Rich) (32768)
Input or output with API (with any data size) value String

Deprecated Fields

The following fields exist on the object but aren't used by the managed package. Don't use these fields in any development or customization.

Field Label Field Name Data Type
Value ccrz__Value__c Text Area (Long) (32768)