Active Data for Developers

Customize your application’s active data processing by using business objects, and B2C Commerce API pipelets and scripts.

Business Objects

The following business objects, which you can customize, support this feature:

API Pipelets

The following pipelets support active merchandising:

Pipelet Description
ImportActiveData Imports either ProductActiveData or CustomerActiveData attributes from a .csv file. The feed name contained in the file determines both the type of data and feed for the import process.
ValidateActiveDataFile Validates the given active data .csv file and returns a status for the results of the validation. If the validation operation executes without process errors, regardless of the .csv file’s validity, the pipelet returns next. It then continues to the next node in the pipeline. If the given file doesn't exist in the given path the pipelet exits in a pipelet error.
Search Retrieves search results. A SortingRuleID input parameter represents the ID of the sorting rule used to sort the products. The existing parameters SortBy1, SortBy1Direction, SortBy2, SortBy2Direction, SortBy3, and SortBy3Direction, can also be used with explicit sorting attribute steps in sorting rules.

API Scripts

The following classes support active merchandising:

Class Description
ActiveData Represents the active data for an object in B2C Commerce.
CustomerActiveData Represents the active data for a Customer in B2C Commerce.
CustomerGroup See Dynamic Customer Groups.
ProductActiveData Represents the active data for a Product in B2C Commerce.

Active Data

The following classes directly support active data:

The following classes support active data:


The following classes support searchandising sorting rules:

The following properties and methods in the dw.catalog.ProductSearchModel class support searchandising:

The following methods of the CatalogMgr class support searchandising:

Note: The scripting API provides read, but not write, access to all active data metrics.

Dynamic Customer Groups

The following scripting APIs support dynamic customer groups:

Returns... Storefront Sessions Job Sessions
Dynamic customer groups x  
Static customer groups x x
System groups: Everyone and Registered x x
System groups: Unregistered x  

Customer#isMemberOfCustomerGroup also checks for memberships in dynamic groups.

X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.