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.ccProductIndexBuilder.cleanAndBuild

Executes the ccrz.ccProductIndexCleanupJob batch job before the next build process begins. The ccrz.ccProductIndexCleanupJob batch job removes existing product index records where the Active field is FALSE.

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

Signature

global static Map<String, Object> cleanAndBuild(Map<String, Object>)

Inputs (Optional)

Map<String, Object> that can include the following keys:

ccrz.ccApiProductIndex.CLEAN_ONLY
Boolean
Value Usage
TRUE The next build process updates product index records only for products where Product Index Status is Not Current.

When an admin selects Update Only Outdated Products when refreshing product index records, this key value is set for this method.

Note

FALSE (default) The next build process updates product index records for all the org's products.
ccrz.ccApiProductIndex.LOCALES
Set<String> of specific storefront locales, including specific and generic locales, whose existing product index records you want to clean.
new Set<String>{'Locale_1', 'Locale 2'}

If you don't specify any locales, the method evaluates all locales across all your org's storefronts.

ccrz.ccApiProductIndex.MASTER_PRICE_LIST
String that specifies the ID of the storefront's master price list, if applicable.
ccrz.ccProductIndexBuilder.BATCH_JOB_PRODUCT_SCOPE
Map<String, Object> that specifies a range of product IDs to build product index records for. The ccrz.ccProductIndexBuilder.getBatchScopeValues method determines this range. The map's START_KEY specifies the beginning of the range, and the END_KEY specifies the conclusion of the range.

This key is available only in B2B Commerce for Visualforce Spring ’20 (version 4.12) or later.

Note

Outputs

Map<String, Object>, which contains the same input data that was passed toccrz.ccProductIndexCleanupJob.