Data Tracking Configuration

Table of Contents

Overview

Overview

There are various properties you can configure when utilizing Broadleaf’s Data Tracking library.

Pageable Properties (Since 1.7.26, 2.0.1)

Properties related to configuring pageable attributes, such as setting maximum page size.

See the PageableProperties class for more details.

Property Description Default

Property	Description	Default
`broadleaf.tracking.pageable.page-request-default-max-page-size`	The maximum page size for `DefaultPageRequest`. Be cautious when increasing this value, as setting it too high can cause issues with too many results being returned.	2000
`broadleaf.tracking.pageable.narrow-pageable-argument-resolver-default-max-page-size`	The maximum page size for `NarrowPageableHandlerMethodArgumentResolver`. Be cautious when increasing this value, as setting it too high can cause issues with too many results being returned.	2000

broadleaf.tracking.pageable.page-request-default-max-page-size

The maximum page size for DefaultPageRequest. Be cautious when increasing this value, as setting it too high can cause issues with too many results being returned.

2000

broadleaf.tracking.pageable.narrow-pageable-argument-resolver-default-max-page-size

The maximum page size for NarrowPageableHandlerMethodArgumentResolver. Be cautious when increasing this value, as setting it too high can cause issues with too many results being returned.

2000

Application Configuration Properties

These properties are bound to the ApplicationConfigurationProperties class.

Property Description Default

Property	Description	Default
(since DataTracking 2.0.5) `broadleaf.common.data.application.configuration.populate-audit-update-on-create`	Should audit update fields be populated on create with the same value as create field	false

(since DataTracking 2.0.5) broadleaf.common.data.application.configuration.populate-audit-update-on-create

Should audit update fields be populated on create with the same value as create field

false

Obsolete Sandbox Data Purge Properties

These properties are bound to the PurgeObsoleteSandboxDataConfigurationProperties class.

Property Description Default

Property	Description	Default
`broadleaf.tracking.sandbox.purge.enabled`	Whether purging of obsolete sandbox data is enabled.	true
`broadleaf.tracking.sandbox.purge.obsolete-data-age-cutoff`	This is the duration used to determine whether sandbox data is outdated. The current time (the time that the scheduled job is handled) minus this duration is the age cutoff that will be used. All sandbox-archived records whose last-updated audit timestamps are all older than this cutoff will be deleted.	60 days

broadleaf.tracking.sandbox.purge.enabled

Whether purging of obsolete sandbox data is enabled.

true

broadleaf.tracking.sandbox.purge.obsolete-data-age-cutoff

This is the duration used to determine whether sandbox data is outdated. The current time (the time that the scheduled job is handled) minus this duration is the age cutoff that will be used. All sandbox-archived records whose last-updated audit timestamps are all older than this cutoff will be deleted.

60 days

JPA Obsolete Sandbox Data Purge Properties (since DataTracking 2.0.5)

These properties are bound to the JpaPurgeObsoleteSandboxProperties class. They configure the behavior of JpaTrackableRepository#purgeObsoleteSandboxData.

Property Description Default

Property	Description	Default
`broadleaf.data.tracking.jpa.purge-obsolete-sandbox-data.max-batch-size`	The maximum number of main entities to purge in a single batch.	100
`broadleaf.data.tracking.jpa.purge-obsolete-sandbox-data.max-number-of-batches`	The maximum number of batches to process. This limit is useful to set an upper bound on each execution of the purge process. Typically, the expectation is for any remaining records to be deleted on the next execution of the purge process.	50

broadleaf.data.tracking.jpa.purge-obsolete-sandbox-data.max-batch-size

The maximum number of main entities to purge in a single batch.

100

broadleaf.data.tracking.jpa.purge-obsolete-sandbox-data.max-number-of-batches

The maximum number of batches to process. This limit is useful to set an upper bound on each execution of the purge process. Typically, the expectation is for any remaining records to be deleted on the next execution of the purge process.