Option configuration classes

14 min

The configuration options described in the following can all be set from appsettings.json, or through code using .NET 5 (Core). Use Configure<TOptions> 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 effect 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 add or remove handlers or plugins. See Entity objectsEntity objects.

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

Handlers (Default: Optimizely-specified handlers) – Gets or sets handlers used in BusinessManager request processing.

Plugins (Default: Optimizely-specified plugins) – Gets or sets plugins used in BusinessManager request processing.

MetaObjectOptions

Contains a set of meta object-related settings.

MaxListObject (Default: 1000) – Gets or sets the max list object, for example records to retrieve from meta object system while querying.

UseCache (Default: false) – Gets or sets a value indicating whether cache should be used while querying.

CacheItemExpiration (Default: 30) – Gets or sets the cache item expiration in seconds.

UseSPOptimization (Default: false) – Gets or sets a value indicating whether [use sp optimization].

SPItemExpiration (Default: 10080) – Gets or sets the SP item expiration in minutes.

Instances (Default: Empty) – Gets or sets the business object services; list of MetaObjectInstance objects.

Types (Default: Empty) – Gets or sets the types; List<MetaObjectType>

MetaDataOptions

Contains a set of meta data-related settings.

CacheExpiration (Default: 10 minutes) – The default expiration time.

DisableVersionSync (Default: false) – Gets the value of the DisableVersionSync appSetting, indicating whether an update to Catalog content done outside the Content APIs will remove any version data (for example drafts, old published versions) for the affected content. Setting this to "true" can improve the speed of batch operations done through the lower-level APIs such as ICatalogSystem, in for example the catalog import.

AllowUntypedCatalogContent (Default: false) – Allows for no models to need to exist for catalog content.

RemoveOrphanedMetaKeysBatchSize (Default: 10000) – Batch size for remove orphaned key job.

CatalogOptions

Contains settings for the Catalog subsystemCatalog 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"
        }
        ]
      }
    }
  }
}

AutoConfigure (Default: true) – Determines whether to auto-configure the Catalog system when first initialized.

Cache (Default: See CatalogCacheOptions) – Contains options for the catalog cache system. Instance of CatalogCacheOptions.

SalePriceTypes (Default: Empty) – Configures SalePriceTypes; List<SalePriceTypeDefinition>

ShowVariationListPrice (Default: false) – Enables the display of the obsolete variation list price in the catalog entry edit user interface.

CatalogImportBatchSize (Default: 200) – Gets or sets the batch size of the entries when importing a catalog.

CommandTimeout (Default: -1) – Gets or sets a value indicating whether to use a custom SQL command timeout or not in seconds.

CatalogEventLevel (Default: CatalogEventLevel.All) – Used to control which events are raised remotely.

DisableCatalogEventDrivenIndexing (Default: false) – Disables event indexing for the Commerce Connect search provider, not Search & Navigation (Find).

SkipCatalogContentModelCheck (Default: false) – Disables validating models exist in the application domain.

IgnorePropertyAndMetafieldMisMatch (Default: false) – Ignores Meta field mismatches in catalog content scanning.

SimplifiedCatalogListingThreshold (Default: 2000) – Number of records in which the catalog listing view does not group products and variants.

DraftMigrationBatchSize (Default: 5000) – Batch size when migrating legacy drafts to the new version store.

DraftMigrationTimeSpan (Default: 1) – Timeout for draft store migration from legacy to new version store in hours.

CatalogCacheOptions

Contains settings for the Catalog subsystem caching.

UseCache (Default: true) – Indicates if the cache is enabled.

ContentVersionCacheExpiration (Default: 10) – Expiration time for catalog content versions.

CollectionCacheExpiration (Default: 15) – Expiration time for catalog relations, catalog associations, catalog nodes, catalog entries, catalog, tax categories, and merchants.

EntryCacheExpiration (Default: 15) – Expiration time for entries.

NodeCacheExpiration (Default: 15) – Expiration time for nodes.

CurrencyCacheExpiration (Default: 1 hour) – Expiration time for currencies.

