Customer Service Configuration

Table of Contents

Overview

Overview

The following properties can be configured to control various aspects of the Broadleaf Customer Service

Service Properties

Property Description

Property	Description
`broadleaf.customer.jpa.*`	JPA Configuration Properties. See `com.broadleafcommerce.common.jpa.data.JpaProperties` for full list of options.
`broadleaf.customer.datasource.*`	Datasource Configuration Properties. See `org.springframework.boot.autoconfigure.jdbc.DataSourceProperties` for full list of options.
`broadleaf.customer.liquibase.*`	Liquibase Configuration Properties. See `org.springframework.boot.autoconfigure.liquibase.LiquibaseProperties` for full list of options.
`broadleaf.customer.delegating.*`	Delegating Schema Configuration Properties for running in a composed mode along side other Broadleaf microservices. See `com.broadleafcommerce.common.jpa.data.SchemaDelegatingProperties` for full list of options.

broadleaf.customer.jpa.*

JPA Configuration Properties. See com.broadleafcommerce.common.jpa.data.JpaProperties for full list of options.

broadleaf.customer.datasource.*

Datasource Configuration Properties. See org.springframework.boot.autoconfigure.jdbc.DataSourceProperties for full list of options.

broadleaf.customer.liquibase.*

Liquibase Configuration Properties. See org.springframework.boot.autoconfigure.liquibase.LiquibaseProperties for full list of options.

broadleaf.customer.delegating.*

Delegating Schema Configuration Properties for running in a composed mode along side other Broadleaf microservices. See com.broadleafcommerce.common.jpa.data.SchemaDelegatingProperties for full list of options.

Behavior Properties

Property Description

Property	Description
`broadleaf.customer.behavior.emailAsUsername`	Indicates that the customer’s username should always be set from their email Defaults to `true`
`broadleaf.customer.saved-payment-method.storage-location`	Declares the service that is responsible for storing saved payment methods Options: `BLC_PAYMENT_TRANSACTION_SERVICES`, `BLC_CUSTOMER_SERVICES` Default value: `BLC_PAYMENT_TRANSACTION_SERVICES` IMPORTANT: Even though storing and managing saved payment methods via CustomerServices is still supported, it is deprecated and PaymentTransactionServices should be used instead
`broadleaf.customer.web.saved-payment-method.legacy-permission-enabled`	Determines whether the legacy permissions (`CUSTOMER` or `CUSTOMER_PROFILE`) should be used for `CustomerPaymentAccountEndpoint` Defaults `false`

broadleaf.customer.behavior.emailAsUsername

Indicates that the customer’s username should always be set from their email

Defaults to true

broadleaf.customer.saved-payment-method.storage-location

Declares the service that is responsible for storing saved payment methods

Options: BLC_PAYMENT_TRANSACTION_SERVICES, BLC_CUSTOMER_SERVICES

Default value: BLC_PAYMENT_TRANSACTION_SERVICES

IMPORTANT: Even though storing and managing saved payment methods via CustomerServices is still supported, it is deprecated and PaymentTransactionServices should be used instead

broadleaf.customer.web.saved-payment-method.legacy-permission-enabled

Determines whether the legacy permissions (CUSTOMER or CUSTOMER_PROFILE) should be used for CustomerPaymentAccountEndpoint

Defaults false

Create Payment Account Event Properties

During checkout, a registered user can select to have their new payment saved. This creates an event handled by CreatePaymentAccountEventListener. The following properties are used to configure that listener.

Property Description

Property	Description
`broadleaf.customer.messaging.payment-account.create.enabled`	Determines whether the `CreatePaymentAccountEventListener` is enabled. Due to the updated pattern of producing saved payments just after the successful execution of Authorize or AuthorizeAndCapture transactions in PaymentTransactionServices 1.0.2, this listener should only be needed for the transitional period after upgrading PaymentTransactionServices to 1.0.2. Once all the remaining `CheckoutCompletionEvents` have been processed, the listener can be disabled using this property. Defaults to true
`broadleaf.customer.messaging.payment-account.create.display-attributes.card-type-attribute`	The name of the display attribute where the credit card type is stored. Defaults to `creditCardType`
`broadleaf.customer.messaging.payment-account.create.display-attributes.card-number-attribute`	The name of the display attribute where the credit card number is stored, which should be masked. Defaults to `creditCardNumber`
`broadleaf.customer.messaging.payment-account.create.display-attributes.card-expiration-month-attribute`	The name of the display attribute where the credit card expiration month is stored. Defaults to `creditCardExpDateMonth`
`broadleaf.customer.messaging.payment-account.create.display-attributes.card-expiration-year-attribute`	The name of the display attribute where the credit card expiration year is stored. Defaults to `creditCardExpDateYear`

broadleaf.customer.messaging.payment-account.create.enabled

Determines whether the CreatePaymentAccountEventListener is enabled.

Due to the updated pattern of producing saved payments just after the successful execution of Authorize or AuthorizeAndCapture transactions in PaymentTransactionServices 1.0.2, this listener should only be needed for the transitional period after upgrading PaymentTransactionServices to 1.0.2. Once all the remaining CheckoutCompletionEvents have been processed, the listener can be disabled using this property.

Defaults to true

broadleaf.customer.messaging.payment-account.create.display-attributes.card-type-attribute

The name of the display attribute where the credit card type is stored.

Defaults to creditCardType

broadleaf.customer.messaging.payment-account.create.display-attributes.card-number-attribute

The name of the display attribute where the credit card number is stored, which should be masked.

Defaults to creditCardNumber

broadleaf.customer.messaging.payment-account.create.display-attributes.card-expiration-month-attribute

The name of the display attribute where the credit card expiration month is stored.

Defaults to creditCardExpDateMonth

broadleaf.customer.messaging.payment-account.create.display-attributes.card-expiration-year-attribute

The name of the display attribute where the credit card expiration year is stored.

Defaults to creditCardExpDateYear