1. Customer service

Customer policies

Version:

The Customer plugin contributes configuration policies that define behavior for the functionality provided by the plugin.

Note

Do not extend or inherit from out-of-the-box policies; instead, create your own.

You can change the values of default policies 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 Customers plug-in.

Policy

Description

Properties / Default Values

CustomerPropertiesPolicy

Defines the properties associated with a customer (e.g., name, address, language, account status, etc).

PreviewProperties \ List<string>()

DetailsProperties \ List<string>()

AddressDetailsProperties \ List<string>() AccountNumber \ "AccountNumber"

Email \ "Email"

Password \ "Password"

AccountStatus \ "AccountStatus"

AddressName \ "AddressName"

FirstName \ "FirstName"

LastName \ "LastName"

Language \ "Language"

Country \ "Country"

CountryCode \ "CountryCode"

State \ "State"

StateCode \ "StateCode"

City \ "City"

Address1 \ "Address1"

Address2 \ "Address2"

ZipPostalCode \ "ZipPostalCode"

IsPrimary \ "IsPrimary"

PhoneNumber \ "PhoneNumber"

Organization \ "Organization"

CustomersCachePolicy

Defines the cache policy for the customer status defined in the Control Panel.

Expiration \ 300000 AllowCaching \ true

CacheName \ "CustomerStatuses"

CustomersRemovePolicy

Defines the customer removal policy (i.e., whether deleted customers are removed from the system). If the ForgetCustomer property is set to ā€œtrueā€, the Customer entity is removed from the system (when the Delete Customer action is initiated). If the ForgetCustgomer property is set to ā€œfalseā€, the Customer entity remains in the system, but its status is set to ā€œinactiveā€.

ForgetCustomer \ false

KnownCustomerActionsPolicy

Provides the ability to change the default customer action names (e.g., add a customer, edit a customer).

AddCustomer \ "AddCustomer"

EditCustomer \ "EditCustomer"

RemoveCustomer \ "RemoveCustomer"

AddAddress \ "AddAddress"

EditAddress \ "EditAddress"

RemoveAddress \ "RemoveAddress"

SelectAddressCountry \ "SelectAddressCountry"

GetCountryRegionsForCustomers \ "GetCountryRegionsForCustomers"

KnownCustomersStatusesPolicy

Provides the ability to change the default customer status names (e.g., active, inactive).

ActiveAccount \ "ActiveAccount"

InactiveAccount \ "InactiveAccount"

RequiresApproval \ "RequiresApproval"

KnownCustomerViewsPolicy

Provides the ability to change the default customer view names (e.g., customers, address list, etc).

Master \ "Master"

Details \ "Details"

Addresses \ "Addresses"

AddressDetails \ "AddressDetails"

CustomerOrders \ "CustomerOrders"

Preview \ "Preview"

Customers \ "Customers"

CustomersDashboard \ "CustomersDashboard"

Summary \ "Summary"

LanguagesCachePolicy

Defines the policy for caching customer languages.

Note

Do not extend or inherit from out-of-the-box policies; instead, create your own.

You can change the values of default policies by modifying the PolicySet JSON or the Environment JSON, depending on where the policy is defined, and then re-running Bootstrap.

If you have suggestions for improving this article, let us know!