IdentityResolverCacheExpiration (Default: 10) – Expiration time for the identity resolver.

InventoryCacheExpiration (Default: 5) – Expiration time for inventory.

PriceCacheExpiration (Default: 10) – Expiration time for price.

PriceDetailsCacheExpiration (Default: 10) – Expiration time for price details.

UriValidationOptions

Contains settings for URI validation, see RoutingRouting.

UseLessStrictEntryUriSegmentValidation – Gets the value of episerver:commerce.UseLessStrictEntryUriSegmentValidationAppSetting, indicating whether validation of entry URI segments should be strict or not. Strict validation means URI segments must be globally unique (for the language) to make sure all hierarchical routes to entries will work despite any crosslinking that happens after the URI segment was saved. With less strict validation, the URI segment will still be validated for uniqueness against sibling items. However, because this validation occurs at the time of saving, cross-linking items can create collisions in hierarchical routes.

ApplicationOptions

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

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

DefaultApplicationName (Default: "ECApplication") – Defines the default value used for the application name.

Cache (Default: See ApplicationCacheOptions) – Cache settings for the application.

AutoMigrate (Default: true) – Auto-migrate Commerce Connect.

Roles (Default: EPiServer-specified default roles) – Application roles. Key/value dictionary.

Features (Default: N/A) – Configurable application features; SerializedCarts (enabled), WorkflowsVNext (disabled).

ApplicationCacheOptions

Contains settings for Application-related caching.

Enabled (Default: true) – Determines whether in-memory caching is enabled or not.

CustomerOptions

Contains settings for the CustomersCustomers subsystem.

AutoInstall (Default: true) – Gets a value indicating whether to automatically install metadata definitions for entities related to customers/contacts.

DemoInstall (Default: true) – Gets a value indicating whether to automatically install sample customers in the system.

Cache (Default: See CustomerCacheOptions) – Config settings that define where caching is enabled and timeouts related to it.

CustomerCacheOptions

Contains settings for the Customers subsystem caching.

UseCache (Default: true) – Gets or sets whether the cache is enabled.

ContactCollectionCacheExpiration (Default: 1 minute) – Gets or sets the expiration time for the contact collection.

ContactCacheExpiration (Default: 1 minute) – Gets or sets the contact expiration time.

AddressCollectionCacheExpiration (Default: 1 minute) – Gets or sets the address collection expiration time.

AddressCacheExpiration (Default: 1 minute) – Gets or sets the address expiration time.

CreditCardCollectionCacheExpiration (Default: 1 minute) – Gets or sets the credit card collection expiration time.

OrganizationCollectionCacheExpiration (Default: 1 minute) – Gets or sets the organization collection expiration time in minutes.

OrganizationCacheExpiration (Default: 1 minute) – Gets or sets the organization expiration time.

DataOptions

Contains settings for data index management.

DisableRetryPolicy (Default: false) – Disables the retry policy for the SQL data provider.

LowFragmentationThreshold (Default: 10) – Used by the maintain database indexes job.

HighFragmentationThreshold (Default: 30) – Used by the maintain database indexes job.

DataBaseIndicesJobCommandTimeOut (Default: -1 for default timeout (30 seconds)) – Used by the maintain database indexes job.

MarketOptions

Contains settings for the MarketsMarkets subsystem.

CacheExpiration (Default: 5 minutes) – The default expiration time used in MarketService.

OrderOptions

Contains settings for the OrdersOrders subsystem.

NewOrderStatus (Default: InProgress) – Gets the new order status.

AutoConfigure (Default: true) – Gets a value indicating whether to auto-configure the Order system when first initialized.

ShipmentAutoReleaseTimeout (Default: 1 day) – Gets or sets the shipment auto-release timeout.

DisableOrderDataLocalization (Default: false) – Flag to indicate if order data localization is disabled.

MetaClasses (Default: EPiServer-defined meta classes) – Contains the names of meta classes for orders that are stored in the configuration file.

MappedTypes (Default: EPiServer-defined mapped types) – Gets the mapping of order-related entities to their corresponding implementation classes.

Cache (Default: See OrderCacheOptions) – The cache options for Orders.

