Enable Audit Trail

Configure Audit Trail view

To limit the amount of data displayed, there are the following properties in <PIM_SERVER_INSTALLATION_ROOT>\configuration\HPM\plugin_customization.ini file.

Start Product 360 Server

In case of successful Audit Trail setup you should see the following log messages for each root entity which is configured for Audit Trail:

• Lifecycle for entity '<entity identifier>' is running in Elasticsearch

Short Identifier

In order to generate and store the changes in the entity item change document, it is important to provide the Short Identifier for entities and fields.

Audit Trail Settings

Audit Trail can be activated for any root entity in the repository. An activation/deactivation on the sub-entity level is not supported. The setting of the root entity will always be used, independent of the setting for the sub-entities.

1. Open the repository editor,

2. Go to Custom section and select a root entity

3. If "Audit trail settings" is not already available for that entity then right-click → select "New child" → click "Audit trail settings"

4. Audit trail settings have the below properties

   Property	Value
   Datasource	Datasource of Entity, which can be any of the following - MAIN, MASTER, or SUPPLIER
   Documentation
   Retention Policy	There are 3 types of retentions can be chosen from the drop-down Retention type NO_RETENTION If no auditing is needed for the entity. No change information will be recorded in the Elasticsearch for this entity LONG_RETENTION If auditing is needed to be stored for the entity for a considerable amount of time, e.g. a few years. The longterm_policy and longterm_template from the audittrail configuration folder will be used to create policy and index SHORT_RETENTION If auditing is needed to be stored for the entity for a relatively short amount of time, e.g. a few months. The shortterm_policy and shortterm_template from the audittrail configuration folder will be used to create policy and index
   Revision setting	Below revision settings are available to choose from for auditing Revision ALL_REVISIONS All revisions changes will be recorded in the Audit Trail HEAD_REVISION_ONLY Only head revisions changes will be recorded in the Audit Trail NON_HEAD_REVISION_ONLY All the revisions changes except head revision will be recorded in the Audit Trail
   Use Own Index	Below values can be set for this property Own index true This will create a separate index in Elasticsearch for this particular entity false This will use a shared index in Elasticsearch for multiple entities.

Supports Audit Trail Property

If this flag is set to false for a field/entity then any changes done on the field/entity are not recorded in the Audit Trail. However a corresponding change document is stored recording the transaction but with empty change summary.

• Entity level : If set at an entity level then all it's sub-entities and fields also inherit this behavior.

• Field level : If set at a field level then only that field is affected. Any change done with respect to this field is not recorded in change summary of the document.

Lifecycle Policies

There are shortterm_policy and longterm_policy in Product 360.

Each has a different configuration for the number of days an index will be in one phase. These can be configured based on customer needs and Product 360 will take care of applying these for indices in Elasticsearch after Product 360 server restart.

Each phase is explained below -

Index Templates

There are 3 index templates in the Audit Trail configuration folder. Each has index settings JSON which contains configurations like number_of_shards, number_of_replicas, etc.