Tenant Service Configuration

Table of Contents

Overview

Overview

There are various properties you can configure when utilizing Broadleaf’s Tenant Service.

Data Properties

Properties related to JPA and persistence configuration

Property Description

Property	Description
`broadleaf.tenant.jpa.*`	JPA Configuration Properties. See `com.broadleafcommerce.common.jpa.data.JpaProperties` for full list of options.
`broadleaf.tenant.datasource.*`	Datasource Configuration Properties. See `org.springframework.boot.autoconfigure.jdbc.DataSourceProperties` for full list of options.
`broadleaf.tenant.liquibase.*`	Liquibase Configuration Properties. See `org.springframework.boot.autoconfigure.liquibase.LiquibaseProperties` for full list of options.
`broadleaf.tenant.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.tenant.jpa.*

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

broadleaf.tenant.datasource.*

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

broadleaf.tenant.liquibase.*

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

broadleaf.tenant.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.

Customer Context Properties

Properties related to the method for determining the customer context id

Property Description Default value Introduced in version

Property	Description	Default value	Introduced in version
`broadleaf.tenant.application.customer.contextMethod`	The default method for determining the customer context ID (CustomerContextResolverMethod Enum)	`APPLICATION`

broadleaf.tenant.application.customer.contextMethod

The default method for determining the customer context ID (CustomerContextResolverMethod Enum)

APPLICATION

Url Resolver Properties

Properties related to the resolving of application and admin urls

Property Description

Property	Description
`broadleaf.tenant.urlresolver.*`	See `com.broadleafcommerce.tenant.service.autoconfigure.UrlResolverProperties` for full list of options.

broadleaf.tenant.urlresolver.*

See com.broadleafcommerce.tenant.service.autoconfigure.UrlResolverProperties for full list of options.

Tenant Vendor Notification Handler Properties

(since 1.7.6)

Properties relating to the behavior of TenantVendorNotificationHandler

Property Description Default value

Property	Description	Default value
`broadleaf.tenant.vendor-notification-handler.enable-auto-catalog-marketplace-assignment`	When TenantServices is notified about the creation of a vendor, it automatically creates a vendor catalog for that vendor. This property determines whether that catalog should also automatically be assigned to any marketplace(s) as determined by the MarketplaceDiscoverer component.	true

broadleaf.tenant.vendor-notification-handler.enable-auto-catalog-marketplace-assignment

When TenantServices is notified about the creation of a vendor, it automatically creates a vendor catalog for that vendor. This property determines whether that catalog should also automatically be assigned to any marketplace(s) as determined by the MarketplaceDiscoverer component.

true

Search Group Properties

(since 2.1.0)

Properties relating to provisioning Search Groups for new Tenants and Applications.

broadleaf.tenant.application.initialize-search-group-catalog-for-new-applications-enabled Whether to create a SEARCH_GROUP type catalog automatically when a new application is created. It is expected that only one such catalog should exist for the application and this will simplify maintenance. true

`broadleaf.tenant.application.initialize-search-group-catalog-for-new-applications-enabled`	Whether to create a SEARCH_GROUP type catalog automatically when a new application is created. It is expected that only one such catalog should exist for the application and this will simplify maintenance.	`true`
2.1.0-GA	`broadleaf.tenant.tenant.initialize-search-group-catalog-for-new-tenants-enabled`	Whether to create a SEARCH_GROUP type catalog automatically when a new tenant is created. It is expected that only one such catalog should exist for the tenant and this will simplify maintenance.

2.1.0-GA

broadleaf.tenant.tenant.initialize-search-group-catalog-for-new-tenants-enabled

Whether to create a SEARCH_GROUP type catalog automatically when a new tenant is created. It is expected that only one such catalog should exist for the tenant and this will simplify maintenance.