OrderCacheOptions

Contains settings for the Order subsystem caching.

UseCache (Default: true) – Indicates if the cache is enabled.

IsOrderRepositoryCacheDisabled (Default: false) – Indicates if the order repository cache is disabled.

JurisdictionCacheExpiration (Default: 1 hour) – Expiration time for jurisdictions.

TaxCacheExpiration (Default: 1 hour) – Expiration time for taxes.

CountryCacheExpiration (Default: 1 hour) – Expiration time for countries.

PaymentCacheExpiration (Default: 1 day) – Expiration time for payments.

ShippingCacheExpiration (Default: 1 day) – Expiration time for shipping.

StatusCacheExpiration (Default: 10 seconds) – Expiration time for status.

PickListCacheExpiration (Default: 20 seconds) – Expiration time for pick lists.

OrderCacheExpirationLegacy (Default: 10 minutes) – Expiration time for legacy ordergroups.

OrderCacheExpiration (Default: 10 minutes) – Expiration time for ordergroups.

UserOrderCacheExpiration (Default: 5 minutes) – Expiration time for the user order.

MarketingOptions

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

StatisticsCacheExpiration (Default: 1 day) – The expiration time for marketing statistics.

PromotionInformationCacheExpiration (Default: 10 minutes) – Expiration time for promotion information. TimeSpan object.

LinkableTypesEnabled (Default: false) – Indicates whether Marketing Links in the link selector dialog should be shown or not.

EvaluablePromotionCacheExpiration (Default: 30 seconds) – Expiration time for evaluable promotion.

DiscountedEntryCacheExpiration (Default: 1 minute) – Expiration time for discounted entries.

PromotionOptions

Contains settings for PromotionsPromotions.

PromotionExclusionLevel (Default: ExclusionLevel.Order) – Indicates whether exclusion should be at the order or unit level.

ApplyPromotionUnitIndividually (Default: false) – Define whether to apply promotions to units individually instead of as a group.

UriSegmentConflictsJobOptions

Contains settings for URI conflicts.

EmailRecipients (Default: Empty List<string>) – Recipient's string list that will get an email if any URI conflicts are found.

ReportingOptions

Contains general settings for ReportsReports.

OrderPerPromotionReportDataTimeout (Default: 30) – Timeout in seconds for the query for the order per promotion report.

EnableEventDrivenOrderReporting (Default: false) – Enable event-driven order reporting.

ReportForInactivePromotionItems (Default: false) – Add report for inactive promotion items.

ReportingTimeRangeOptions

Contains settings for reporting time ranges.

TimeRangesInDays (Default: 90) – Date ranges used to generate reports, for example, 30, 90, or 180 days.

SubscriptionTimeRangesInDays (Default: 90) – Date ranges used to generate subscription reports, for example, 30, 90, or 180 days.

CatalogFeedOptions

Contains settings for the catalog feedcatalog feed.

EnableEventDrivenCatalogFeed (Default: false) – Enables event-driven incremental catalog feed.

CatalogFeedBatchSize (Default: 50) – Batch size when processing catalog feed.

CalculateDiscountPrices (Default: true) – Calculate discounted prices for the feed.

MaxEntryProcessForIncrementalCatalogFeed (Default: 10000) – Max entries to process in incremental feed.

SearchOptions

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

The default Commerce Connect installation includes the search provider LuceneSearchProvider, but it is not configured. Use it as-is, or create your own search provider. The following example shows how to configure LuceneSearchProvider in appsettings.json.

"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"
    }]
  }
}

DefaultSearchProvider (Default: N/A) – Gets or sets the default provider.

SearchProviders (Default: N/A) – Gets or sets the search providers.

MaxHitsForSearchResults (Default: N/A) – Gets or sets the max hits for the search result.

IndexerBasePath (Default: N/A) – Gets or sets the base path. The path where properties of the last index will be stored. Each application will have its own folder created.

IndexerConnectionString (Default: N/A) – Gets or sets the connection string where build information will be stored.

Indexers (Default: N/A) – Gets or sets the indexers.