Core policies

Current version: 9.1

The Commerce Engine encompasses extensible services that enable you to customize commerce functionality.

Note

Do not extend or inherit from out-of-the-box policies; instead, create your own. You can change the values in a policy by modifying the PolicySet JSON or the Environment JSON, depending on where the policy is defined and then re-running Bootstrap.

The following policies can be configured through the Core plugin.

Policy

Description

Properties / Default Values

ControllerMethodRolesPolicy

Defines which user roles have access to the different service routes.

ControllerMethodRegularExpression \

AuthorizedRoles \ List<string>

KnownMessageCodePolicy

Defines the code for messages added to entities.

Pricing \"Pricing"

Promotions \ "Promotions"

ListNamePolicy

Defines the naming convention for entity lists.

Prefix \ "List"

Suffix \ "ByDate"

Separator \ "-"

MaxLengthPolicy

Defines the maximum length allowed for text properties.

MaxLengthAllow \ 0

MinMaxValuePolicy

Defines the minimum and maximum value for decimal properties.

MaxAllow \ 0

MinAllow \ 0

PaginationPolicy

Defines settings for pagination.

PageSize \ 10

PageSizeOptions \ List<int> { 5, 10, 25, 100 }

ApprovalStatusPolicy

Defines the status names that are part of the approval processes.

Draft \ "Draft"

Approved \ "Approved"

ReadyForApproval \"ReadyForApproval"

EntityMemoryCachingPolicy

Defines the cache policy for entities.

Expiration \ 300000

AllowCaching \ true

CacheName = string.Empty

CacheAsEntity = true

HasNegativeCaching \ false

EntityFullName = string.Empty

Priority \ string.Empty

KnownResultCodes

Defines the result codes for command requests and messages.

Error \ "Error"

Warning \ "Warning"

Information \ "Information"

ValidationError \ "ValidationError"

LocalizeEntityComponentPolicy

Defines which entity component properties can be localized. 

Path \

Properties \

ActionView \

IsItemComponent \ false

LocalizeEntityPolicy

Defines which entity properties can be localized.

Type \

Properties \

ActionView \

ComponentsPolicies \ Enumerable.Empty<LocalizeEntityComponentPolicy>

EnvironmentInitializationPolicy

Defines which artifact should be initialize for an environment.

InitialArtifactSets \ List<string>

GlobalCurrencyPolicy

Defines global currency settings.

DefaultCurrencySet \ string.Empty

LocalizedTermsCachePolicy

Defines the cache policy for localized terms.

Expiration \ 300000

AllowCaching \ true

CacheName \ "LocalizedTerms"

MinionBossPolicy

Defines settings for a minion boss.

ListToWatch \

FullyQualifiedName \

WakeupInterval \

ItemsPerBatch \ 10

SleepBetweenBatches \ 500

Children \ List<MinionPolicy>()

MinionPolicy

Defines settings for a minion.

ListToWatch \

FullyQualifiedName \

WakeupInterval \

ItemsPerBatch \ 10

SleepBetweenBatches \ 500

NodeHeartBeatPolicy

Defines the behavior of the context node.

LogHeartBeats \ false

PerformancePolicy

Defines performance settings.

WriteCounters \ true

CountersVersion \ string.Empty

PluginPolicy

Defines settings for a plugin.

Plugin \ string.Empty

Icon \ string.Empty

KnownServiceRoutesPolicy

Defines the service routes.

CommerceOps \ "commerceops"

Shops \ "api"

Authoring \ "api"

TransactionsPolicy

Defines settings for transactions.

TransactionalityEnabled \ true

TransactionTimeOut \ 60 (this represents seconds)

AsyncFlowOption \ TransactionScopeAsyncFlowOption.Enabled

ValidationPolicy

Defines validation settings for entities.

TypeFullName \ string.Empty

Do you have some feedback for us?

If you have suggestions for improving this article,