Store publish parameters
Before you publish a new store, you must update the store publish parameters in the gradle.properties file to override default values during store creation.
You can add any of the following parameters to further customize your store. For example, you might want to override default values to create an extended sites store to use an existing catalog asset store. If you want to keep default values, then you do not have to add the parameters.
Parameters common to all store types
Property | Default value | Description |
---|---|---|
crsGenerateSampleData |
yes | Indicates whether to generate sample data for the store, such as sample categories, products, marketing activities, and store locations. |
crsStoreLocale | en_US | The default store locale for your new store. Only one value
can be added here. To create stores for multiple locales, complete this task for each required locale. For more information about the supported store locales, see Supporting globalization. |
crsStoreType | b2c | Indicates whether the store is a B2C or B2B store. |
Extended sites store parameters
Property | Default value | Description |
---|---|---|
crsCreateESiteStore | Indicates whether to create extended site store data.
Supported values are yes and no. If the value is no, you can manually load store data in the proceeding task. |
|
crsESiteStoreIdentifier | The name of the store that shoppers access. Avoid spaces and other non-alphanumeric characters in the store name. |
|
crsESiteStoreDirName | The name of the store directory. | |
crsInventoryModel | Non-ATP | This name represents the inventory model for your new created
store. The following inventory models are supported:
For more information about inventory models, see Inventory allocation. |
crsESiteStoreOrganizationDN |
Optional | Enables you to publish an extended store that shares its
organization with an existing extended store. The value is the
DN of the organization that owns a current extended site.
For example, a DN could be
|
crsESiteStoreOrganizationDN=ou=auroraesiteb2c organization,o=extended sites seller organization,o=root organization
Catalog Asset store parameters
Property | Default value | Description |
---|---|---|
dataTemplate |
WCDE_installdir/starterstores/DataTemplate.zip | Indicates the data template file that is to be used by the
addStore scheduler job to generate store
publish data.To use your own custom data template file, create the ZIP file in the WCDE_installdir/starterstores directory, and then specify the file name as the parameter value. |
crsCreateCatalogAssetStore | Indicates whether to generate data files of a new catalog
asset store. Supported values are yes and
no. Set this value to no when you only want to publish a store based on an existing catalog asset store. If set to yes, you must also update crsCatalogStoreIdentifier and crsCatalogStoreDirName properties. If set to no, update only crsCatalogStoreIdentifier, indicating the existing store's directory name to crsCatalogStoreDirName. |
|
crsCatalogStoreIdentifier | The catalog asset store identifier name. | |
crsCatalogStoreDirName | The name of the catalog asset store directory. | |
crsCatalogAssetStoreOrganizationDN |
Enables you to create a catalog asset store that shares its
organization with an existing catalog asset store. The value is
the distinguished name (DN) of the organization that owns a
current catalog asset store. For example, Extended Sites
Catalog Asset Store .
|
crsCatalogAssetStoreOrganizationDN=ou=extendedsitescatalogassetstore,o=extended sites organization,o=root organization
Storefront Asset store parameters
Property | Default value | Description |
---|---|---|
dataTemplate |
WCDE_installdir/starterstores/DataTemplate.zip | Indicates the data template file that is to be used by the
addStore scheduler job to generate store
publish data.To use your own custom data template file, create the ZIP file in the WCDE_installdir/starterstores directory, and then specify the file name as the parameter value. |
crsCreateStoreFrontAssetStore | Indicates whether to generate data files of a new storefront
asset store. Supported values are yes and
no. Set this value to yes when you want to create a new storefront asset store that is based on the following two input parameters: crsFrontAssetStoreIdentifier and crsFrontAssetStoreDirName. Set this value to no when you want to publish an extended site store that is based on an existing storefront asset store. Then, you must indicate the existing store identifier with crsFrontAssetStoreIdentifier, and indicate the existing store directory name with crsFrontAssetStoreDirName. |
|
crsFrontAssetStoreIdentifier | The storefront asset store identifier name. | |
crsFrontAssetStoreDirName | The name of the storefront asset store directory. | |
crsStorefrontAssetStoreOrganizationDN |
Required | Enables you to create a storefront asset store using an
existing organization. The value is the DN of the organization
that owns a current Storefront asset store. For example,
AuroraStorefrontAssetStore . If the value
of this variable does not exist in the database, a new
organization record will be created and this value will be
assigned to the new organization's DN. The new
organization's name follows the pattern
If this value already exists
in the DN column of the |
crsStorefrontAssetStoreOrganizationDN=ou=aurorastorefrontassetstore,o=extended sites organization,o=root organization
Properties for React Stores
Property | Default value | Description |
---|---|---|
dataTemplate |
WCDE_installdir/starterstores/EmeraldDataTemplate.zip | Indicates the data template file that is to be used by the
addStore scheduler job to generate store
publish data.To use your own custom data template file, create the ZIP file in the WCDE_installdir/starterstores directory, and then specify the file name as the parameter value. |
crsStoreServerAssets | yes | This setting is used to determine if any store asset is
deployed to the Store server.
Set to no to publish the React Stores. Set to headless to publish the React Stores. |
enableExternalContent |
no | Set to yes to enable integration with HCL Digital Experience. |
imagePath=/hclstore |
/hclstore | This setting is for setting an image path parameter. |
Example of the properties required to create a B2B extended site
dataTemplate=w:/starterstores/DataTemplate.zip
crsCreateESiteStore=yes
crsESiteStoreIdentifier=AuroraB2BEsite
crsESiteStoreDirName=AuroraB2BEsite
crsCreateStoreFrontAssetStore=no
crsFrontAssetStoreIdentifier=AuroraB2BStorefrontAssetStore
crsFrontAssetStoreDirName=AuroraB2BStorefrontAssetStore
crsCreateCatalogAssetStore=no
crsCatalogStoreIdentifier=Extended Sites Catalog Asset Store
crsCatalogStoreDirName=ExtendedSitesCatalogAssetStore
crsGenerateSampleData=yes
crsStoreLocale=en_US
crsInventoryModel=Non-ATP
crsStoreType=b2b