Option configuration classes

The configuration options described in the following can all be set from appsettings.json, or through code using .NET 5 (Core) Configure in the ConfigureServices method of Startup.cs.

📘

Note

Cache expiration variables in Options classes are defined as TimeSpan struct. You can override them with your own representation of TimeSpan struct for cache settings but be cautious of the performance affect it can have on your site.

BusinessManagerOptions

This contains settings for handlers and plug-in collections for meta classes. The ConfigureServices method can be used to to add or remove handlers or plugins. See Work with entity objects.

services.Configure<BusinessManagerOptions>(o =>
    {
        o.Handlers.Add(new CustomRequestHandler(){});
        o.Plugins.Add(new CustomRequestPlugin(){});
    });

MetaObjectOptions

Contains a set of meta object-related settings.

MetaDataOptions

Contains a set of meta data-related settings.

CatalogOptions

Contains settings for the Catalog subsystem. The CatalogOptions cache can be set via appsettings.json using the following syntax.

{
        "Commerce": {
            "CatalogOptions": {
                "Cache": {
                    "UseCache": false
                    "ContentVersionCacheExpiration": "1.02:03:04" //1 day, 2 hours, 3 mins, 4 seconds
                },
                "SalePriceTypes": [{
                        "Key": "AllCustomers",
                        "Value": 0,
                        "Description": "Description",
                        "ControlUrl": "ControlUrl"
                    }
                ]
            }
        }
    }

CatalogCacheOptions

Contains settings for the Catalog subsystem caching.

UriValidationOptions

Contains settings for URI validation, see Routing.

ApplicationOptions

Contains non-feature specific settings. To disable a feature, use the syntax as in the following example for Serializable carts.

{
        "Commerce": {
            "ApplicationOptions": {
                "Features": {
                    "SerializedCarts": {
                        "Feature": "SerializedCarts",
                        "State": 1, // 0 is enabled, 1 for disabled
                        "Type": "Mediachase.Commerce.Core.Features.SerializedCarts, Mediachase.Commerce"
                    }
                }
            }
        }
    }

ApplicationCacheOptions

Contains settings for Application-related caching.

CustomerOptions

Contains settings for the Customers subsystem.

CustomerCacheOptions

Contains settings for the Customers subsystem caching.

DataOptions

Contains settings for data index management.

MarketOptions

Contains settings for the Markets subsystem.

OrderOptions

Contains settings for the Orders subsystem.

OrderCacheOptions

Contains settings for the Order subsystem caching.

MarketingOptions

Contains settings for the legacy _Marketing_subsystem (replaced by the Marketing and campaigns system).

PromotionOptions

Contains settings for Promotions.

UriSegmentConflictsJobOptions

Contains settings for URI conflicts.

ReportingOptions

Contains general settings for Reports.

ReportingTimeRangeOptions

Contains settings for reporting time ranges.

CatalogFeedOptions

Contains settings for the catalog feed.

SearchOptions

Corresponds to the Mediachase.Search.SearchOptions class, containing settings for indexing and search features, see Search.

The default Customized Commerce installation contains the search provider LuceneSearchProvider, but this is not configured. You can use this, or create your search provider. See below how to configure the LuceneSearchProvider in appsettings.json to configure.

"Commerce": {
        "SearchOptions": {
            "DefaultSearchProvider": "LuceneSearchProvider",
            "MaxHitsForSearchResults": 1000,
            "IndexerBasePath": "[appDataPath]\\Quicksilver\\SearchIndex",
            "IndexerConnectionString": "",
            "SearchProviders": [{
                    "Name": "LuceneSearchProvider",
                    "Type": "Mediachase.Search.Providers.Lucene.LuceneSearchProvider, Mediachase.Search.LuceneSearchProvider",
                    "Parameters": {
                        "queryBuilderType": "Mediachase.Search.Providers.Lucene.LuceneSearchQueryBuilder, Mediachase.Search.LuceneSearchProvider",
                        "storage": "[appDataPath]\\Quicksilver\\SearchIndex",
                        "simulateFaceting": "true"
                    }
                }
            ],
            "Indexers": [{
                    "Name": "catalog",
                    "Type": "EPiServer.Reference.Commerce.Site.Infrastructure.Indexing.CatalogIndexer, EPiServer.Reference.Commerce.Site"
                }
            ]
        }
    }