Audit Services Data Model

Logical ID. Allows for sandbox versions.

The time at which the change was reported to the system. Required.

In the case of Trackable entity change, The name of the top-level entity that changed, which is typically snake-cased and capitalized, i.e., "PRODUCT". Arbitrary audit events may use this field to represent the type of event. Required.

Fully qualified class name of the top-level entity being changed. Optional. For audit changes to a particular entity.

Identifying reference to the entity. Usually a contextId for Trackable domain. Optional. For audit changes to a particular entity.

In the case of Trackable entity change, The name of the containing entity, which is typically snake-cased and capitalized, i.e., "PRODUCT". This is a grouping concept for correlating multiple related changes to a singular concept. For example, a marketing message change, which from the admin perspective looks like a change to an offer. Optional.

Identifying reference to the containing entity. Usually a contextId for Trackable domain. Optional.

Identifier for a customer entity. Useful for identifying a customer related to the change. Optional. For audit events related to a customer.

Identifier for an account entity. Useful for identifying an account related to the change. Optional. For audit events related to an account.

The type of detail information associated with this audit event. Default is DetailType#NONE.

Date on which the header reader is set to expire. Optional.

The tenant to whom this audit record belongs. Required.

The catalog to which this audit record belongs. Optional. For audit events related to a catalog discriminated entity.

The application to which this audit record belongs. Optional. For audit events related to an application discriminated entity.

Any additional information, possibly required in extension scenarios. Optional.

The primary author of the change. Optional. For DetailType#CHANGE_DETAIL events, this field generally represents the approver of the overall entity change. See AuditEventDetail#getAuthor() for more specific ownership of field-level changes. For non-CHANGE_DETAIL events, this field represents the user driving the event.

Any additional author for the change. Optional. For {@link DetailType#CHANGE_DETAIL} events, this field generally represents the user engaged the deployment.

Logical ID. Allows for sandbox versions.

The id of the related header record. Required.

Identifier for a customer entity. Useful for identifying a customer related to the change. Optional. For audit events related to a customer.

Identifier for an account entity. Useful for identifying an account related to the change. Optional. For audit events related to an account.

The timestamp at which the field change took place

The author of the change. May be an admin user, or an identifier noting an automated system process.

The value for the field before the change was made. Json representation. May be simple, or a more complex structure - like a list.

The value for the field after the change was made. Json representation. May be simple, or a more complex structure - like a list.

Raw information about the change.

The name of the field on the repository domain. This is generally the name of a field in a JPA domain class.

The name of the field in a projection domain. This is generally the name of the field from domain serialized to and deserialized from JSON at the microservice endpoint API. Often this is the same as the repositoryField, but is not required to be.

The fully qualified classname of the Java type for this field.

The operation type that mutated this field value. Maps to com.broadleafcommerce.data.tracking.core.type.OperationType.

Optional message included giving more information about the change. When included, usually noted by the admin user making the change.

Any additional information, possibly required in extension scenarios