Personal Library

Reference - Auditing

Auditing Jobs

JobConfigurationAuditMessageProducer

This message producer extends com.intershop.component.pricing.internal.auditing.messageproducer.AbstractPayloadAuditMessageProducer.
It uses com.intershop.component.auditing.capi.ref.objects.AuditJobConfigurationRef which extends AbstractAuditDomainObjectRef<JobConfiguration> and uses the following attributes as a semantic key:

Type	Name	Description
String	name	the name of the referenced job
AuditDomainRef	domainRef	the domain ref of the referenced job's domain

A sample in JSON:

com.intershop.component.auditing.capi.ref.objects.AuditJobConfigurationRef

{
	"@class":"com.intershop.component.auditing.capi.ref.objects.AuditJobConfigurationRef",
	"name":"PromotionPromotionExportTest27",
	"domainRef":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-PrimeTechSpecials"
	}
}

Attribute Changes

The following JobConfigurationPO attributes are stored in the payload.

AuditedItem Attribute	AuditItem Payload Attribute	Comment
domainID	domainRef	stored as AuditDomainRef
name	name	stored as retrieved from the PO (String)
enabledFlag	enabledFlag	stored as Boolean
status	status	stored as Integer
pipelineName	pipelineName	stored as retrieved from the PO (String)
startNodeName	startNodeName	stored as retrieved from the PO (String)
lastExecutionTime	lastExecutionTime	stored as Date
lastExecutionDuration	lastExecutionDuration	stored as Integer

The handling of JobConfigurationPOAttributeValuePO is already covered implicitly.

Payload sample

attributeDataType=com.intershop.beehive.core.internal.job.JobConfigurationPO

{
	"attributeDataType":"com.intershop.beehive.core.internal.job.JobConfigurationPO",
	"attributeChanges":[
		{
			"name":"lastExecutionDuration",
			"newValue":0,
			"oldValue":null
		},
		{
			"name":"enabledFlag",
			"newValue":false,
			"oldValue":null
		},
		{
			"name":"status",
			"newValue":0,
			"oldValue":null
		},
		{
			"name":"pipelineName",
			"newValue":"PromotionImpex",
			"oldValue":null
		},
		{
			"name":"name",
			"newValue":"PromotionPromotionExportTest27",
			"oldValue":null
		},
		{
			"name":"startNodeName",
			"newValue":"Export",
			"oldValue":null
		},
		{
			"name":"domainRef",
			"newValue":{
				"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
				"domainName":"PrimeTech-PrimeTechSpecials"},
			"oldValue":null
		},
		{
			"name":"lastExecutionTime",
			"newValue":["java.util.Date","1970-01-01T00:00:00.000+0000"],
			"oldValue":null
		}
	],
	"metaInformation":{
		"jobConfigurationPipelineStartnodeName":"Export",
		"jobConfigurationPipelineName":"PromotionImpex",
		"jobConfigurationRef":{
			"@class":"com.intershop.component.auditing.capi.ref.objects.AuditJobConfigurationRef",
			"name":"PromotionPromotionExportTest27",
			"domainRef":{
				"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
				"domainName":"PrimeTech-PrimeTechSpecials"
			}
		}
	},
	"descriptionKey":"auditing.message.CREATE.com.intershop.beehive.core.internal.job.JobConfigurationPO.name",
	"descriptionParameters":["PromotionPromotionExportTest27"]
}

The attribute suffix of the "descriptionKey" of JobConfigurationPO is "name". The value of the description parameter is the name of the audited JobConfigurationPO.

Auditing PriceLists

PriceListAuditMessageProducer

This message producer extends com.intershop.component.pricing.internal.auditing.messageproducer.AbstractPayloadAuditMessageProducer.
It uses com.intershop.component.pricing.capi.auditing.refs.AuditPriceListRef which extends AbstractAuditDomainObjectRef<PriceList> and uses the following attributes as a semantic key:

Type	Name	Description
String	pricelistID	the ID of the referenced pricelist
String	pricelistType	the price type of the referenced pricelist
AuditDomainRef	domainRef	the domain ref of the referenced pricelist's domain

A sample in JSON:

com.intershop.component.pricing.capi.auditing.refs.AuditPriceListRef

{
	"@class":"com.intershop.component.pricing.capi.auditing.refs.AuditPriceListRef",
	"pricelistID":"TestPriceList20",
	"pricelistType":"ES_SalePrice",
	"domainRef":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-PrimeTechSpecials"
	}
}

Attribute Changes

The following PriceListPO attributes are stored in the payload.

AuditedItem Attribute	AuditItem Payload Attribute	Comment
domainID	domainRef	stored as AuditDomainRef
ID	ID	stored as retrieved from the PO (String)
priceType	priceType	stored as retrieved from the PO (String)
enabledFlag	enabledFlag	stored as Boolean
priority	priority	stored as Integer
validFrom	validFrom	stored as Date
validTo	validTo	stored as Date

The handling of PriceListPOAttributeValuePO is already covered implicitly.

Payload sample

attributeDataType=com.intershop.component.pricing.internal.pricelist.PriceListPO

{
	"attributeDataType":"com.intershop.component.pricing.internal.pricelist.PriceListPO",
	"attributeChanges":[
		{
			"name":"enabledFlag",
			"newValue":false,
			"oldValue":null
		},
		{
			"name":"priority",
			"newValue":12.0,
			"oldValue":null
		},
		{
			"name":"validTo",
			"newValue":["java.util.Date","2012-12-30T23:00:00.000+0000"],
			"oldValue":null
		},
		{
			"name":"validFrom",
			"newValue":["java.util.Date","2012-06-30T22:00:00.000+0000"],
			"oldValue":null
		},
		{
			"name":"priceType",
			"newValue":"ES_SalePrice",
			"oldValue":null
		},
		{
			"name":"ID",
			"newValue":"TestPriceList20",
			"oldValue":null
		},
		{
			"name":"domainRef",
			"newValue":{"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef","domainName":"PrimeTech-PrimeTechSpecials"},
			"oldValue":null
		}
	],
	"metaInformation":{
		"priceListRef":{
			"@class":"com.intershop.component.pricing.capi.auditing.refs.AuditPriceListRef",
			"pricelistID":"TestPriceList20",
			"pricelistType":"ES_SalePrice",
			"domainRef":{
				"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
				"domainName":"PrimeTech-PrimeTechSpecials"
			}
		}
	},
	"descriptionKey":"auditing.message.CREATE.com.intershop.component.pricing.internal.pricelist.PriceListPO.pricelistID",
	"descriptionParameters":["TestPriceList20"]
}

The attribute suffix of the "descriptionKey" of PriceListPO is "pricelistID". The value of the description parameter is the ID of the audited PriceListPO.

PriceListUserGroupAssignmentAuditMessageProducer

This message producer extends com.intershop.component.pricing.internal.auditing.messageproducer.AbstractPayloadAuditMessageProducer.
It uses com.intershop.component.pricing.internal.auditing.refs.AuditPriceListUserGroupAssignmentRef and the following attributes as a semantic key:

Type	Name	Description
AuditPriceListRef	pricelistRef	the ref to the involved pricelist
AuditUserGroupRef	usergroupRef	the ref to the involved usergroup

A sample in JSON:

com.intershop.component.pricing.internal.auditing.refs.AuditPriceListUserGroupAssignmentRef

{
	"@class":"com.intershop.component.pricing.internal.auditing.refs.AuditPriceListUserGroupAssignmentRef",
	"pricelistRef":{"@class":"com.intershop.component.pricing.capi.auditing.refs.AuditPriceListRef",
	"pricelistID":"TestPriceList12",
	"pricelistType":"ES_SalePrice",
	"domainRef":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-PrimeTechSpecials"}
	},
	"usergroupRef":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditUserGroupRef",
		"userGroupID":"IG_NewUsers",
		"domainRef":{
			"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
			"domainName":"PrimeTech-PrimeTechSpecials-Anonymous"
		}
	}
}

Attribute Changes

The following PriceListUserGroupAssignmentPO attributes are stored in the payload.

AuditedItem Attribute	AuditItem Payload Attribute	Comment
priceListUUID	priceListRef	stored as AuditPriceListRef
userGroupDomainID	userGroupRef	stored in conjunction with the userGroupID attribute as AuditUserGroupRef
userGroupID	userGroupRef	stored in conjunction with the userGroupDomainID attribute as AuditUserGroupRef

Payload sample

attributeDataType=com.intershop.component.pricing.internal.pricelist.PriceListUserGroupAssignmentPO

{
	"attributeDataType":"com.intershop.component.pricing.internal.pricelist.PriceListUserGroupAssignmentPO",
	"attributeChanges":[
		{
			"name":"userGroupRef",
			"newValue":{
				"@class":"com.intershop.component.auditing.capi.ref.objects.AuditUserGroupRef",
				"userGroupID":"IG_NewUsers",
				"domainRef":{
					"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
					"domainName":"PrimeTech-PrimeTechSpecials-Anonymous"}
			},
			"oldValue":null
		},
		{
			"name":"priceListRef",
			"newValue":{
				"@class":"com.intershop.component.pricing.capi.auditing.refs.AuditPriceListRef",
				"pricelistID":"TestPriceList12",
				"pricelistType":"ES_SalePrice",
				"domainRef":{
					"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
					"domainName":"PrimeTech-PrimeTechSpecials"}
			},
			"oldValue":null
		}
	],
	"metaInformation":{
			"priceListUserGroupAssignmentRef":{
				"@class":"com.intershop.component.pricing.internal.auditing.refs.AuditPriceListUserGroupAssignmentRef",
				"pricelistRef":{"@class":"com.intershop.component.pricing.capi.auditing.refs.AuditPriceListRef",
				"pricelistID":"TestPriceList12",
				"pricelistType":"ES_SalePrice",
				"domainRef":{
					"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
					"domainName":"PrimeTech-PrimeTechSpecials"}
				},
				"usergroupRef":{
					"@class":"com.intershop.component.auditing.capi.ref.objects.AuditUserGroupRef",
					"userGroupID":"IG_NewUsers",
					"domainRef":{
						"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
						"domainName":"PrimeTech-PrimeTechSpecials-Anonymous"
					}
				}
			}
		},

	"descriptionKey":"auditing.message.CREATE.com.intershop.component.pricing.internal.pricelist.PriceListUserGroupAssignmentPO.usergroupID.pricelistID",
	"descriptionParameters":["IG_NewUsers","TestPriceList12"]
}

The attribute suffix of the "descriptionKey" of PriceListUserGroupAssignmentPO is "usergroupID.pricelistID". The values of the description parameters are the ID of the assigned userGroupID the ID of the assigned PriceListPO.

PriceScaleEntryAuditMessageProducer

This message producer extends com.intershop.component.pricing.internal.auditing.messageproducer.AbstractPayloadAuditMessageProducer.
It uses com.intershop.component.pricing.internal.auditing.refs.AuditPriceScaleEntryRef which has the following attributes as a key:

Type	Name	Description
String	uuid	the UUID of the referenced price scale entry as there is no semantic key present on this table

A sample in JSON:

com.intershop.component.pricing.internal.auditing.refs.AuditPriceScaleEntryRef

{
	"@class":"com.intershop.component.pricing.internal.auditing.refs.AuditPriceScaleEntryRef",
	"uuid":"w4ap_o4PMMcAAAE4Eo5bCA.h"
}

It will also use AuditPriceScaletableRef, see above.

Attribute Changes

The following PriceScaleEntryPO attributes are stored in the payload.

AuditedItem Attribute	AuditItem Payload Attribute	Comment
domainID	domainRef	stored as AuditDomainRef
singleBasePriceValue	singleBasePriceValue	stored as Money
percentage	percentage	stored as Double
quantityLevelValue	quantityLevelValue	stored as Quantity

Some attributes of PriceScaleEntryPO are explicitly not tracked because they are either for internal use only or are currently not used (anymore), even if the object model theoretically supports them:

netPriceFlag
taxRate
typeCode

The handling of PriceScaleEntryPOAttributeValuePO is already covered implicitly.

Payload sample

attributeDataType=com.intershop.component.pricing.internal.scale.PriceScaleEntryPO

{
	"attributeDataType":"com.intershop.component.pricing.internal.scale.PriceScaleEntryPO",
	"attributeChanges":[
                {
			"name":"percentage",
			"newValue":50.0,
			"oldValue":null
		},
		{
			"name":"quantityLevelValue",
			"newValue":{"@class":"com.intershop.beehive.foundation.quantity.Quantity","value":3,"unit":""},
			"oldValue":null
		},
		{
			"name":"singleBasePriceValue",
			"newValue":{"@class":"com.intershop.beehive.foundation.quantity.Money","value":2.70,"currency":"USD"},
			"oldValue":null
		},
		{
			"name":"domainRef",
			"newValue":{"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef","domainName":"PrimeTech-PrimeTechSpecials"},
			"oldValue":null
		}
	]
	"metaInformation":{
		"priceScaleEntryRef":{
			"@class":"com.intershop.component.pricing.internal.auditing.refs.AuditPriceScaleEntryRef",
				"uuid":"w4ap_o4PMMcAAAE4Eo5bCA.h"
			},
			"priceScaleTableRef":{
				"@class":"com.intershop.component.pricing.internal.auditing.refs.AuditPriceScaleTableRef",
				"uuid":"KcSp_o4PZi0AAAE4lR5U_AVd"
			}
		}
	"descriptionKey":"auditing.message.CREATE.com.intershop.component.pricing.internal.scale.PriceScaleEntryPO.pricelists.products",
	"descriptionParameters":["TestPriceList12","1YLEDTVSUP"]
}

The attribute suffix of the "descriptionKey" of PriceScaleEntryPO is "pricelists.products". The values of the description parameters are the ID of the audited of the PriceList and the SKU of the audited Product as assigned of the corresponding PriceScaleTablePO.

PriceScaleTableAuditMessageProducer

This message producer extends com.intershop.component.pricing.internal.auditing.messageproducer.AbstractPayloadAuditMessageProducer.
It uses com.intershop.component.pricing.internal.auditing.refs.AuditPriceScaleTableRef which has the following attributes as a key:

Type	Name	Description
String	uuid	the UUID of the referenced price scale table as there is no semantic key present on this table

A sample in JSON:

com.intershop.component.pricing.internal.auditing.refs.AuditPriceScaleTableRef

{
	"@class":"com.intershop.component.pricing.internal.auditing.refs.AuditPriceScaleTableRef",
	"uuid":"raWp_o4PGtEAAAE4kGZF.ApQ"
}

It will also use AuditPriceListRef, see above.

In addition, it will also use references to products in shape of AuditProductRef as follows (defined in xcs due to its reusability, for example in promotion auditing):

Type	Name	Description
String	sku	the SKU of the referenced product
AuditDomainRef	domainRef	the domain ref to the referenced product's domain

A sample in JSON:

ProductRef

{
	"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
	"sku":"1YLEDTVSUP",
	"domainRef":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-PrimeTechSpecials"
	}
}

Attribute Changes

The following PriceScaleTablePO attributes are stored in the payload.

AuditedItem Attribute	AuditItem Payload Attribute	Comment
domainID	domainRef	stored as AuditDomainRef
validTo	validTo	stored as Date
validFrom	validFrom	stored as Date
currencyCode	currencyCode	stored as retrieved from the PO (String)

Some attributes of PriceScaleTablePO are explicitly not tracked because they are either for internal use only or are currently not used (anymore), even if the object model theoretically supports them:

userGroupBasedFlag
userGroupDomainID
userGroupID
typeCode

The handling of PriceScaleTablePOAttributeValuePO is already covered implicitly.

Payload sample

attributeDataType=com.intershop.component.pricing.internal.scale.PriceScaleTablePO

{
	"attributeDataType":"com.intershop.component.pricing.internal.scale.PriceScaleTablePO",
	"attributeChanges":[
		{
			"name":"currencyCode",
			"newValue":"USD",
			"oldValue":null
		},
		{
			"name":"validFrom",
			"newValue":["java.util.Date","2012-08-01T10:00:00.000+0000"],
			"oldValue":null
		},
		{
			"name":"validTo",
			"newValue":["java.util.Date","2012-09-01T10:00:00.000+0000"],
			"oldValue":null
		},
			{"name":"domainRef",
			"newValue":{"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
			"domainName":"PrimeTech-PrimeTechSpecials"},"oldValue":null
		}
	],
	"metaInformation":{
			"priceListRefs":[
				"java.util.ArrayList",[
					{
						"@class":"com.intershop.component.pricing.capi.auditing.refs.AuditPriceListRef",
						"pricelistID":"TestPriceList12",
						"pricelistType":"ES_SalePrice",
						"domainRef":{
							"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
							"domainName":"PrimeTech-PrimeTechSpecials"
						}
					}
				]
			],
			"productRefs":[
				"java.util.ArrayList",[
					{
						"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
						"sku":"1YLEDTVSUP",
						"domainRef":{
							"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
							"domainName":"PrimeTech-PrimeTechSpecials"
						}
					}
				]
			],
			"priceScaleTableRef":{
				"@class":"com.intershop.component.pricing.internal.auditing.refs.AuditPriceScaleTableRef",
				"uuid":"EwKp_o4Pi7EAAAE4zl47IAoZ"
			}
	},
	"descriptionKey":"auditing.message.CREATE.com.intershop.component.pricing.internal.scale.PriceScaleTablePO.pricelists.products",
	"descriptionParameters":["TestPriceList12","1YLEDTVSUP"]
}

The attribute suffix of the "descriptionKey" of PriceScaleTablePO is "pricelists.products". The values of the description parameters are the ID of the audited of the PriceList and the SKU of the audited Product.

PriceScaleTableAssignmentAuditMessageProducer

This message producer extends com.intershop.component.pricing.internal.auditing.messageproducer.AbstractPayloadAuditMessageProducer.
It uses com.intershop.component.pricing.internal.auditing.refs.AuditPriceScaleTableAssignmentRef which extends AbstractAuditDomainObjectRef<PriceScaleTableAssignmentPO> and uses the following attributes as a semantic key:

Type	Name	Description
AuditPriceListRef	priceListRef	the ref to the referenced pricescaletable assignment's pricelist
AuditPriceScaleTableRef	priceScaleTableRef	the ref to the referenced pricescaletable assignment's pricescaletable
AuditProductRef	productRef	the ref to the referenced pricescaletable assignment's product

A sample in JSON:

com.intershop.component.pricing.internal.auditing.refs.AuditPriceScaleTableAssignmentRef

{
	"@class":"com.intershop.component.pricing.internal.auditing.refs.AuditPriceScaleTableAssignmentRef",
	"productRef":{"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef","sku":"1YLEDTVSUP",
	"domainRef":{"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef","domainName":"PrimeTech-PrimeTechSpecials"}},
	"pricelistRef":{
		"@class":"com.intershop.component.pricing.capi.auditing.refs.AuditPriceListRef",
		"pricelistID":"TestPriceList15","pricelistType":"ES_SalePrice",
		"domainRef":{
			"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
			"domainName":"PrimeTech-PrimeTechSpecials"
		}},
	"priceScaleTableRef":{
		"@class":"com.intershop.component.pricing.internal.auditing.refs.AuditPriceScaleTableRef",
		"uuid":"Ct2p_o4Pd1MAAAE49fxfOBTf"},
	"domainRef":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-PrimeTechSpecials"
	}
}

Attribute Changes

The following PriceScaleTableAssignmentPO attributes are stored in the payload.

AuditedItem Attribute	AuditItem Payload Attribute	Comment
domainID	domainRef	stored as AuditDomainRef
priceListUUID	priceListRef	stored as AuditPriceListRef
productUUID	productRef	stored as AuditProductRef
typeCode	typeCode	stored as Double

Payload sample

attributeDataType=com.intershop.component.pricing.internal.pricelist.PriceScaleTableAssignmentPO

{
	"attributeDataType":"com.intershop.component.pricing.internal.pricelist.PriceScaleTableAssignmentPO",
		"attributeChanges":[
		{
			"name":"typeCode",
			"newValue":1,
			"oldValue":null
		},
		{
			"name":"productRef",
			"newValue":{
				"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
				"sku":"1YLEDTVSUP",
				"domainRef":{
					"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
					"domainName":"PrimeTech-PrimeTechSpecials"
				}
			},
			"oldValue":null
		},
		{
			"name":"domainRef",
			"newValue":{
				"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
				"domainName":"PrimeTech-PrimeTechSpecials"
			},
			"oldValue":null
		},
		{
				"name":"priceListRef",
				"newValue":{
					"@class":"com.intershop.component.pricing.capi.auditing.refs.AuditPriceListRef",
					"pricelistID":"TestPriceList15",
					"pricelistType":"ES_SalePrice",
					"domainRef":{
						"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
						"domainName":"PrimeTech-PrimeTechSpecials"
					}
				},
				"oldValue":null
		}
	],
	"metaInformation":{
		"priceScaleTableAssignmentRef":
		{
			"@class":"com.intershop.component.pricing.internal.auditing.refs.AuditPriceScaleTableAssignmentRef",
			"productRef":{"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef","sku":"1YLEDTVSUP",
			"domainRef":{"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef","domainName":"PrimeTech-PrimeTechSpecials"}},
			"pricelistRef":{
				"@class":"com.intershop.component.pricing.capi.auditing.refs.AuditPriceListRef",
				"pricelistID":"TestPriceList15","pricelistType":"ES_SalePrice",
				"domainRef":{
					"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
					"domainName":"PrimeTech-PrimeTechSpecials"
				}},
			"priceScaleTableRef":{
				"@class":"com.intershop.component.pricing.internal.auditing.refs.AuditPriceScaleTableRef",
				"uuid":"Ct2p_o4Pd1MAAAE49fxfOBTf"},
			"domainRef":{
				"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
				"domainName":"PrimeTech-PrimeTechSpecials"
			}
		}
	},
	"descriptionKey":"auditing.message.CREATE.com.intershop.component.pricing.internal.pricelist.PriceScaleTableAssignmentPO.pricelistID.productSKU",
	"descriptionParameters":["TestPriceList15","1YLEDTVSUP"]
}

The attribute suffix of the "descriptionKey" of PriceScaleTableAssignmentPO is "pricelistID.productSKU". The values of the description parameters are the ID of the PriceList and the SKU of the assigned Product.

Auditing Products

There are two kinds of Products in the system, regular products and products shared from a master catalog to a channel. There are many types of objects related to products, such as prices, category assignemnts and other assignments and pricing-related classes.

The following sections describe message producers which handle auditing of the products themselves and all related objects.

ProductMessageProducer

This message producer extends com.intershop.beehive.xcs.internal.auditing.messageproducer.AbstractProductMessageProducer. It uses com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef
which derives from com.intershop.component.auditing.capi.ref.objects.AbstractAuditDomainObjectRef<Product>.

Supported Types

The message producer tracks attribute changes of ProductPO objects.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
availabilityStatus	Integer	Set to true if the product is available
availableFlag	boolean	Set to true if product is available
BaseUnit	String	The base unit
derivingDatesFlag	boolean	The deriving dates flag
domainRef	AuditDomainRef	The product domain
EANCode	String	The EAN code
FreightClassID	String	The freight class ID
GiftWrappable	boolean	True if the product can be gift-wrapped
manufacturerName	String	The manufacturer Name
manufacturerSKU	String	The manufacturer SKU
maxOrderQuantityValue	BigDecimal	The maximum number of items which can be ordered
minOrderQuantityValue	BigDecimal	The minimum number of items which can be ordered
name	String	The product name
onlineFlag	boolean	Set to true if product is online
originalProductRef	AuditProductRef	The original product
priceQuantityValue	BigDecimal	The quantity value
PrimaryViewID	String	The primary product view
productType	String	The product type
RatioBasePackingUnit	double	The base packaging ratio
ReadyForShipmentMax	String	Minimum number of days to ship
ReadyForShipmentMin	Integer	Maximum number of days to ship
SKU	String	The product ID
stepQuantityValue	BigDecimal	The step quantity value
supplierID	String	The supplier ID
supplierProductID	String	The supplier product ID
typeCode	String	The product type code
unit	String	The packaging unit
validFrom	Date	Start of validity period
validTo	Date	End of validity period
WarrantyEligible	boolean	True if warranty is eligible

The following snippet shows an example of attribute changes in JSON format while creating a product.

"attributeChanges":[
  {
	 "name":"productType",
	 "newValue":"Basic",
	 "oldValue":null
  },
  {
	 "name":"domainRef",
	 "newValue":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-MasterRepository"
	 },
	 "oldValue":null
  },
  {
	 "name":"availableFlag",
	 "newValue":false,
	 "oldValue":null
  },
  {
	 "name":"onlineFlag",
	 "newValue":false,
	 "oldValue":null
  },
  {
	 "name":"originalProductRef",
	 "newValue":{
		"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
		"sku":"testproduct",
		"name":"Test Product",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-MasterRepository"
		}
	 },
	 "oldValue":null
  },
  {
	 "name":"derivingDatesFlag",
	 "newValue":false,
	 "oldValue":null
  },
  {
	 "name":"priceQuantityValue",
	 "newValue":[
		"java.math.BigDecimal",
		1.0
	 ],
	 "oldValue":null
  },
  {
	 "name":"typeCode",
	 "newValue":"Product",
	 "oldValue":""
  },
  {
	 "localeID":"en_US",
	 "name":"name",
	 "newValue":"Test Product",
	 "oldValue":null
  },
  {
	 "name":"SKU",
	 "newValue":"testproduct",
	 "oldValue":null
  }
]

The following snippet shows an example of an attribute change in JSON format in the payload when updating a product.

"attributeChanges":[
  {
	 "name":"SKU",
	 "newValue":"110899661",
	 "oldValue":"11089966"
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties. Placeholders will be replaced by the localization framework in the order the description parameters are given.

The following snippet shows an example of the payload when updating a product:

"descriptionKey":"auditing.message.UPDATE.com.intershop.beehive.xcs.internal.product.ProductPO.productSKU",
"descriptionParameters":["110899661"]

DerivedProductMessageProducer

This message producer extends com.intershop.beehive.xcs.internal.auditing.messageproducer.AbstractProductMessageProducer. It uses com.intershop.beehive.xcs.capi.auditing.refs.AuditDerivedProductRef which derives from com.intershop.component.auditing.capi.ref.objects.AbstractAuditDomainObjectRef<Product>.

Supported Types

The message producer tracks attribute changes of DerivedProductPO objects.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
availabilityStatus	Integer	Set to true if the product is available
availableFlag	boolean	Set to true if product is available
BaseUnit	String	The base unit
derivingDatesFlag	boolean	The deriving dates flag
domainRef	AuditDomainRef	The product domain
EANCode	String	The EAN code
FreightClassID	String	The freight class ID
GiftWrappable	boolean	True if the product can be gift-wrapped
manufacturerName	String	The manufacturer name
manufacturerSKU	String	The manufacturer SKU
maxOrderQuantityValue	BigDecimal	The maximum number of items which can be ordered
minOrderQuantityValue	BigDecimal	The minimum number of items which can be ordered
name	String	The product name
onlineFlag	boolean	Set to true if product is online
originalProductRef	AuditProductRef	The original product
priceQuantityValue	BigDecimal	The quantity value
PrimaryViewID	String	The primary product view
productType	String	The product type
RatioBasePackingUnit	double	The base packaging ratio
ReadyForShipmentMax	String	Minimum number of days to ship
ReadyForShipmentMin	Integer	Maximum number of days to ship
SKU	String	The product ID
stepQuantityValue	BigDecimal	The step quantity value
supplierID	String	The supplier ID
supplierProductID	String	The supplier product ID
typeCode	String	The product type code
unit	String	The packaging unit
validFrom	Date	Start of vailidity period
validTo	Date	End of vailidity period
WarrantyEligible	boolean	True if warranty is eligible

The following snippet shows an example of attribute changes in JSON format while creating a derived product:

"attributeChanges":[
  {
	 "localeID":"en_US",
	 "name":"name",
	 "newValue":"Test Product Channel",
	 "oldValue":"Test Product"
  },
  {
	 "name":"domainRef",
	 "newValue":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-PrimeTechSpecials"
	 },
	 "oldValue":null
  },
  {
	 "name":"baseProductRef",
	 "newValue":{
		"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
		"sku":"testproduct",
		"name":"Test Product Channel",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-PrimeTechSpecials"
		}
	 },
	 "oldValue":null
  }
]

The following snippet shows an example of an attribute change in JSON format in the payload when changing the ID of a derived product.

"attributeChanges":[
  {
	 "name":"SKU",
	 "newValue":"110899661",
	 "oldValue":"11089966"
  }
]

Localization Key and Parameters

The following snippet shows an example of the payload when updating a derived product.

"descriptionKey":"auditing.message.UPDATE.com.intershop.beehive.xcs.internal.product.DerivedProductPO.productSKU",
"descriptionParameters":["1108996611"]

BundleAssignmentMessageProducer

Supported Types

The message producer tracks attribute changes of BundleAssignmentPO instances.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
bundleRef	AuditProductRef	A reference to the bundle product
domainRef	AuditDomainRef	The assignment domain
onlineFlag	boolean	Set to true if the assignment is online
position	double	The position in the bundle
productRef	AuditProductRef	A reference to the bundled product
quantityValue	BigDecimal	The number of bundled products

The following snippet shows an example of attribute changes in JSON format while creating a product bundle assignment:

"attributeChanges":[
{
 "name":"domainRef",
 "newValue":{
	"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
	"domainName":"PrimeTech-MasterRepository"
 },
 "oldValue":null
},
{
 "name":"bundleRef",
 "newValue":{
	"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
	"sku":"testproductvariation",
	"name":"Test Product Variation",
	"domainRef":{
	   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
	   "domainName":"PrimeTech-MasterRepository"
	}
 },
 "oldValue":null
},
{
 "name":"productRef",
 "newValue":{
	"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
	"sku":"2YLEDTVSUP",
	"name":"2-year LED TV Support",
	"domainRef":{
	   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
	   "domainName":"PrimeTech-MasterRepository"
	}
 },
 "oldValue":null
},
{
 "name":"onlineFlag",
 "newValue":true,
 "oldValue":null
},
{
 "name":"position",
 "newValue":1.0,
 "oldValue":null
},
{
 "name":"quantityValue",
 "newValue":[
	"java.math.BigDecimal",
	1
 ],
 "oldValue":null
}

The following snippet shows an example of an attribute change in JSON format in the payload when updating a bundle assignment:

"attributeChanges":[
  {
	 "name":"typeCode",
	 "newValue":"Bundled Product",
	 "oldValue":"Product"
  }
]

Localization Key and Parameters

The following snippet shows an example of the payload when updating a product link position:

"descriptionKey":"auditing.message.UPDATE.com.intershop.beehive.xcs.internal.product.ProductPO.productSKU,
"descriptionParameters":[
  "2YLEDTVSUP"
]

DerivedProductCostPriceMessageProducer

Supported Types

The message producer tracks attribute changes of DerivedProductCostPricePO instances.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
currency	String	The price currency
domainRef	AuditDomainRef	The price domain
netPriceFlag	boolean	Set to true if this is a net price
productRef	AuditProductRef	A reference to the product this price is assigned to
value	String	The price value

The following snippet shows an example of attribute changes in JSON format when creating a derived product cost price:

"attributeChanges":[
  {
	 "name":"currency",
	 "newValue":"USD",
	 "oldValue":null
  },
  {
	 "name":"domainRef",
	 "newValue":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-PrimeTechSpecials"
	 },
	 "oldValue":null
  },
  {
	 "name":"productRef",
	 "newValue":{
		"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
		"sku":"110899661",
		"name":"A-DATA  120GB S510",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-PrimeTechSpecials"
		}
	 },
	 "oldValue":null
  },
  {
	 "name":"netPriceFlag",
	 "newValue":false,
	 "oldValue":null
  },
  {
	 "name":"value",
	 "newValue":[
		"java.math.BigDecimal",
		123.25
	 ],
	 "oldValue":null
  }
]

Localization Key and Parameters

The following snippet shows an example of the payload when updating a derived product cost price:

"descriptionKey":"auditing.message.CREATE.com.intershop.beehive.xcs.internal.price.DerivedProductCostPricePO.price",
"descriptionParameters":[
	"USD",
    [
        "java.math.BigDecimal",
        123.25
    ],
    "110899661"
]

DerivedProductListPriceMessageProducer

Supported Types

The message producer tracks attribute changes of DerivedProductListPricePO instances.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
currency	String	The price currency
domainRef	AuditDomainRef	The price domain
netPriceFlag	boolean	Set to true if this is a net price
productRef	AuditProductRef	A reference to the product this price is assigned to
value	String	The price value

The following snippet shows an example of attribute changes in JSON format when creating a derived product list price:

"attributeChanges":[
  {
	 "name":"currency",
	 "newValue":"USD",
	 "oldValue":null
  },
  {
	 "name":"domainRef",
	 "newValue":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-PrimeTechSpecials"
	 },
	 "oldValue":null
  },
  {
	 "name":"productRef",
	 "newValue":{
		"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
		"sku":"110899661",
		"name":"A-DATA  120GB S510",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-PrimeTechSpecials"
		}
	 },
	 "oldValue":null
  },
  {
	 "name":"netPriceFlag",
	 "newValue":false,
	 "oldValue":null
  },
  {
	 "name":"value",
	 "newValue":[
		"java.math.BigDecimal",
		123.25
	 ],
	 "oldValue":null
  }
]

Localization Key and Parameters

The following snippet shows an example of the payload when creating a derived product list price:

"descriptionKey":"auditing.message.CREATE.com.intershop.beehive.xcs.internal.price.DerivedProductListPricePO.price",
"descriptionParameters":[
	"USD",
    [
        "java.math.BigDecimal",
        123.25
    ],
    "110899661"
]

ImageProductAssignmentMessageProducer

Supported Types

The message producer tracks attribute changes of ImageProductAssignmentPO instances.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
domainRef	AuditDomainRef	The assignment domain
imageBaseName	String	The image base name
type	String	The image type
view	String	The image view

The following snippet shows an example of attribute changes in JSON format while creating an image assignment:

"attributeChanges":"attributeChanges":[
  {
	 "name":"domainRef",
	 "newValue":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-PrimeTechSpecials"
	 },
	 "oldValue":null
  },
  {
	 "name":"imageBaseName",
	 "newValue":"test",
	 "oldValue":null
  },
  {
	 "name":"type",
	 "newValue":"Thumbnail",
	 "oldValue":null
  },
  {
	 "name":"view",
	 "newValue":"Default",
	 "oldValue":null
  }
]

Localization Key and Parameters

The following snippet shows an example of the payload when updating an image assignment:

"descriptionKey":"auditing.message.CREATE.com.intershop.component.image.internal.orm.ImageReferencePO.image",
"descriptionParameters":[
    "test",
    "Thumbnail",
    "Default"
]

ImageReferenceMessageProducer

Supported Types

The message producer tracks attribute changes of ImageReferencePO instances.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
domainRef	AuditDomainRef	The image reference domain
imageBaseName	String	The image base name
type	String	The image type
view	String	The image view

The following snippet shows an example of attribute changes in JSON format when creating an image reference.

"attributeChanges":[
  {
	 "name":"domainRef",
	 "newValue":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-MasterRepository"
	 },
	 "oldValue":null
  },
  {
	 "name":"view",
	 "newValue":"Back View",
	 "oldValue":null
  },
  {
	 "name":"type",
	 "newValue":"1XS",
	 "oldValue":null
  },
  {
	 "name":"imageBaseName",
	 "newValue":"test.jpg",
	 "oldValue":null
  }
]

The following snippet shows an example of an attribute change in JSON format in the payload when updating an image reference.

"attributeChanges":[
  {
	 "name":"imageBaseName",
	 "newValue":"test1.jpg",
	 "oldValue":"test.jpg"
  }
]

Localization Key and Parameters

The following snippet shows an example of the payload when updating an image reference.

"descriptionKey":"auditing.message.UPDATE.com.intershop.component.image.internal.orm.ImageReferencePO.image",
"descriptionParameters":[
      "test1.jpg",
      "1XS",
      "Back View"
]

PageletEntryPointProductAssignmentMessageProducer

Supported Types

The message producer tracks attribute changes of PageletEntryPointProductAssignmentPO instances.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
currency	String	The price currency
definitionQualifiedName	String	The fully qualified pagelet definition name
domainRef	AuditDomainRef	The assignment domain
pageletEntryPointRef	AuditPageletEntryPointRef	A reference to the assigned pagelet entry point
productRef	AuditProductRef	A reference to the product the pagelet is assigned to
viewContextRef	AuditViewContextRef	A reference to the view context

The following snippet shows an example of attribute changes in JSON format while creating a pagelet entry point assignment:

"attributeChanges":[
  {
	 "name":"viewContextRef",
	 "newValue":{
		"@class":"com.intershop.component.pmc.capi.auditing.refs.AuditViewContextRef",
		"name":"Product Page",
		"id":"viewcontext.page.product.pagelet2-viewContext",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-PrimeTechSpecials"
		}
	 },
	 "oldValue":null
  },
  {
	 "name":"productRef",
	 "newValue":{
		"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
		"sku":"1YLEDTVSUP",
		"name":"1-year LED TV Support",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-PrimeTechSpecials"
		}
	 },
	 "oldValue":null
  },
  {
	 "name":"domainRef",
	 "newValue":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-PrimeTechSpecials"
	 },
	 "oldValue":null
  },
  {
	 "name":"definitionQualifiedName",
	 "newValue":"viewcontext.page.product.pagelet2-viewContext-pageProduct",
	 "oldValue":null
  },
  {
	 "name":"pageletEntryPointRef",
	 "newValue":{
		"@class":"com.intershop.component.pmc.capi.auditing.refs.AuditPageletEntryPointRef",
		"name":"Product Page - Product Page - 1-year LED TV Support",
		"id":"viewcontext.page.product.pagelet2-viewContext-pageProduct-1YLEDTVSUP",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-PrimeTechSpecials"
		}
	 },
	 "oldValue":null
  }
]

Localization Key and Parameters

The following snippet shows an example of the payload when creating a pagelet entry point assignment:

"descriptionKey":"auditing.message.CREATE.com.intershop.component.mvc.internal.assignments.PageletEntryPointProductAssignmentPO.assignment",
"descriptionParameters":[
    "1YLEDTVSUP",
	"viewcontext.page.product.pagelet2-viewContext-pageProduct-1YLEDTVSUP"
]

ProdcutLinkMessageProducer

Supported Types

The message producer tracks attribute changes of ProductLinkPO instances.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
domainRef	AuditDomainRef	The link domain
sourceProductRef	AuditProductRef	A reference to the product to link to
targetProductRef	AuditProductRef	A reference to the linked product
typeCodeInteger	Integer	The link type code

The following snippet shows an example of attribute changes in JSON format when creating a product link.

"attributeChanges":[
  {
	 "name":"targetProductRef",
	 "newValue":{
		"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
		"sku":"5930238",
		"name":"A-DATA  128GB S599",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-PrimeTechSpecials"
		}
	 },
	 "oldValue":null
  },
  {
	 "name":"domainRef",
	 "newValue":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-PrimeTechSpecials"
	 },
	 "oldValue":null
  },
  {
	 "name":"typeCodeInteger",
	 "newValue":2,
	 "oldValue":null
  },
  {
	 "name":"sourceProductRef",
	 "newValue":{
		"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
		"sku":"110899661",
		"name":"A-DATA  120GB S510",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-PrimeTechSpecials"
		}
	 },
	 "oldValue":null
  }
]

Localization Key and Parameters

The following snippet shows an example of the payload when updating a product link:

"descriptionKey":"auditing.message.CREATE.com.intershop.beehive.xcs.internal.product.ProductLinkPO.link",
"descriptionParameters":[
      "110899661",
      "5930238"
   ]

ProductCategoryAssignmentMessageProducer

Supported Types

The message producer tracks attribute changes of ProductCategoryAssignmentPO instances.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
assignmentOnlineFlag	boolean	True if the assignment is online
domainRef	AuditDomainRef	The assignment domain.
productRef	AuditProductRef	A reference to the product
catalogCategoryRef	AuditCatalogCategoryRef	A reference to the category the product is assigned to

The following snippet shows an example of attribute changes in JSON format while creating an assignment:

"attributeChanges":[
  {
	 "name":"assignmentOnlineFlag",
	 "newValue":true,
	 "oldValue":null
  },
  {
	 "name":"domainRef",
	 "newValue":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-MasterRepository"
	 },
	 "oldValue":null
  },
  {
	 "name":"productRef",
	 "newValue":{
		"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
		"sku":"testproduct",
		"name":"Test Product",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-MasterRepository"
		}
	 },
	 "oldValue":null
  },
  {
	 "name":"catalogCategoryRef",
	 "newValue":{
		"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditCatalogCategoryRef",
		"name":"Components",
		"id":"106",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-MasterRepository"
		}
	 },
	 "oldValue":null
  }
]

The following snippet shows an example of an attribute change in JSON format in the payload when deleting an assignment:

"attributeChanges":[
  {
	 "name":"assignmentOnlineFlag",
	 "newValue":null,
	 "oldValue":true
  },
  {
	 "name":"productRef",
	 "newValue":null,
	 "oldValue":{
		"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
		"sku":"testproduct",
		"name":"Test Product",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-MasterRepository"
		}
	 }
  },
  {
	 "name":"catalogCategoryRef",
	 "newValue":null,
	 "oldValue":{
		"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditCatalogCategoryRef",
		"name":"Components",
		"id":"106",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-MasterRepository"
		}
	 }
  },
  {
	 "name":"domainRef",
	 "newValue":null,
	 "oldValue":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-MasterRepository"
	 }
  }
]

Localization Key and Parameters

The following snippet shows an example of the payload when deleting an assignment:

"descriptionKey":"auditing.message.DELETE.com.intershop.beehive.xcs.internal.catalog.ProductCategoryAssignmentPO.assignment",   
"descriptionParameters":[
  "testproduct",
  "Components"
]

ProductCostPriceMessageProducer

Supported Types

The message producer tracks attribute changes of ProductCostPricePO instances.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
currency	String	The price currency
domainRef	AuditDomainRef	The price domain
productRef	AuditProductRef	A reference to the product this price is assigned to
netPriceFlag	boolean	Set to true if this is a net price
value	String	The price value

The following snippet shows an example of attribute changes in JSON format while updating a product cost price:

"attributeChanges":[
  {
	 "name":"value",
	 "newValue":[
		"java.math.BigDecimal",
		44.00
	 ],
	 "oldValue":[
		"java.math.BigDecimal",
		173.25
	 ]
  }
]

Localization Key and Parameters

The following snippet shows an example of the payload when updating a product cost price:

"descriptionKey":"auditing.message.UPDATE.com.intershop.beehive.xcs.internal.price.ProductCostPricePO.price",
"descriptionParameters":[
	"USD",
	[
		"java.math.BigDecimal",
		454.00
	],
	"110899661"
]

ProductLabelAssignmentMessageProducer

Supported Types

The message producer tracks attribute changes of ProductLabelAssignmentPO instances.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
domainRef	AuditDomainRef	The assignment domain
labelRef	AuditLabelRef	A reference to the the assigned label
productRef	AuditProdutRef	A reference to the product the label is assigned to

The following snippet shows an example of an attribute change in JSON format in the payload when creating a product-label assignment:

 "attributeChanges":[
{
 "name":"productRef",
 "newValue":{
	"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
	"sku":"testproduct",
	"name":"Test Product",
	"domainRef":{
	   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
	   "domainName":"PrimeTech-MasterRepository"
	}
 },
 "oldValue":null
},
{
 "name":"domainRef",
 "newValue":{
	"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
	"domainName":"PrimeTech"
 },
 "oldValue":null
},
{
 "name":"labelRef",
 "newValue":{
	"@class":"com.intershop.component.auditing.capi.ref.objects.AuditLabelRef",
	"name":"Test Label",
	"id":"testlabel",
	"domainRef":{
	   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
	   "domainName":"PrimeTech"
	}
 },
 "oldValue":null
}
]

Localization Key and Parameters

The following snippet shows an example of the payload when creating a product-label assignment:

"descriptionKey":"auditing.message.CREATE.com.intershop.component.mvc.internal.product.ProductLabelAssignmentPO.productID",  
"descriptionParameters":[
  "testproduct",
  "Test Label"
]

ProductLinkPositionMessageProducer

Supported Types

The message producer tracks attribute changes of ProductLinkPositionPO instances.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
domainRef	AuditDomainRef	The link domain
position	Double	The link position (priority)
sourceProductRef	AuditProductRef	A reference to the product to link to
targetProductRef	AuditProductRef	A reference to the linked product

The following snippet shows an example of attribute changes in JSON format when creating a product link position:

"attributeChanges":[
  {
	 "name":"targetProductRef",
	 "newValue":{
		"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
		"sku":"5930238",
		"name":"A-DATA  128GB S599",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-PrimeTechSpecials"
		}
	 },
	 "oldValue":null
  },
  {
	 "name":"position",
	 "newValue":12.0,
	 "oldValue":null
  },
  {
	 "name":"domainRef",
	 "newValue":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-PrimeTechSpecials"
	 },
	 "oldValue":null
  },
  {
	 "name":"sourceProductRef",
	 "newValue":{
		"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
		"sku":"110899661",
		"name":"A-DATA  120GB S510",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-PrimeTechSpecials"
		}
	 },
	 "oldValue":null
  }
]

Localization Key and Parameters

The following snippet shows an example of the payload when updating a product link position:

"descriptionKey":"auditing.message.CREATE.com.intershop.beehive.xcs.internal.product.ProductLinkPositionPO.link",
"descriptionParameters":[
  "110899661",
  "5930238",
  12.0
]

ProductListPriceMessageProducer

Supported Types

The message producer tracks attribute changes of ProductListPricePO instances.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
currency	String	The price currency
domainRef	AuditDomainRef	The price domain
netPriceFlag	boolean	Set to true if this is a net price
productRef	AuditProductRef	A reference to the product this price is assigned to
value	String	The price value

The following snippet shows an example of attribute changes in JSON format while updating a product list price:

"attributeChanges":[
  {
	 "name":"value",
	 "newValue":[
		"java.math.BigDecimal",
		44.00
	 ],
	 "oldValue":[
		"java.math.BigDecimal",
		173.25
	 ]
  }
]

Localization Key and Parameters

The following snippet shows an example of the payload when updating a product list price:

"descriptionKey":"auditing.message.UPDATE.com.intershop.beehive.xcs.internal.price.ProductListPricePO.price",
"descriptionParameters":[
	"USD",
	[
		"java.math.BigDecimal",
		44.00
	],
	"110899661"
]

ProductRatingCommentMessageProducer

Supported Types

The message producer tracks attribute changes of ProductRatingCommentPO instances.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
approvalTime	Date	The time of approval
approvalStatus	Integer	The approval status
approverID	String	The ID of the approving user
approvalComment	String	The comment added by the approver

The following snippet shows an example of attribute changes in JSON format when approving a product rating comment:

"attributeChanges":[
  {
	 "name":"approvalTime",
	 "newValue":[
		"java.util.Date",
		"2013-02-18T10:51:01.809+0000"
	 ],
	 "oldValue":null
  },
  {
	 "name":"approvalStatus",
	 "newValue":1,
	 "oldValue":null
  },
  {
	 "name":"approverID",
	 "newValue":"MvZ_AAAB4YwAAAE8980w7KUe",
	 "oldValue":null
  }
]

Localization Key and Parameters

The following snippet shows an example of the payload when approving a rating comment.

"descriptionKey":"auditing.message.UPDATE.com.intershop.component.ratingorm.internal.orm.RatingCommentPO.product",
"descriptionParameters":[
    "9724679",
	5
],

ProdutVariationMessageProducer

Supported Types

The message producer tracks attribute changes of ProdutVariationPO instances.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
domainRef	AuditDomainRef	The variation domain
productMasterRef	AuditLabelRef	A reference to variation master product
productRef	AuditProdutRef	A reference to the product the label is assigned to

The following snippet shows an example of an attribute change in JSON format in the payload when deleting a product variation:

"attributeChanges":[
  {
	 "name":"productRef",
	 "newValue":null,
	 "oldValue":{
		"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
		"sku":"1YLEDTVSUP",
		"name":"1-year LED TV Support",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-MasterRepository"
		}
	 }
  },
  {
	 "name":"domainRef",
	 "newValue":null,
	 "oldValue":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-MasterRepository"
	 }
  },
  {
	 "name":"productMasterRef",
	 "newValue":null,
	 "oldValue":{
		"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
		"sku":"testproductvariation",
		"name":"Test Product Variation",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-MasterRepository"
		}
	 }
  }
]

Localization Key and Parameters

The following snippet shows an example of the payload when updating a product variation.

"descriptionKey":"auditing.message.CREATE.com.intershop.beehive.xcs.internal.productvariation.ProductVariationPO.variation",  
"descriptionParameters":
[
  "1YLEDTVSUP",
  "testproductvariation"
]

TypedProductCategoryAssignmentMessageProducer

Supported Types

The message producer tracks attribute changes of TypedProductCategoryAssignmentPO instances.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
assignmentOnlineFlag	boolean	True if the product is online
catalogCategoryRef	AuditCatalogCategoryRef	A reference to the assigned category
domainRef	AuditDomainRef	The assignment domain
productRef	AuditProductRef	A reference to the product the category is assigned to
typeCodeInteger	Integer	The type code

The following snippet shows an example of attribute changes in JSON format while creating a typed product category assignment:

"attributeChanges":[
  {
	 "name":"assignmentOnlineFlag",
	 "newValue":true,
	 "oldValue":null
  },
  {
	 "name":"catalogCategoryRef",
	 "newValue":{
		"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditCatalogCategoryRef",
		"name":"Computers",
		"id":"Computers",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-PrimeTechSpecials"
		}
	 },
	 "oldValue":null
  },
  {
	 "name":"typeCodeInteger",
	 "newValue":5,
	 "oldValue":null
  },
  {
	 "name":"domainRef",
	 "newValue":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-PrimeTechSpecials"
	 },
	 "oldValue":null
  },
  {
	 "name":"productRef",
	 "newValue":{
		"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
		"sku":"110899661",
		"name":"A-DATA  120GB S510",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-PrimeTechSpecials"
		}
	 },
	 "oldValue":null
  }
]

Localization Key and Parameters

The following snippet shows an example of the payload when creating a typed product category assignment:

"descriptionKey":"auditing.message.CREATE.com.intershop.beehive.xcs.internal.catalog.TypedProductCategoryAssignmentPO.assignment",
"descriptionParameters":[
  "110899661",
  "Computers"
]

VariableVariationAttributeMessageProducer

Supported Types

The message producer tracks attribute changes of VariableVariationAttributePO instances.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
domainRef	The attribute domain
localizedFlag	boolean	Set to true if localized
name	String	The attribute name
presentationOption	String	The presentation option
presentationProductAttributeName	String	The presentation product attribute name
productMasterRef	AuditProdutRef	A reference to the variation master product

The following snippet shows an example of an attribute change in JSON format in the payload when deleting a variable variation attribute:

"attributeChanges":[
      {
         "name":"name",
         "newValue":null,
         "oldValue":"testattribute"
      },
      {
         "name":"domainRef",
         "newValue":null,
         "oldValue":{
            "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
            "domainName":"PrimeTech-MasterRepository"
         }
      },
      {
         "name":"presentationOption",
         "newValue":null,
         "oldValue":"defaultAndColorCode"
      },
      {
         "name":"presentationProductAttributeName",
         "newValue":null,
         "oldValue":"test"
      },
      {
         "name":"productMasterRef",
         "newValue":null,
         "oldValue":{
            "@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
            "sku":"testproductvariation",
            "name":"Test Product Variation",
            "domainRef":{
               "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
               "domainName":"PrimeTech-MasterRepository"
            }
         }
      }
   ]

Localization Key and Parameters

The following snippet shows an example of the payload when updating a product variation:

"descriptionKey":"auditing.message.CREATE.com.intershop.beehive.xcs.internal.productvariation.VariableVariationAttributePO.attribute",
"descriptionParameters":
[
  "testattribute",
  "testproductvariation"
]

Auditing Promotions and Promotion Code Groups

This reference section describes all message producers for auditing promotions-related configuration in the back office, like:

configuring a promotion (general settings, messages, user(group) assignments, content assignments, ...)
configuring a promotion rule set (rebates with conditions and actions, dynamic message)
configuring a promotion code group
configuring the settings of a promotion attachment file
configuring the job to export promotions

In addition, there are additional settings which can be configured at promotion preferences. However, those preference settings are not included in this release.

defining store level product or category exclusions
setting a global 'legal content' message
defining the budget notification email settings
changing the order in the priority list
setting the limit to number of codes which are allowed to be applied during one checkout transaction

Reference - Audit Promotion

Promotions are a marketing instrument to grant some rebate to a consumer to encourage him to come back shopping again. The promotional framwork provides a wide configuration range, to fullfill different business scenarios, like setting a time frame, applying consumer or consumer groups, or content, etc. to a promotion.
There are two ways to receive a promotion: either a promotion applies automatically on the given order, or the consumer enters a dedicated code. In either ways, a proper configured promotion consists of one or more rebate rules, which defines condition, which mus be fullfilled to receive the promotion, and action, which defines how to grant a rebate.

Therefore, setting up a promotion is a process with many steps. Internally, a lot of ORM object are invovled. Attribute changes of an ORM object will be tracked by an appropriate message producer. The following sections describes all message producer which audit changes on a promotion configuration.

PromotionAuditMessageProducer

Supported Types

The message producer tracks attribute changes of PromotionPO and PromotionPOAttributeValuePO.

Attribute Changes

The following attributes will be audited.

Attribute	Datatype	Description
general settings
displayName	String
description	String
startDate	Date
endDate	Date
enabled	boolean
effectDiscountLevel	boolean	defines, if discount is calculated from base price, or already discounted price
hasDefaultRank	boolean
rank	int	either a user defined value, or an implicit value depending on the promotion action
combination	int
combinationTypes	String
couponCodeRequired	boolean	set, if promotion requires a code while shopping
targetGroupID	String	all assigned target groups are mapped to this promotion target group
targetGroupDomainID	String
budget settings
unlimited	boolean	flag indicated, if promotion has a budget or not
userRef	UserRef	id of the current user configuring the budget settings
budgetPerfiodRef	BudgetPerfiodRef
budgetSourceRef	String	before a budget source is selectable, a list of budget sources had to be maintained at promotion preferences
budgetNotificationThreshold	double
budgetNotificationEmail	String
disableByBudget	boolean
sendMailIfBudgetReached	boolean
sendMailIfThresholdReached	boolean
code
useSingleCode	boolean	promotion uses a single code definition
singleCode	String	single promotion code, which does not belong to any promotion code group
singleCodeTotal	int	limit how often a single code can be reused
codeCustomerUnlimited	boolean	if set to true, the customer can use single code repeatedly
content
contentActivationType	int	The type of the promotion content activation.
contentActivationStartDate	Date
contentActivationEndDate	Date
campaign
useCampaignTimeFrame	boolean
useCampaignTargetGroup	boolean
campaignRef	String	reference to the campaign a promotion is assigned to, a promotion can only be assigned to one campaign at a moment
messaging
Icon	String	link to an image
LegalContentMessage	String
LongTitle	String
RuleDescription	String
Title	String
ExternalDetailsURL	String
UseExternalURL	boolean
DisableMessages	boolean	if selected, the messages are not shown in the storefront

The following snippet shows an example of attribute changes in JSON format while creating a promotion.

"attributeChanges":[

    {
        "name":"ID",
        "newValue":"TestPromotion",
        "oldValue":null
    },
    {
        "name":"enabledFlag",
        "newValue":true,
        "oldValue":null
    },
    {
        "name":"startDate",
        "newValue":[
            "java.util.Date",
            "2012-06-26T09:41:00.000+0000"
        ],
        "oldValue":null
    },
    {
        "name":"endDate",
        "newValue":[
            "java.util.Date",
            "2012-06-27T09:41:00.000+0000"
        ],
        "oldValue":null
    },
    {
        "name":"couponCodeRequiredFlag",
        "newValue":false,
        "oldValue":null
    },
    {
        "name":"currencyCode",
        "newValue":"USD",
        "oldValue":null
    },
    //...many, many more
],

The following snippet shows an example of an attribute change in JSON format in the payload for deactivating a promotion.

"attributeChanges":[
    {
        "name":"enabledFlag",
        "newValue":false,
        "oldValue":true
    }
],

Localization Key and Parameters

The following snippet shows an example of the payload, when updating a promotion.

"descriptionKey":"auditing.message.UPDATE.com.intershop.component.marketing.internal.rebate.PromotionPO.promotionID",
"descriptionParameters":[
    "TestPromotion"
]

PromotionNoteAuditMessageProducer

The promotional framework offers the possibility to write some notes on selected promotions. This message producer tracks the notes.

Supported Types

The message producer tracks attribute changes of PromotionNotePO.

Attribute Changes

The following attributes will be audited.

Attribute	Datatype	Description
promotionRef	AuditPromotionRef	the reference to the promotion the note belongs to
userRef	AuditUserRef	the reference to the editor of the note
domainRef	AuditDomainRef	the reference to domain
note	String	a text
creationDate	Date	the edit date

The following snippet shows an example of attribute changes in JSON format while creating a promotion note.

"attributeChanges":[
    {
        "name":"promotionRef",
        "newValue":{
            "@class":"com.intershop.component.marketing.internal.promotion.auditing.refs.AuditPromotionRef",
            "promotionID":"TestPromotion",
            "domainRef":{
                "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
                "domainName":"PrimeTech-PrimeTechSpecials"
            }
        },
        "oldValue":null
    },
    {
        "name":"userRef",
        "newValue":{
            "@class":"com.intershop.component.auditing.capi.ref.objects.AuditUserRef",
            "login":"admin",
            "domainRef":{
                "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
                "domainName":"PrimeTech"
            }
        },
        "oldValue":null
    },
    {
        "name":"creationDate",
        "newValue":[
            "java.util.Date",
            "2012-06-26T10:22:04.237+0000"
        ],
        "oldValue":null
    },
    {
        "name":"domainRef",
        "newValue":{
            "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
            "domainName":"PrimeTech-PrimeTechSpecials"
        },
        "oldValue":null
    },
    {
        "name":"note",
        "newValue":[
            "[C",
            "I disabled the promotion.<br/>"
        ],
        "oldValue":null
    }
],

Localization Key and Parameters

The message to be shown in the back office is set in the localization file auditing_en.properties in bc_marketing. The placeholders will be replaced by the localization framework in the order the description parameters are given. The key and the parameters are stored in the payload by the message producer.

The following snippet shows an example of the payload when creating a promotion note.

"descriptionKey":"auditing.message.CREATE.com.intershop.component.marketing.internal.promotion.note.PromotionNotePO.promotionID",
"descriptionParameters":[
    "TestPromotion"
]

PromotionApplicationAssignmentAuditMessageProducer

A promotion can live in one or more applications, like webshop or mobile application. This message producer tracks the assignment of a promotion to an application.

Supported Types

The message producer tracks attribute changes of PromotionAppAssignmentPO.

Attribute Changes

The following attributes will be audited.

Attribute	Datatype	Description
promotionRef	AuditPromotionRef	the reference to the promotion, the note belongs to
applicationRef	AuditApplicationRef	the reference to the editor of the note

The following snippet shows an example of attribute changes in JSON format when assigning a promotion to an application.

"attributeChanges":[
    {
        "name":"promotionRef",
        "newValue":{
            "@class":"com.intershop.component.marketing.internal.promotion.auditing.refs.AuditPromotionRef",
            "promotionID":"TestPromotion",
            "domainRef":{
                "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
                "domainName":"PrimeTech-PrimeTechSpecials"
            }
        },
        "oldValue":null
    },
    {
        "name":"applicationRef",
        "newValue":{
            "@class":"com.intershop.component.auditing.capi.ref.objects.AuditApplicationRef",
            "siteName":"PrimeTech-PrimeTechSpecials-Site",
            "urlId":"b2c-web-shop"
        },
        "oldValue":null
    }
],

Localization Key and Parameters

The following snippet shows an example of the payload when assigning a promotion to an application.

"descriptionKey":"auditing.message.CREATE.com.intershop.component.marketing.internal.promotion.assignment.PromotionAppAssignmentPO.promotionID.appID",
"descriptionParameters":[
    "TestPromotion",
    "test@PrimeTech-PrimeTechSpecials-Site"
],

PromotionBudgetPeriodAuditMessageProducer

A promotion can either be unlimited or have a defined budget. This message producer tracks the appliance of a promotion budget, and any changes to the limit. Note that it will not track the consumption of the budget by a promotion which has been applied successfully.

Supported Types

The message producer tracks attribute changes of BudgetPeriodPO and BudgetPeriodPOAttributeValuePO.

Attribute Changes

The following attributes will be audited.

Attribute	Datatype	Description
amount	String	the budget amount
currency	String	the currency
toDate	Date	start date of the promotion
fromDate	Date	end date of the promotion

The following snippet shows an example of an attribute change in JSON format when setting a budget.

"attributeChanges":[
    {
        "name":"amountValue",
        "newValue":{
            "@class":"com.intershop.beehive.foundation.quantity.Money",
            "value":22000.00,
            "currency":"USD"
        },
        "oldValue":{
            "@class":"com.intershop.beehive.foundation.quantity.Money",
            "value":0,
            "currency":"USD"
        }
    }
]

Localization Key and Parameters

The following snippet shows an example of the payload when setting a budget.

"descriptionKey":"auditing.message.UPDATE.com.intershop.component.organization.internal.budget.BudgetPeriodPO.budgetAmount.promotionID",
"descriptionParameters":[
    {
        "@class":"com.intershop.beehive.foundation.quantity.Money",
        "value":22000.00,
        "currency":"USD"
    },
    "TestPromotion"
],

PromotionPageletAssignmentAuditMessageProducer

A promotion can be associated with pagelets. This message producer tracks the assignment and unassignment between a promotion and pagelets.

Supported Types

The message producer tracks attribute changes of PageletPromotionAssignmentPO.

Attribute Changes

The following attributes will be audited.

Attribute	Datatype	Description
promotionRef	AuditPromotionRef	the reference to the associated promotion
pageletRef	AuditPageletRef	the reference to the associated pagelet

The following snippet shows an example of an attribute change in JSON format when assigning a pagelet.

"attributeChanges":[

    {
        "name":"promotionRef",
        "newValue":{
            "@class":"com.intershop.component.marketing.internal.promotion.auditing.refs.AuditPromotionRef",
            "promotionID":"Promotion1",
            "domainRef":{
                "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
                "domainName":"PrimeTech-PrimeTechSpecials"
            }
        },
        "oldValue":null
    },
    {
        "name":"pageletRef",
        "newValue":{
            "@class":"com.intershop.component.pmc.internal.auditing.refs.AuditPageletRef",
            "pagletID":"pagevariation_category_computers",
            "domainRef":{
                "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
                "domainName":"PrimeTech-PrimeTechSpecials"
            }
        },
        "oldValue":null
    }

],

Localization Key and Parameters

The following snippet shows an example of the payload when assigning a pagelet.

"auditing.message.CREATE.com.intershop.component.marketing.internal.promotion.assignment.PageletPromotionAssignmentPO.promotionID.pageletID",
"descriptionParameters":[

    "Promotion1",
    "pagevariation_category_computers"

]

Audit Promotion Code Group

A promotion code groups is a container holding promotion codes. Like promotions, promotion code groups can be assigned different applications and user, or user group respectively. However, its main purpose is to maintain promotion code.

PromotionCodeGroupAuditMessageProducer

Supported Types

The message producer tracks attribute changes of PromotionCodeGroupPO and PromotionCodeGroupPOAttributeValuePO.

Attribute Changes

The following attributes are stored in the payload.

Attribute	Datatype
name	String
description	String
domain	AuditDomainRef
codeQuantity	int
usePromotionTime	boolean
startDate	Date
endDate	Date
enabled	boolean
usePromotionTargetGroups	boolean
numberOfReuses	int
numberOfReusesPerCustomer	int
createdCodeQuantity	int
usePromotionApps	boolean

The following snippet shows an example of the payload when creating a promotion code group.

    "attributeChanges":[
        {
            "name":"usePromotionTargetGroupsFlag",
            "newValue":false,
            "oldValue":null
        },
        {
            "name":"enabledFlag",
            "newValue":false,
            "oldValue":null
        },
        {
            "name":"usePromotionAppsFlag",
            "newValue":false,
            "oldValue":null
        },
        {
            "name":"ID",
            "newValue":"Promotion Code Group",
            "oldValue":null
        },
        {
            "name":"usePromotionTimeFlag",
            "newValue":false,
            "oldValue":null
        },
        {
            "name":"domainRef",
            "newValue":{
                "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
                "domainName":"PrimeTech-PrimeTechSpecials"
            },
            "oldValue":null
        }
    ],
}

Localization Key and Parameters

The following snippet shows an example of the payload when creating a promotion code group.

    "descriptionKey":"auditing.message.CREATE.com.intershop.component.marketing.internal.code.PromotionCodeGroupPO.promoCodeGroupID",
    "descriptionParameters":[
        "Promotion Code Group"
    ]

PromoCodeGroupAppAssignmentAuditMessageProducer

Promotion code groups can be assigned to different application. This message producer tracks this assignment.

Supported Types

The message producer tracks attribute changes of PromoCodeGroupAppAssignmentPO.

Attribute Changes

The following attributes are stored in the payload.

Attribute	Datatype
promotionCodeGroupRef	AuditPromotionCodeGroupRef
applicationRef	AuditApplicationRef
domainRef	DomainRef

The following snippet shows an example of the payload in JSON format when creating a promotion code group.

"attributeChanges":[

    {
        "name":"applicationRef",
        "newValue":{
            "@class":"com.intershop.component.auditing.capi.ref.objects.AuditApplicationRef",
            "siteName":"PrimeTech-PrimeTechSpecials-Site",
            "urlId":"b2c-web-shop"
        },
        "oldValue":null
    },
    {
        "name":"promotionCodeGroupRef",
        "newValue":{
            "@class":"com.intershop.component.marketing.internal.promotion.auditing.refs.AuditPromotionCodeGroupRef",
            "promotionCodeGroupID":"Promotion Code Group",
            "domainRef":{
                "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
                "domainName":"PrimeTech-PrimeTechSpecials"
            }
        },
        "oldValue":null
    }

],

Localization Key and Parameters

The following snippet shows an example of the payload in JSON format when creating a promotion code group.

"descriptionKey":"auditing.message.CREATE.com.intershop.component.marketing.internal.code.PromoCodeGroupAppAssignmentPO.promoCodeGroupID.appID",
"descriptionParameters":[
    "mp6p_gxx6joAAAE4e_M2oCQE",
    "gZ0KAB2c2IoAAAE3cqIV0OLw"
]

PromoCodeGroupUserGroupAssignmentAuditMessageProducer

A promotion code group can be assigned to different user groups. This message producer tracks the assignments.

Supported Types

The message producer tracks attribute changes of PromoCodeGroupUGrpAssignmentPO.

Attribute Changes

The following attributes are stored in the payload.

Attribute	Datatype	Description
promotionCodeGroupRef	AuditPromotionCodeGroupRef
userGroupRef	AuditUserGroupRef
numberOfReusesPerUgrp	int	number of allowed reuses for the associated user group
numberOfRedemptions	int	number of redemptions

The following snippet shows an example of the payload when adding a user group to a promotion code group.

"attributeChanges":[

    {
        "name":"numberOfReusesPerUgrp",
        "newValue":0,
        "oldValue":null
    },
    {
        "name":"userGroupRef",
        "newValue":{
            "@class":"com.intershop.component.auditing.capi.ref.objects.AuditUserGroupRef",
            "userGroupID":"Everyone",
            "domainRef":{
                "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
                "domainName":"Y6oKAB2cAW4AAAE3BqcV0OLw"
            }
        },
        "oldValue":null
    },
    {
        "name":"numberOfRedemptions",
        "newValue":0,
        "oldValue":null
    },
    {
        "name":"promotionCodeGroupRef",
        "newValue":{
            "@class":"com.intershop.component.marketing.internal.promotion.auditing.refs.AuditPromotionCodeGroupRef",
            "promotionCodeGroupID":"Promotion Code Group",
            "domainRef":{
                "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
                "domainName":"PrimeTech-PrimeTechSpecials"
            }
        },
        "oldValue":null
    },

Localization Key and Parameters

The following snippet shows an example of the payload when adding the user group Everyone to a promotion code group.

"descriptionKey":"auditing.message.CREATE.com.intershop.component.marketing.internal.code.PromoCodeGroupUGrpAssignmentPO.promoCodeGroupID.userGroupID",
"descriptionParameters":[
    "Promotion Code Group",
    "Everyone"
]

PromotionCodeAuditMessageProducer

A promotion code group is a container to maintain codes. This message producer tracks the changes on promotion codes and the assignment to their code group.

Supported Types

The message producer tracks attribute changes of PromotionCodePO.

Attribute Changes

The following attributes are stored in the payload.

Attributes\References	Datatype	Description
promotionCodeGroupRef	AuditPromotionCodeGroupRef
code	String	the code
status	int	the state: (0 = not redeemed, 1 = fully redeemed, 2 = deactivated)
securedFlag	boolean	if true, code is encrypted, otherwise in plain text
domainRef	AuditDomainRef

The following snippet shows an example of the payload when creating a promotion code for a promotion code group.

{
"attributeChanges":[
    {
        "name":"status",
        "newValue":0,
        "oldValue":null
    },
    {
        "name":"securedFlag",
        "newValue":false,
        "oldValue":null
    },
    {
        "name":"code",
        "newValue":"code 3",
        "oldValue":null
    },
    {
        "name":"domainRef",
        "newValue":{
            "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
            "domainName":"PrimeTech-PrimeTechSpecials"
        },
        "oldValue":null
    },
    {
        "name":"promotionCodeGroupRef",
        "newValue":{
            "@class":"com.intershop.component.marketing.internal.promotion.auditing.refs.AuditPromotionCodeGroupRef",
            "promotionCodeGroupID":"Promotion Code Group",
            "domainRef":{
                "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
                "domainName":"PrimeTech-PrimeTechSpecials"
            }
        },
        "oldValue":null
    }
],
}

Localization Key and Parameters

The following snippet shows an example of the payload when creating a promotion code for a promotion code group.

"descriptionKey":"auditing.message.CREATE.com.intershop.component.marketing.internal.code.PromotionCodePO.promotionCode",
"descriptionParameters":[
    "code 3"
]

PromoCodeGroupPromoAssignmentAuditMessageProducer

A promotion code group can be assigned to different promotions. This message producer tracks the assignments.

Supported Types

The message producer tracks attribute changes of PromoCodeGroupPromoAssignmentPO.

Attribute Changes

The following attributes are stored in the payload.

Attributes\References	Datatype
promotionCodeGroupRef	AuditPromotionCodeGroupRef
promotionRef	AuditPromotionRef

The following snippet shows an example of the payload when adding a promotion to a promotion code group.

{
"attributeChanges":[
    {
        "name":"promotionRef",
        "newValue":{
            "@class":"com.intershop.component.marketing.internal.promotion.auditing.refs.AuditPromotionRef",
            "promotionID":"Promotion1",
            "domainRef":{
                "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
                "domainName":"PrimeTech-PrimeTechSpecials"
            }
        },
        "oldValue":null
    },
    {
        "name":"promotionCodeGroupRef",
        "newValue":{
            "@class":"com.intershop.component.marketing.internal.promotion.auditing.refs.AuditPromotionCodeGroupRef",
            "promotionCodeGroupID":"Promotion Code Group",
            "domainRef":{
                "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
                "domainName":"PrimeTech-PrimeTechSpecials"
            }
        },
        "oldValue":null
    }

],
}

Localization Key and Parameters

The following snippet shows an example of the payload when adding a promotion to a promotion code group.

"descriptionKey":"auditing.message.CREATE.com.intershop.component.marketing.internal.code.PromoCodeGroupPromoAssignmentPO.promoCodeGroupID.promotionID",
"descriptionParameters":[
    "Promotion Code Group",
    "Promotion1"
]

Audit Promotion Attachment Upload

For "Promotion Attachment" it is required to track changes on the file level, like creating a sub-directory below "Promotion Attachment", or like uploading an attachment file. Since there is no ORMObject involved, auditing must be triggered in the pipeline where the changes take place. The business logic is always embedded in a transaction.

The transaction is opened.
Any business logic is performed and its action audited.
The transaction is committed in case of success, or rolled back in case of an error.

Pipelet AuditFileLevelEvent

The pipelet AuditFileLevelEvent does the business logic, here, and prepares the auditing payload according to the passed input parameter. It can be used to for different scenarios, like:

preparing the payload when creating a directory,
preparing the payload when renaming a directory,
preparing the payload when deleting a directory,
preparing the payload when uploading a file,
preparing the payload when deleting an uploaded file.

AuditFileLevelEvent	Datatype	Description
Configuration
ActionType	String	The action: CREATE, UPDATE, DELETE
IsDirectory	boolean	Set to true if an event for a directory shall be stored in the payload. Otherwise, set to false, if a file event shall be stored in the payload.
Input
AuditType	String	The ORM action, like CREATE, UPDATE, DELETE.
LocalID	String	The current locale. If no locale is given, it falls back to the current request's locale.
NewName	String	The new directory or file name after the change.
OldName	String	The old directory or file name before the change.
OverrideUnitDirectory	Sring	Pass the name of a directory here, which will be taken instead of the standard unit directory, when creating the EMS path.
Path	String	The relative path from either UnitDirectory, or OverrideUnitDirectory, if given.
UnitDirectory	String	The name of the unit directory, e.g. SECURE_STATIC_DIR, STATIC_CONTENT_DIR.
UnitDomain	Domain	The unit domain.
Output
AuditMessagePayload	AuditMessagePayload	The payload containing all information.
AuditObject	VirtualAuditObject	A virtual business object, which refers to a business area, like 'Promotion', 'Pricing', etc.

In order to write the audit log message, the payload created by AuditFileLevelEvent must be passed to LogAuditMessage.

Pipeline ViewPromotionAttachmentUpload

Following the auditing implementation pattern explained above, auditing is included into nodes of pipeline ViewPromotionAttachmentUpload:

AddDirectory
RenameDirectory
DeleteDirectory
Upload
DeleteFiles

Payload example

The following snippet shows an example of the payload, when renaming a directory.

{
    "attributeDataType":"DirectoryEvent_PromotionAttachment",
    "attributeChanges":[
        {
            "name":"directory",
            "newValue":"\\en_US\\test2",
            "oldValue":"\\en_US\\test1"
        }
    ],
    ...
}

Localization

The entries descriptionKey and descriptionParameters are needed for localizing. The message can be found in sld_ch_base\staticfiles\cartridge\localizations\auditing_en.properties.

Note

Note: The audit type passed to AuditFileLevelEvent must be part of the descriptionKey for the localization, for example DirectoryEvent_PromotionAttachment.

The raw message:

     auditing.message.UPDATE.DirectoryEvent_PromotionAttachment.oldName.newName=Renamed promotion attachment directory from "{0}" to "{1}".

Values in the payload:

    "descriptionKey":"auditing.message.UPDATE.DirectoryEvent_PromotionAttachment.oldName.newName",
    "descriptionParameters":[
        "\\en_US\\test1",
        "\\en_US\\test2"
    ]

The resolved message:

    Renamed promotion attachment directory from "\en_US\test1" to "\en_US\test2".

Audit Promotion Export Job

In contrast to other promotion areas, there is no dedicated PromotionExportJobMessageProducer. Audit messages for job configurations are tracked by JobConfigurationAuditMessageProducer. For more information, please refer to Reference-Auditing Jobs-JobConfigurationAuditMessageProducer.

In order to map messages from different job configurations to a business field, like Promotions, the class JobConfigurationNamedAuditObjectRefProvider returns a AuditObjectRef containing the pipeline name + start node as key.

The framework resolves it internally to the following key, which is stored in addition to the log message in the database.

    NamedObject:com.intershop.component.auditing.capi.ref.objects.AuditJobConfigurationRef:PromotionImpex-Export,

The mapping of business areas and concrete audit types are done in property file auditing.properties maps.

auditing.properties

# Promotions
com.intershop.auditing.report.objecttype.Promotion= ...
               NamedObject:com.intershop.component.auditing.capi.ref.objects.AuditJobConfigurationRef:PromotionImpex-Export, \
               ...

Auditing User Groups

Reference-Auditing User Groups-UserGroupAssignmentAuditMessageProducer

This message producer extends com.intershop.component.pricing.internal.auditing.messageproducer.AbstractPayloadAuditMessageProducer. It can be configured to use a UserGroupAuditMessageProducerTypeHandler that delivers the businness object the assignment is made for (parent as well as child).
The default implementation is GenericUserGroupHandler which is used if no type handler is set or the UserGroup does not match the type handler. The GenericUserGroupHandler provides a com.intershop.component.auditing.capi.ref.objects.AuditUserGroupRef. This ref extends AbstractAuditDomainObjectRef<UserGroup> and uses the following attributes as a semantic key:

Type	Name	Description
String	userGroupID	the ID of the referenced user group
AuditDomainRef	domainRef	the domain ref of the referenced user group domain

A sample in JSON:

com.intershop.component.auditing.capi.ref.objects.AuditUserGroupRef

{
	"@class":"com.intershop.component.auditing.capi.ref.objects.AuditUserGroupRef",
	"userGroupID":"Everyone",
	"domainRef":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-PrimeTechSpecials-Anonymous"
	}
}

Attribute Changes

The following UserGroupAssignmentPO attributes are stored in the payload.

AuditedItem Attribute	AuditItem Payload Attribute	Comment
parentUserGroupID, parentUserGroupDomainID	parent<typeID>Ref	stored as AuditObjectRef provided by the UserGroupAuditMessageProducerTypeHandler
childUserGroupID, childUserGroupDomainID	child<typeID>Ref	stored as AuditObjectRef provided by the UserGroupAuditMessageProducerTypeHandler

Payload sample

attributeDataType=com.intershop.beehive.core.internal.user.UserGroupAssignmentPO

{
	"attributeDataType":"com.intershop.beehive.core.internal.user.UserGroupAssignmentPO",
	"metaInformation":{
		"parentRef":{
			"@class":"com.intershop.component.marketing.internal.promotion.auditing.refs.AuditPromotionRef",
			"promotionID":"TestPromotion5",
			"domainRef":{
				"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
				"domainName":"PrimeTech-PrimeTechSpecials"
			}
		},
		"childRef":{
			"@class":"com.intershop.component.auditing.capi.ref.objects.AuditUserGroupRef",
			"userGroupID":"Everyone",
			"domainRef":{
				"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
				"domainName":"PrimeTech-PrimeTechSpecials-Anonymous"
			}
		}
	},
	"attributeChanges":[
		{
			"name":"parentpromotionRef",
			"newValue":{
				"@class":"com.intershop.component.marketing.internal.promotion.auditing.refs.AuditPromotionRef",
				"promotionID":"TestPromotion5",
				"domainRef":{
					"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
					"domainName":"PrimeTech-PrimeTechSpecials"
				}
			},
			"oldValue":null},
		{
			"name":"childusergroupRef",
			"newValue":{
				"@class":"com.intershop.component.auditing.capi.ref.objects.AuditUserGroupRef",
				"userGroupID":"Everyone",
				"domainRef":{
					"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
					"domainName":"PrimeTech-PrimeTechSpecials-Anonymous"
				}
			},
			"oldValue":null
		}
	],
	"descriptionKey":"auditing.message.CREATE.com.intershop.beehive.core.internal.user.UserGroupAssignmentPO.promotionID.usergroupID",
	"descriptionParameters":["TestPromotion5","Everyone"]
}

The attribute suffix of the "descriptionKey" of UserGroupAssignmentPO is "<parentTypeID>ID.<childTypeID>.ID". The values of the description parameters are the respective IDs of the business object delivered by the UserGroupAuditMessageProducerTypeHandler.

Reference-Auditing User Groups-UserGroupUserAssignmentAuditMessageProducer

This message producer extends com.intershop.component.pricing.internal.auditing.messageproducer.AbstractPayloadAuditMessageProducer.
It has be configured to use a UserGroupAuditMessageProducerTypeHandler that delivers the business object owning the UserGroup the assignment is made for. The message producer uses com.intershop.component.auditing.capi.ref.objects.AuditUserRef for the User the assignment is made for. This Ref extends AbstractAuditDomainObjectRef<Profile> and uses the following attributes as a semantic key:

Type	Name	Description
String	login	the login of the referenced user
AuditDomainRef	domainRef	the domain ref of the referenced user domain

A sample in JSON:

com.intershop.component.auditing.capi.ref.objects.AuditUserRef

{
	"@class":"com.intershop.component.auditing.capi.ref.objects.AuditUserRef",
	"login":"alexandra@test.intershop.de",
	"domainRef":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-PrimeTechSpecials-Anonymous"
	}
}

Attribute Changes

The following UserGroupAssignmentPO attributes are stored in the payload.

AuditedItem Attribute	AuditItem Payload Attribute	Comment
userID	userRef	stored as AuditUserRef
userGroupID, userGroupDomainID	parent<typeID>Ref	stored as AuditObjectRef provided by the UserGroupAuditMessageProducerTypeHandler

Payload sample

attributeDataType=com.intershop.beehive.core.internal.user.UserGroupUserAssignmentPO

{
	"attributeDataType":"com.intershop.beehive.core.internal.user.UserGroupUserAssignmentPO",
	"attributeChanges":[
		{
			"name":"userRef",
			"newValue":{
				"@class":"com.intershop.component.auditing.capi.ref.objects.AuditUserRef",
				"login":"alexandra@test.intershop.de",
				"domainRef":{
					"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
					"domainName":"PrimeTech-PrimeTechSpecials-Anonymous"
				}
			},
			"oldValue":null
		},
		{
			"name":"parentpromotionRef",
			"newValue":{"@class":"com.intershop.component.marketing.internal.promotion.auditing.refs.AuditPromotionRef",
			"promotionID":"TestPromotion1",
			"domainRef":{
				"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
				"domainName":"PrimeTech-PrimeTechSpecials"}},
				"oldValue":null
		}
	],
	"metaInformation":{
		"userRef":{
			"@class":"com.intershop.component.auditing.capi.ref.objects.AuditUserRef",
			"login":"alexandra@test.intershop.de",
			"domainRef":{
				"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
				"domainName":"PrimeTech-PrimeTechSpecials-Anonymous"
			}
		},
		"objectRef":{
			"@class":"com.intershop.component.marketing.internal.promotion.auditing.refs.AuditPromotionRef",
			"promotionID":"TestPromotion1",
			"domainRef":{
				"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
				"domainName":"PrimeTech-PrimeTechSpecials"
			}
		}
	},
	"descriptionKey":"auditing.message.CREATE.com.intershop.beehive.core.internal.user.UserGroupUserAssignmentPO.promotionID.userLoginName",
	"descriptionParameters":["TestPromotion1","alexandra@test.intershop.de"]
}

The attribute suffix of the "descriptionKey" of UserGroupUserAssignmentPO is "<parentTypeID>ID.userLoginName". The values of the description parameters are ID of the business object delivered by the UserGroupAuditMessageProducerTypeHandler and the login of the Profile (or "ANONYMOUS" if no login is set).

Auditing Content

This section describes the auditing message producers related to content objects.

ConfigurationParameterAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of PageletPO, SlotPO, ViewContextPO, or AbstractPageletEntryPointPO which are subclasses of ConfigurationParameterPO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
domain	AuditDomainRef	the domain
name	String	name of the configuration parameter
pageletEntryPointRef	AuditPageletEntryPointRef	the pagelet entry point the configuration parameter belongs to
pageletRef	AuditPageletRef	the pagelet the configuration parameter belongs to
slotRef	AuditSlotRef	the slot the configuration parameter belongs to
viewContextRef	AuditViewContextRef	the view context the configuration parameter belongs to

The following snippet shows an example of an attribute change in JSON format in the payload when updating a configuration parameter:

"attributeChanges":
[
  {
    "name" : "domainRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
      "domainName" : "1371475644532"
    },
    "oldValue" : null
  },
  {
    "name" : "name",
    "newValue" : "Text",
    "oldValue" : null
  },
  {
    "name" : "pageletEntryPointRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.capi.auditing.refs.objects.AuditPageletEntryPointRef",
      "pageletEntryPointType" : "page",
      "pageletEntryPointDefinitionQualifiedName" : "auditing.pagelet2-pageEntryPoint",
      "id" : "pageletEntryPoint_14",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "1371475644532"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "Text",
    "newValue" : "Test Value",
    "oldValue" : null,
    "localeID" : "en_US"
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.ConfigurationParameterPO.pageletType.pageletID.pageletDefinitionQualifiedName.configurationParameterDefinitionQualifiedName.configurationParameterName=Created configuration parameter "{4}" of {0} "{1}" ({0} template="{2}", parameter template="{3}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.ConfigurationParameterPO.pageletType.pageletID.pageletDefinitionQualifiedName.configurationParameterDefinitionQualifiedName.configurationParameterName
"descriptionParameters":
[
  "component",
  "auditing.pagelet2-pagelet_0",
  "auditing.pagelet2-pagelet",
  "auditing.pagelet2-pagelet-Text",
  "Text"
]

PageletAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of PageletPO and PageletPOAttributeValuePO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
activeFlag	Boolean	flag, which indicates, if the component is active or not
domainRef	AuditDomainRef	the pagelet domain
id	String	the pagelet ID
parentRef	AuditPageletRef	the parent page
validFrom	Date	the end date when the page gets inactive
validTo	Date	the start date when the page becomes active

The following snippet of the payload shows an example of creating a new page in JSON format:

"attributeChanges":[

    {
        "name":"onlineFlag",
        "newValue":true,
        "oldValue":null
    },
    {
        "name":"id",
        "newValue":"cmp_20130517_133214",
        "oldValue":null
    },
    {
        "name":"domainRef",
        "newValue":{
            "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
            "domainName":"PrimeTech-PrimeTechSpecials"
        },
        "oldValue":null
    },
    {
        "name":"validFrom",
        "newValue":[
            "java.util.Date",
            "2013-04-30T22:00:00.000+0000"
        ],
        "oldValue":null
    },
    {
        "name":"validTo",
        "newValue":[
            "java.util.Date",
            "2013-05-30T22:00:00.000+0000"
        ],
        "oldValue":null
    }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.DELETE.com.intershop.component.pmc.internal.pagelet.PageletPO.pageletType.pageletID.pageletDefinitionQualifiedName=Deleted {0} "{1}" (template="{2}").
auditing.message.DELETE.com.intershop.component.pmc.internal.pagelet.PageletPOAttributeValuePO.pageletType.pageletID.pageletDefinitionQualifiedName.avName.avLocaleID=Deleted attribute "{3}" of {0} "{1}" (locale={4}, {0} template="{2}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.DELETE.com.intershop.component.pmc.internal.pagelet.PageletPO.pageletType.pageletID.pageletDefinitionQualifiedName
"descriptionParameters":
[
  "component template",
  "auditing.pagelet2-pagelet_15",
  "auditing.pagelet2-pagelet"
]

"descriptionKey": auditing.message.DELETE.com.intershop.component.pmc.internal.pagelet.PageletPOAttributeValuePO.pageletType.pageletID.pageletDefinitionQualifiedName.avName.avLocaleID
"descriptionParameters":
[
  "component template",
  "auditing.pagelet2-pagelet_15",
  "auditing.pagelet2-pagelet",
  "displayName",
  "en_US"
]

PageletConstraintAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of PageletConstraintPO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
id	String	ID of the pagelet

The following snippet shows an example of an attribute change in JSON format in the payload when creating a PageletConstraint:

"attributeChanges":
[
  {
    "name" : "id",
    "newValue" : "auditing.pagelet2-pagelet_20",
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.constraint.PageletConstraintPO.assignmentPageletEntryPointType.assignmentPageletEntryPointID.assignmentPageletEntryPointDefinitionQualifiedName.pageletType.pageletID.pageletDefinitionQualifiedName=Created {3} "{4}" constraint (template="{5}") for {0} "{1}" (template="{2}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.constraint.PageletConstraintPO.assignmentPageletEntryPointType.assignmentPageletEntryPointID.assignmentPageletEntryPointDefinitionQualifiedName.pageletType.pageletID.pageletDefinitionQualifiedName
"descriptionParameters":
[
  "page",
  "pageletEntryPoint_3",
  "auditing.pagelet2-pageEntryPoint",
  "page variant",
  "auditing.pagelet2-pagelet_20",
  "auditing.pagelet2-pagelet"
]

PageletDefinitionConstraintAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of PageletDefinitionConstraintPO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
definitionQualifiedName	String	the qualified name of the pagelet

The following snippet shows an example of an attribute change in JSON format in the payload when creating a PageletDefinitionConstraint:

"attributeChanges": 
[
  {
    "name" : "definitionQualifiedName",
    "newValue" : "auditing.pagelet2-pagelet",
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.constraint.PageletDefinitionConstraintPO.assignmentPageletEntryPointType.assignmentPageletEntryPointID.assignmentPageletEntryPointDefinitionQualifiedName.definitionQualifiedName=Created constraint "{3}" for {0} "{1}" (template="{2}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.constraint.PageletDefinitionConstraintPO.assignmentPageletEntryPointType.assignmentPageletEntryPointID.assignmentPageletEntryPointDefinitionQualifiedName.definitionQualifiedName
"descriptionParameters":
[
  "page",
  "pageletEntryPoint_5",
  "auditing.pagelet2-pageEntryPoint",
  "auditing.pagelet2-pagelet"
]

PageletLabelAssignmentAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of PageletLabelAssignmentPO. This happens when a label is assigned to a content component (pagelet) in the back office.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
domainRef	AuditDomainRef	the pagelet assigned to the A/B test group
pageletRef	AuditPageletRef	the pagelet the label is assigned to
labelRef	AuditLabelRef	the label assigned to the entry point

The following snippet shows an example of the attribute changes in JSON format in the payload when assigning a label to pagelet:

"attributeChanges":
[
  {
    "name" : "domainRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
      "domainName" : "1372150136524"
    },
    "oldValue" : null
  },
  {
    "name" : "pageletRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.auditing.capi.pagelet.ref.objects.AuditPageletRef",
      "pageletID" : "auditing.pagelet2-pagelet_28",
      "pageletType" : "component template",
      "pageletDefinitionQualifiedName" : "auditing.pagelet2-pagelet",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "TestOrganization1372150184739-Repository"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "labelRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditLabelRef",
      "name" : null,
      "id" : "testlabel",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "1372150136524"
      }
    },
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.PageletLabelAssignmentPO.pageletType.pageletID.pageletDefinitionQualifiedName.labelID.labelName=Created assignment of {0} "{1}" (template="{2}") to label "{4}" (ID="{3}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.PageletLabelAssignmentPO.pageletType.pageletID.pageletDefinitionQualifiedName.labelID.labelName
"descriptionParameters":
[
  "component template",
  "auditing.pagelet2-pagelet_28",
  "auditing.pagelet2-pagelet",
  "testlabel",
  null
]

PageletPageletEntryPointAssignmentAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of PageletPageletEntryPointAssignmentPO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
domainRef	AuditDomainRef	the assignment domian
onlineFlag	Boolean	flag indicating wether the assignment is online
pageletEntryPointRef	AuditPageletEntryPointRef	the referenced pagelet entry point
pageletRef	AuditPageletRef	the referenced pagelet
position	Double	the assignment order
validFrom	Date	the start of the online period
validTo	Date	the end of the online period

The following snippet shows an example of the attribute changes in JSON format:

"attributeChanges":
[
  {
    "name" : "pageletRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.auditing.capi.pagelet.ref.objects.AuditPageletRef",
      "pageletID" : "auditing.pagelet2-pagelet_30",
      "pageletType" : "component",
      "pageletDefinitionQualifiedName" : "auditing.pagelet2-pagelet",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "TestOrganization1372150185542-Repository"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "onlineFlag",
    "newValue" : false,
    "oldValue" : null
  },
  {
    "name" : "domainRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
      "domainName" : "1372150136526"
    },
    "oldValue" : null
  },
  {
    "name" : "pageletEntryPointRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.capi.auditing.refs.objects.AuditPageletEntryPointRef",
      "pageletEntryPointType" : "page",
      "pageletEntryPointDefinitionQualifiedName" : "auditing.pagelet2-pageEntryPoint",
      "id" : "pageletEntryPoint_32",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "1372150136526"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "position",
    "newValue" : 0.0,
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.entrypoint.assignment.PageletPageletEntryPointAssignmentPO.pageletEntryPointType.pageletEntryPointID.pageletEntryPointDefinitionQualifiedName.pageletType.pageletID.pageletDefinitionQualifiedName.position=Created {0} "{1}" parent {3} "{2}" assignment (page ID="{5}", priority="{6}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.entrypoint.assignment.PageletPageletEntryPointAssignmentPO.pageletEntryPointType.pageletEntryPointID.pageletEntryPointDefinitionQualifiedName.pageletType.pageletID.pageletDefinitionQualifiedName.position
"descriptionParameters":
[
  "page",
  "pageletEntryPoint_32",
  "auditing.pagelet2-pageEntryPoint",
  "component",
  "auditing.pagelet2-pagelet_30",
  "auditing.pagelet2-pagelet",
  0.0
]

PageletPlaceholderAssignmentAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of PageletPlaceholderAssignmentPO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
domainRef	AuditDomainRef	the assignment domain
onlineFlag	Boolean	flag indicating wether the assignment is online
pageletRef	AuditPageletRef	the referenced pagelet
position	Double	the order of the assignment
targetPlaceholderRef	AuditPlaceholderRef	the target placeholder
validFrom	Date	start of the online period
validTo	Date	end of the online period

The following snippet shows an example of the attribute changes in JSON format in the payload:

"attributeChanges":
[
  {
    "name" : "validFrom",
    "newValue" :
    [
      "java.util.Date",
      "2013-06-25T08:49:47.543+0000"
    ],
    "oldValue" : null
  },
  {
    "name" : "targetPlaceholderRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.auditing.internal.pagelet.ref.objects.AuditPlaceholderRef",
      "templateRef" : {
        "@class" : "com.intershop.component.pmc.auditing.capi.pagelet.ref.objects.AuditPageletRef",
        "pageletID" : "auditing.pagelet2-pagelet_33",
        "pageletType" : "component template",
        "pageletDefinitionQualifiedName" : "auditing.pagelet2-pagelet",
        "domainRef" : {
          "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
          "domainName" : "TestOrganization1372150186904-Repository"
        }
      },
      "placeholderDefinitionRef" : {
        "@class" : "com.intershop.component.pmc.auditing.internal.pagelet.ref.objects.AuditPlaceholderDefinitionRef",
        "definitionQualifiedName" : "auditing.pagelet2-slot",
        "templateRef" : {
          "@class" : "com.intershop.component.pmc.auditing.capi.pagelet.ref.objects.AuditPageletRef",
          "pageletID" : "auditing.pagelet2-pagelet_33",
          "pageletType" : "component template",
          "pageletDefinitionQualifiedName" : "auditing.pagelet2-pagelet",
          "domainRef" : {
            "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
            "domainName" : "TestOrganization1372150186904-Repository"
          }
        },
        "id" : "placeholder_0",
        "domainRef" : {
          "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
          "domainName" : "1372150136529"
        }
      },
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "1372150136529"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "onlineFlag",
    "newValue" : true,
    "oldValue" : null
  },
  {
    "name" : "position",
    "newValue" : 1.0,
    "oldValue" : null
  },
  {
    "name" : "domainRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
      "domainName" : "1372150136529"
    },
    "oldValue" : null
  },
  {
    "name" : "pageletRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.auditing.capi.pagelet.ref.objects.AuditPageletRef",
      "pageletID" : "auditing.pagelet2-pagelet_34",
      "pageletType" : "component template",
      "pageletDefinitionQualifiedName" : "auditing.pagelet2-pagelet",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "TestOrganization1372150186904-Repository"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "validTo",
    "newValue" :
    [
      "java.util.Date",
      "2013-06-26T08:49:47.543+0000"
    ],
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.template.assignment.PageletPlaceholderAssignmentPO.pageletType.pageletID.pageletDefinitionQualifiedName.targettemplatePageletType.targettemplatePageletID.targettemplatePageletDefinitionQualifiedName.targetplaceholderdefinitionPageletType.targetplaceholderdefinitionPageletID.targetplaceholderdefinitionPageletDefinitionQualifiedName.targetplaceholderdefinitionDefinitionQualifiedName.targetplaceholderdefinitionId=Created {0} "{1}" (template="{3}") assignment to {6} placeholder "{7}" (definition={9}) of {3} "{4}" (template="{5}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.template.assignment.PageletPlaceholderAssignmentPO.pageletType.pageletID.pageletDefinitionQualifiedName.targettemplatePageletType.targettemplatePageletID.targettemplatePageletDefinitionQualifiedName.targetplaceholderdefinitionPageletType.targetplaceholderdefinitionPageletID.targetplaceholderdefinitionPageletDefinitionQualifiedName.targetplaceholderdefinitionDefinitionQualifiedName.targetplaceholderdefinitionId
"descriptionParameters":
[
  "component template",
  "auditing.pagelet2-pagelet_34",
  "auditing.pagelet2-pagelet",
  "component template",
  "auditing.pagelet2-pagelet_33",
  "auditing.pagelet2-pagelet",
  "component template",
  "auditing.pagelet2-pagelet_33",
  "auditing.pagelet2-pagelet",
  "auditing.pagelet2-slot",
  "placeholder_0"
]

PageletPlaceholderAssignmentPlaceholderAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of PageletPlaceholderAssignmentPlaceholderPO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
domainRef	AuditDomainRef	the placeholder domain
placeTargetContentOnTopFlag	Boolean	flag indicating wether the target content should be placed on top
targetPlaceholderDefinitionRef	AuditPlaceholderDefinitionRef	the placeholder definition reference
templateRef	AuditPageletRef	the pagelet reference
hideTargetContentFlag	Boolean	flag indicating wether the target content should be hidden

The following snipped of the payload shows an example of creating a audited object in JSON format:

"attributeChanges":
[
  {
    "name" : "templateRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.auditing.capi.pagelet.ref.objects.AuditPageletRef",
      "pageletID" : "auditing.pagelet2-pagelet_40",
      "pageletType" : "component template",
      "pageletDefinitionQualifiedName" : "auditing.pagelet2-pagelet",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "TestOrganization1372150189409-Repository"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "domainRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
      "domainName" : "1372150136532"
    },
    "oldValue" : null
  },
  {
    "name" : "targetPlaceholderDefinitionRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.auditing.internal.pagelet.ref.objects.AuditPlaceholderDefinitionRef",
      "definitionQualifiedName" : "auditing.pagelet2-slot",
      "templateRef" : {
        "@class" : "com.intershop.component.pmc.auditing.capi.pagelet.ref.objects.AuditPageletRef",
        "pageletID" : "auditing.pagelet2-pagelet_39",
        "pageletType" : "component template",
        "pageletDefinitionQualifiedName" : "auditing.pagelet2-pagelet",
        "domainRef" : {
          "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
          "domainName" : "TestOrganization1372150189409-Repository"
        }
      },
      "id" : "placeholder_3",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "1372150136532"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "placeTargetContentOnTopFlag",
    "newValue" : false,
    "oldValue" : null
  },
  {
    "name" : "hideTargetContentFlag",
    "newValue" : false,
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.template.PageletPlaceholderAssignmentPlaceholderPO.pageletType.pageletID.pageletDefinitionQualifiedName.targetPageletType.targetPageletID.targetPageletDefinitionQualifiedName.targetDefinitionQualifiedName.targetId==Created Placeholder "{7}" defined by {3} "{4}" (template="{6}") for {0} "{1}" (template="{2}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.template.PageletPlaceholderAssignmentPlaceholderPO.pageletType.pageletID.pageletDefinitionQualifiedName.targetPageletType.targetPageletID.targetPageletDefinitionQualifiedName.targetDefinitionQualifiedName.targetId
"descriptionParameters":
[
  "component template",
  "auditing.pagelet2-pagelet_40",
  "auditing.pagelet2-pagelet",
  "component template",
  "auditing.pagelet2-pagelet_39",
  "auditing.pagelet2-pagelet",
  "auditing.pagelet2-slot",
  "placeholder_3"
]

PageletUserGroupAssignmentAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of PageletUserGroupAssignmentPO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
consumerGroupRef	AuditConsumerGroupRef	the referenced consumer group
domainRef	AuditDomainRef	the assignment domain
pageletRef	AuditPageletRef	the referenced pagelet

The following snippet shows an example of the attribute changes in JSON format in the payload:

"attributeChanges":
[
  {
    "name" : "domainRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
      "domainName" : "1372150136534"
    },
    "oldValue" : null
  },
  {
    "name" : "pageletRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.auditing.capi.pagelet.ref.objects.AuditPageletRef",
      "pageletID" : "auditing.pagelet2-pagelet_43",
      "pageletType" : "component",
      "pageletDefinitionQualifiedName" : "auditing.pagelet2-pagelet",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "TestOrganization1372150190552-Repository"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "consumerGroupRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.usergroup.auditing.refs.AuditConsumerGroupRef",
      "name" : "Display Name",
      "id" : "testUserGroup",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "1372150136534"
      }
    },
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.PageletUserGroupAssignmentPO.pageletType.pageletID.pageletDefinitionQualifiedName.consumerGroupID.consumerGroupName=Created assignment from {0} "{1}" (template="{2}") to consumer group "{3}" (id="{4}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.PageletUserGroupAssignmentPO.pageletType.pageletID.pageletDefinitionQualifiedName.consumerGroupID.consumerGroupName
"descriptionParameters":
[
  "component",
  "auditing.pagelet2-pagelet_43",
  "auditing.pagelet2-pagelet",
  "testUserGroup",
  "Display Name"
]

ParentPageletPlaceholderAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of ParentPageletPlaceholderPO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
domainRef	AuditDomainRef	the pagelet assigned to the A/B test group
hideTargetContentFlag	Boolean	flag indicating wether to hide target content
placeholderTargetContetOnTopFlag	Boolean	flag indicating wether to place the placeholder content on top
targetPlaceholderDefinitionRef	AuditPlaceholderDefinitionRef	the assigned pagelet
templateRef	AuditPageletRef	the template pagelet

The following snippet shows an example of the attribute changes in JSON format in the payload:

"attributeChanges":
[
  {
    "name" : "domainRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
      "domainName" : "1372150136538"
    },
    "oldValue" : null
  },
  {
    "name" : "templateRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.auditing.capi.pagelet.ref.objects.AuditPageletRef",
      "pageletID" : "auditing.pagelet2-pagelet_50",
      "pageletType" : "component",
      "pageletDefinitionQualifiedName" : "auditing.pagelet2-pagelet",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "TestOrganization1372150192659-Repository"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "targetPlaceholderDefinitionRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.auditing.internal.pagelet.ref.objects.AuditPlaceholderDefinitionRef",
      "definitionQualifiedName" : "auditing.pagelet2-slot",
      "templateRef" : {
        "@class" : "com.intershop.component.pmc.auditing.capi.pagelet.ref.objects.AuditPageletRef",
        "pageletID" : "auditing.pagelet2-pagelet_49",
        "pageletType" : "component template",
        "pageletDefinitionQualifiedName" : "auditing.pagelet2-pagelet",
        "domainRef" : {
          "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
          "domainName" : "TestOrganization1372150192659-Repository"
        }
      },
      "id" : "placeholder_7",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "1372150136538"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "placeTargetContentOnTopFlag",
    "newValue" : false,
    "oldValue" : null
  },
  {
    "name" : "hideTargetContentFlag",
    "newValue" : false,
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.template.ParentPageletPlaceholderPO.pageletType.pageletID.pageletDefinitionQualifiedName.targetPageletType.targetPageletID.targetPageletDefinitionQualifiedName.targetDefinitionQualifiedName.targetId=Created Placeholder "{7}" of {0} "{1}" (template="{2}") defined by {3} "{4}" (template="{5}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.template.ParentPageletPlaceholderPO.pageletType.pageletID.pageletDefinitionQualifiedName.targetPageletType.targetPageletID.targetPageletDefinitionQualifiedName.targetDefinitionQualifiedName.targetId
"descriptionParameters":
[
  "component",
  "auditing.pagelet2-pagelet_50",
  "auditing.pagelet2-pagelet",
  "component template",
  "auditing.pagelet2-pagelet_49",
  "auditing.pagelet2-pagelet",
  "auditing.pagelet2-slot",
  "placeholder_7"
]

PlaceholderDefinitionAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of PlaceholderDefinitionPO and PlaceholderDefinitionPOAttributeValuePO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
definitionQualifiedName	String	the placeholder definition qualified name
domainRef	AuditDomainRef	the domain
id	String	the placeholder id
position	Double	defines the position inside the placeholder
templateRef	AuditPageletRef	the template pagelet

The following snipped of the payload shows an example of creating a audited object in JSON format:

"attributeChanges":
[
  {
    "name" : "templateRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.auditing.capi.pagelet.ref.objects.AuditPageletRef",
      "pageletID" : "auditing.pagelet2-pagelet_53",
      "pageletType" : "component template",
      "pageletDefinitionQualifiedName" : "auditing.pagelet2-pagelet",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "TestOrganization1372150194641-Repository"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "definitionQualifiedName",
    "newValue" : "auditing.pagelet2-slot",
    "oldValue" : null
  },
  {
    "name" : "position",
    "newValue" : 1.0,
    "oldValue" : null
  },
  {
    "name" : "domainRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
      "domainName" : "1372150136541"
    },
    "oldValue" : null
  },
  {
    "name" : "id",
    "newValue" : "placeholder_10",
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.template.PlaceholderDefinitionPO.pageletType.pageletID.pageletDefinitionQualifiedName.definitionQualifiedName.id=Created placeholder definition "{4}" for slot "{3}" of {0} "{1}" (template="{2}").
auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.template.PlaceholderDefinitionPOAttributeValuePO.pageletType.pageletID.pageletDefinitionQualifiedName.definitionQualifiedName.id.avName.avLocaleID=Created attribute {4} of placeholder {0} "{1}" (template="{3}", ID="{2}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.template.PlaceholderDefinitionPO.pageletType.pageletID.pageletDefinitionQualifiedName.definitionQualifiedName.id
"descriptionParameters":
[
  "component template",
  "auditing.pagelet2-pagelet_53",
  "auditing.pagelet2-pagelet",
  "auditing.pagelet2-slot",
  "placeholder_10"
]

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.template.PlaceholderDefinitionPOAttributeValuePO.pageletType.pageletID.pageletDefinitionQualifiedName.definitionQualifiedName.id.avName.avLocaleID
"descriptionParameters":
[
  "component template",
  "auditing.pagelet2-pagelet_53",
  "auditing.pagelet2-pagelet",
  "auditing.pagelet2-slot",
  "placeholder_10",
  "displayName",
  "en_US"
]

PageletEntryPointAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of PageletEntryPointPO and PageletEntryPointPOAttributeValuePO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
definitionQualifiedName	String	the entry point definition qualified name
domainRef	AuditDomainRef	the entry point domain
dynamicFlag	Boolean	flag indicating wether the entry point is dynamic
id	String	the entry point ID
pageFlag	Boolean	flag indicating wether the entry point is a page
readOnlyFlag	Boolean	flag indicating wether the entry point is read-only
sortingFlag	Boolean	flag indicating wether the entry is sortable

The following snipped of the payload shows an example of creating a PageletEntryPoint in JSON format:

"attributeChanges": 
[
  {
    "name" : "sortingFlag",
    "newValue" : false,
    "oldValue" : null
  },
  {
    "name" : "id",
    "newValue" : "pageletEntryPoint_11",
    "oldValue" : null
  },
  {
    "name" : "readOnlyFlag",
    "newValue" : false,
    "oldValue" : null
  },
  {
    "name" : "domainRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
      "domainName" : "1371475644516"
    },
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.PageletEntryPointPO.pageletEntryPointType.pageletEntryPointID.pageletEntryPointDefinitionQualifiedName=Created {0} "{1}" (template="{2}").

auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.PageletEntryPointPOAttributeValuePO.pageletEntryPointType.pageletEntryPointID.pageletEntryPointDefinitionQualifiedName.avName.avLocaleID=Created attribute "{3}" of {0} "{1}" (template="{2}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.PageletEntryPointPO.pageletEntryPointType.pageletEntryPointID.pageletEntryPointDefinitionQualifiedName

"descriptionParameters":
[
  "include",
  "pageletEntryPoint_1",
  "auditing.pagelet2-include"
]

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.PageletEntryPointPOAttributeValuePO.pageletEntryPointType.pageletEntryPointID.pageletEntryPointDefinitionQualifiedName.avName.avLocaleID

"descriptionParameters":
[
  "page",
  "pageletEntryPoint_0",
  "auditing.pagelet2-pageEntryPoint",
  "displayName",
  "en_US"
]

PageletEntryPointCategoryAssignmentAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of PageletEntryPointCategoryAssignmentPO, which happens when assigning content to a category in the back office.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
categoryRef	AuditCatalogCategoryRef	the category
domainRef	AuditDomainRef	the pagelet entry point domain
pageletEntryPointRef	AuditPageletEntryPointRef	the pagelet entry point the category is assigned to
position	Double	the assignment position (priority)
viewContextRef	AuditViewContextRef	the view context the category is assigned to

The following snippet shows an example of an attribute change in JSON format in the payload when updating a configuration parameter:

"attributeChanges":
[
  {
    "name" : "domainRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
      "domainName" : "1372150136504"
    },
    "oldValue" : null
  },
  {
    "name" : "pageletEntryPointRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.capi.auditing.refs.objects.AuditPageletEntryPointRef",
      "pageletEntryPointType" : "page",
      "pageletEntryPointDefinitionQualifiedName" : "auditing.pagelet2-pageEntryPoint",
      "id" : "pageletEntryPoint_13",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "1372150136504"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "categoryRef",
    "newValue" : {
      "@class" : "com.intershop.beehive.xcs.capi.auditing.refs.AuditCatalogCategoryRef",
      "name" : "Test Category",
      "id" : "testcategory",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "1372150136504"
      }
    },
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.mvc.internal.assignments.PageletEntryPointCategoryAssignmentPO.pageletEntryPointType.pageletEntryPointID.pageletEntryPointDefinitionQualifiedName.categoryID.categoryName=Created assignment from category "{4}" (id="{3}") to {0} "{1}" (definition="{2}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.mvc.internal.assignments.PageletEntryPointCategoryAssignmentPO.pageletEntryPointType.pageletEntryPointID.pageletEntryPointDefinitionQualifiedName.categoryID.categoryName
"descriptionParameters":
[
  "page",
  "pageletEntryPoint_13",
  "auditing.pagelet2-pageEntryPoint",
  "testcategory",
  "Test Category"
]

PageletEntryPointParentAssignmentAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of PageletEntryPointParentAssignmentPO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
domainRef	AuditDomainRef	the pagelet entry point domain
pageletEntryPointRef	AuditPageletEntryPointRef	the pagelet entry point the parent is assigned to
parentPageletEntryPointRef	AuditPageletEntryPointRef	the parent assigned to the entry point
position	Double	the assignment position (priority)

The following snippet shows an example of an attribute change in JSON format in the payload when updating a configuration parameter:

"attributeChanges":
[
  {
    "name" : "domainRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
      "domainName" : "1372150136511"
    },
    "oldValue" : null
  },
  {
    "name" : "pageletEntryPointRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.capi.auditing.refs.objects.AuditPageletEntryPointRef",
      "pageletEntryPointType" : "page",
      "pageletEntryPointDefinitionQualifiedName" : "auditing.pagelet2-pageEntryPoint",
      "id" : "pageletEntryPoint_24",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "1372150136511"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "position",
    "newValue" : 0.0,
    "oldValue" : null
  },
  {
    "name" : "parentPageletEntryPointRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.capi.auditing.refs.objects.AuditPageletEntryPointRef",
      "pageletEntryPointType" : "page",
      "pageletEntryPointDefinitionQualifiedName" : "auditing.pagelet2-pageEntryPoint",
      "id" : "pageletEntryPoint_23",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "1372150136511"
      }
    },
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.entrypoint.assignment.PageletEntryPointParentAssignmentPO.childPageletEntryPointType.childPageletEntryPointID.childPageletEntryPointDefinitionQualifiedName.parentPageletEntryPointType.parentPageletEntryPointID.parentPageletEntryPointDefinitionQualifiedName.position=Created {0} "{1}" to {3} "{4}" parent assignment (child template="{2}", parent template="{5}", priority="{6}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.entrypoint.assignment.PageletEntryPointParentAssignmentPO.childPageletEntryPointType.childPageletEntryPointID.childPageletEntryPointDefinitionQualifiedName.parentPageletEntryPointType.parentPageletEntryPointID.parentPageletEntryPointDefinitionQualifiedName.position
"descriptionParameters":
[
  "page",
  "pageletEntryPoint_24",
  "auditing.pagelet2-pageEntryPoint",
  "page",
  "pageletEntryPoint_23",
  "auditing.pagelet2-pageEntryPoint",
  0.0
]

PageletEntryPointLabelAssignmentAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of PageletEntryPointLabelAssignmtPO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
domainRef	AuditDomainRef	the pagelet assigned to the A/B test group
labelRef	AuditLabelRef	the label assigned to the entry point
pageletEntryPointRef	AuditPageletEntryPointRef	the pagelet entry point the label is assigned to

The following snippet shows an example of the attribute changes in JSON format in the payload when creating a label to pagelet entry point assignment:

"attributeChanges":
[
  {
    "name" : "labelRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditLabelRef",
      "name" : null,
      "id" : "testlabel",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "1372150136509"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "domainRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
      "domainName" : "1372150136509"
    },
    "oldValue" : null
  },
  {
    "name" : "pageletEntryPointRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.capi.auditing.refs.objects.AuditPageletEntryPointRef",
      "pageletEntryPointType" : "include",
      "pageletEntryPointDefinitionQualifiedName" : "auditing.pagelet2-include",
      "id" : "pageletEntryPoint_18",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "1372150136509"
      }
    },
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.PageletEntryPointLabelAssignmtPO.pageletEntryPointType.pageletEntryPointID.pageletEntryPointDefinitionQualifiedName.labelID.labelName=Created assignment of {0} "{1}" (template="{2}") to label "{4}" (ID="{3}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.PageletEntryPointLabelAssignmtPO.pageletEntryPointType.pageletEntryPointID.pageletEntryPointDefinitionQualifiedName.labelID.labelName
"descriptionParameters":
[
  "include",
  "pageletEntryPoint_18",
  "auditing.pagelet2-include",
  "testlabel",
  null
]

PageletEntryPointProductAssignmentMessageProducer

Supported Types

The message producer tracks attribute changes of PageletEntryPointProductAssignmentPO instances.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
currency	String	The price currency
definitionQualifiedName	String	The fully qualified pagelet definition name
domainRef	AuditDomainRef	The assignment domain
pageletEntryPointRef	AuditPageletEntryPointRef	A reference to the assigned pagelet entry point
productRef	AuditProductRef	A reference to the product the pagelet is assigned to
viewContextRef	AuditViewContextRef	A reference to the view context

The following snippet shows an example of attribute changes in JSON format while creating a pagelet entry point assignment:

"attributeChanges":[
  {
	 "name":"viewContextRef",
	 "newValue":{
		"@class":"com.intershop.component.pmc.capi.auditing.refs.AuditViewContextRef",
		"name":"Product Page",
		"id":"viewcontext.page.product.pagelet2-viewContext",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-PrimeTechSpecials"
		}
	 },
	 "oldValue":null
  },
  {
	 "name":"productRef",
	 "newValue":{
		"@class":"com.intershop.beehive.xcs.capi.auditing.refs.AuditProductRef",
		"sku":"1YLEDTVSUP",
		"name":"1-year LED TV Support",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-PrimeTechSpecials"
		}
	 },
	 "oldValue":null
  },
  {
	 "name":"domainRef",
	 "newValue":{
		"@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		"domainName":"PrimeTech-PrimeTechSpecials"
	 },
	 "oldValue":null
  },
  {
	 "name":"definitionQualifiedName",
	 "newValue":"viewcontext.page.product.pagelet2-viewContext-pageProduct",
	 "oldValue":null
  },
  {
	 "name":"pageletEntryPointRef",
	 "newValue":{
		"@class":"com.intershop.component.pmc.capi.auditing.refs.AuditPageletEntryPointRef",
		"name":"Product Page - Product Page - 1-year LED TV Support",
		"id":"viewcontext.page.product.pagelet2-viewContext-pageProduct-1YLEDTVSUP",
		"domainRef":{
		   "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
		   "domainName":"PrimeTech-PrimeTechSpecials"
		}
	 },
	 "oldValue":null
  }
]

Localization Key and Parameters

The following snippet shows an example of the payload when creating a pagelet entry point assignment:

"descriptionKey":"auditing.message.CREATE.com.intershop.component.mvc.internal.assignments.PageletEntryPointProductAssignmentPO.assignment",
"descriptionParameters":[
    "1YLEDTVSUP",
	"viewcontext.page.product.pagelet2-viewContext-pageProduct-1YLEDTVSUP"
]

PageletEntryPointSharingInfoAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of PageletEntryPointSharingInfoPO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
pageletEntryPointRef	AuditPageletEntryPointRef	the shared pagelet entry point
readOnlyFlag	Booelan	flag which indicates if it is only readable
targetDomainRef	AuditDomainRef	the domain the component is shared to

The following snippet shows an example of the attribute changes in JSON format in the payload:

"attributeChanges":
[
  {
    "name" : "domainRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
      "domainName" : "TestOrganization1372150179191-Repository"
    },
    "oldValue" : null
  },
  {
    "name" : "readOnlyFlag",
    "newValue" : false,
    "oldValue" : null
  },
  {
    "name" : "pageletEntryPointRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.capi.auditing.refs.objects.AuditPageletEntryPointRef",
      "pageletEntryPointType" : "page",
      "pageletEntryPointDefinitionQualifiedName" : "auditing.pagelet2-pageEntryPoint",
      "id" : "pageletEntryPoint_28",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "1372150136514"
      }
    },
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.sharinginfo.PageletEntryPointSharingInfoPO.pageletEntryPointType.pageletEntryPointID.pageletEntryPointDefinitionQualifiedName.sourceDomain.targetDomain=Shared {0} "{1}" (type="{3}", ID="{2}") from "{5}" into "{6}".

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.sharinginfo.PageletEntryPointSharingInfoPO.pageletEntryPointType.pageletEntryPointID.pageletEntryPointDefinitionQualifiedName.sourceDomain.targetDomain
"descriptionParameters":
[
  "page",
  "pageletEntryPoint_28",
  "auditing.pagelet2-pageEntryPoint",
  "1372150136514",
  "TestOrganization1372150179191-Repository"
]

PageletEntryPointViewContextAssignmentAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of PageletEntryPointViewContextAssignmentPO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
domainRef	AuditDomainRef	the assignment domain
definitionQualifiedName	String	the qualified name of the pagelet
pageletEntryPointRef	AuditPageletEntryPointRef	the pagelet entry point the label is assigned to
viewContextRef	AuditViewContextRef	the view context assigned to the entry point

The following snippet shows an example of the attribute changes in JSON format in the payload when assigning a view context to a pagelet entry point:

"attributeChanges": 
[
  {
    "name" : "viewContextRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.capi.auditing.refs.objects.AuditViewContextRef",
      "definitionQualifiedName" : "auditing.pagelet2-viewContext",
      "viewContextType" : "include",
      "id" : "viewContext_0",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "1371470535860"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "definitionQualifiedName",
    "newValue" : "auditing.pagelet2-pagelet",
    "oldValue" : null
  },
  {
    "name" : "pageletEntryPointRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.capi.auditing.refs.objects.AuditPageletEntryPointRef",
      "pageletEntryPointType" : "page",
      "pageletEntryPointDefinitionQualifiedName" : "auditing.pagelet2-pageEntryPoint",
      "id" : "pageletEntryPoint_30",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "1371470535860"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "domainRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
      "domainName" : "1371470535860"
    },
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.viewcontext.assignment.PageletEntryPointViewContextAssignmentPO.pageletEntryPointType.pageletEntryPointID.pageletEntryPointDefinitionQualifiedName.viewContextID.viewContexType.viewContextDefinitionQualifiedName=Created assignment of {0} "{1}" (template="{2}") to {4} view context "{3}" (template="{5}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.viewcontext.assignment.PageletEntryPointViewContextAssignmentPO.pageletEntryPointType.pageletEntryPointID.pageletEntryPointDefinitionQualifiedName.viewContextID.viewContexType.viewContextDefinitionQualifiedName
"descriptionParameters":
[
  "page",
  "pageletEntryPoint_30",
  "auditing.pagelet2-pageEntryPoint",
  "viewContext_0",
  "include",
  "auditing.pagelet2-viewContext"
]

SlotPageletAssignmentAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of SlotPageletAssignmentPO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
onlineflag	Boolean	flag indicating wether the assignment is online
parentSlotRef	AuditSlotRef	the slot which contains content components
position	Double	the assignment position
subPageletRef	AuditPageletRef	the pagelet which is placed in the slot
validFrom	Date	the start of the online period
validTo	Date	the end of the online period

The following snippet shows an example of the attribute changes in JSON format in the payload when assigning a pagelet into a slot:

"attributeChanges":
[
  {
    "name" : "domainRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
      "domainName" : "1372150136546"
    },
    "oldValue" : null
  },
  {
    "name" : "targetPlaceholderDefinitionRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.auditing.internal.pagelet.ref.objects.AuditPlaceholderDefinitionRef",
      "definitionQualifiedName" : "auditing.pagelet2-slot",
      "templateRef" : {
        "@class" : "com.intershop.component.pmc.auditing.capi.pagelet.ref.objects.AuditPageletRef",
        "pageletID" : "auditing.pagelet2-pagelet_59",
        "pageletType" : "component template",
        "pageletDefinitionQualifiedName" : "auditing.pagelet2-pagelet",
        "domainRef" : {
          "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
          "domainName" : "TestOrganization1372150196919-Repository"
        }
      },
      "id" : "placeholder_11",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "1372150136546"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "templateRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.auditing.capi.pagelet.ref.objects.AuditPageletRef",
      "pageletID" : "auditing.pagelet2-pagelet_59",
      "pageletType" : "component template",
      "pageletDefinitionQualifiedName" : "auditing.pagelet2-pagelet",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "TestOrganization1372150196919-Repository"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "placeTargetContentOnTopFlag",
    "newValue" : false,
    "oldValue" : null
  },
  {
    "name" : "hideTargetContentFlag",
    "newValue" : false,
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.template.SlotPageletAssignmentPlaceholderPO.pageletType.pageletID.pageletDefinitionQualifiedName.targetPageletType.targetPageletID.targetPageletDefinitionQualifiedName.targetDefinitionQualifiedName.targetId.slotDefinitionQualifiedName=Created placeholder "{8}" {0} assignment "{1}" (template="{2}") for slot "{6}" of {3} "{4}" (template="{5}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.template.SlotPageletAssignmentPlaceholderPO.pageletType.pageletID.pageletDefinitionQualifiedName.targetPageletType.targetPageletID.targetPageletDefinitionQualifiedName.targetDefinitionQualifiedName.targetId.slotDefinitionQualifiedName
"descriptionParameters":
[
  "component template",
  "auditing.pagelet2-pagelet_59",
  "auditing.pagelet2-pagelet",
  "component template",
  "auditing.pagelet2-pagelet_59",
  "auditing.pagelet2-pagelet",
  "auditing.pagelet2-slot",
  "placeholder_11",
  "auditing.pagelet2-slot"
]

SlotAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of SlotPO and SlotPOAttributeValuePO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
domainRef	AuditDomainRef	the domain
hideableFlag	Booelan	flag which indicates if its visible or not
optionalFlag	Booelan	flag which indicates if its optional
parentPageletRef	AuditPageletRef	the pagelet which is assigned to the slot
readOnlyFlag	Booelan	flag which indicates if its only readable
sortingFlag	Booelan	flag which indicates, if it can be sorted

The following snippet shows an example of the attribute changes in JSON format in the payload:

"attributeChanges":
[
  {
    "name" : "sortingFlag",
    "newValue" : false,
    "oldValue" : null
  },
  {
    "name" : "parentPageletRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.auditing.capi.pagelet.ref.objects.AuditPageletRef",
      "pageletID" : "auditing.pagelet2-pagelet_54",
      "pageletType" : "component template",
      "pageletDefinitionQualifiedName" : "auditing.pagelet2-pagelet",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "TestOrganization1372150195055-Repository"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "readOnlyFlag",
    "newValue" : false,
    "oldValue" : null
  },
  {
    "name" : "domainRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
      "domainName" : "TestOrganization1372150195055-Repository"
    },
    "oldValue" : null
  },
  {
    "name" : "optionalFlag",
    "newValue" : false,
    "oldValue" : null
  },
  {
    "name" : "hideableFlag",
    "newValue" : false,
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.SlotPO.pageletType.pageletID.pageletDefinitionQualifiedName.slotQualifiedName=Created slot "{3}" of {0} "{1}" (template="{2}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.SlotPO.pageletType.pageletID.pageletDefinitionQualifiedName.slotQualifiedName
"descriptionParameters":
[
  "component template",
  "auditing.pagelet2-pagelet_54",
  "auditing.pagelet2-pagelet",
  "auditing.pagelet2-slot"
]

SlotPageletAssignmentPlaceholderAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of SlotPageletAssignmentPlaceholderPO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
hideTargetContentFlag	Booelan	flag indicating wether to hide the target content
placeTargetContentOnTop	Booelan	flag indicating wether to place the target content on top
targetPlaceholderDefinitionRef	AuditSlotRef	the slot which contains content components
templateRef	AuditPageletRef	the pagelet which is placed in the slot

The following snipped of the payload shows an example of creating a audited object in JSON format:

"attributeChanges":
[
  {
    "name" : "domainRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
      "domainName" : "1372150136546"
    },
    "oldValue" : null
  },
  {
    "name" : "targetPlaceholderDefinitionRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.auditing.internal.pagelet.ref.objects.AuditPlaceholderDefinitionRef",
      "definitionQualifiedName" : "auditing.pagelet2-slot",
      "templateRef" : {
        "@class" : "com.intershop.component.pmc.auditing.capi.pagelet.ref.objects.AuditPageletRef",
        "pageletID" : "auditing.pagelet2-pagelet_59",
        "pageletType" : "component template",
        "pageletDefinitionQualifiedName" : "auditing.pagelet2-pagelet",
        "domainRef" : {
          "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
          "domainName" : "TestOrganization1372150196919-Repository"
        }
      },
      "id" : "placeholder_11",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "1372150136546"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "templateRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.auditing.capi.pagelet.ref.objects.AuditPageletRef",
      "pageletID" : "auditing.pagelet2-pagelet_59",
      "pageletType" : "component template",
      "pageletDefinitionQualifiedName" : "auditing.pagelet2-pagelet",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "TestOrganization1372150196919-Repository"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "placeTargetContentOnTopFlag",
    "newValue" : false,
    "oldValue" : null
  },
  {
    "name" : "hideTargetContentFlag",
    "newValue" : false,
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.template.SlotPageletAssignmentPlaceholderPO.pageletType.pageletID.pageletDefinitionQualifiedName.targetPageletType.targetPageletID.targetPageletDefinitionQualifiedName.targetDefinitionQualifiedName.targetId.slotDefinitionQualifiedName=Created placeholder "{8}" {0} assignment "{1}" (template="{2}") for slot "{6}" of {3} "{4}" (template="{5}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.template.SlotPageletAssignmentPlaceholderPO.pageletType.pageletID.pageletDefinitionQualifiedName.targetPageletType.targetPageletID.targetPageletDefinitionQualifiedName.targetDefinitionQualifiedName.targetId.slotDefinitionQualifiedName
"descriptionParameters":
[
  "component template",
  "auditing.pagelet2-pagelet_59",
  "auditing.pagelet2-pagelet",
  "component template",
  "auditing.pagelet2-pagelet_59",
  "auditing.pagelet2-pagelet",
  "auditing.pagelet2-slot",
  "placeholder_11",
  "auditing.pagelet2-slot"
]

SlotSharingInfoAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of SlotSharingInfoPO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
hideableFlag	Booelan	flag which indicates if its visible or not
readOnlyFlag	Booelan	flag which indicates if its only readable
slotID	String	the qualified name of the slot
slotOwningPageletRef	AuditPageletRef	the pagelet which spans the slot
targetDomainRef	AuditDomainRef	the domain, the component is shared to

The following snippet shows an example of the attribute changes in JSON format in the payload:

"attributeChanges":
[
  {
    "name" : "domainRef",
    "newValue" : {
      "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
      "domainName" : "1372150136549"
    },
    "oldValue" : null
  },
  {
    "name" : "readOnlyFlag",
    "newValue" : false,
    "oldValue" : null
  },
  {
    "name" : "slotOwningPageletRef",
    "newValue" : {
      "@class" : "com.intershop.component.pmc.auditing.capi.pagelet.ref.objects.AuditPageletRef",
      "pageletID" : "auditing.pagelet2-pagelet_64",
      "pageletType" : "component template",
      "pageletDefinitionQualifiedName" : "auditing.pagelet2-pagelet",
      "domainRef" : {
        "@class" : "com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
        "domainName" : "TestOrganization1372150198589-Repository"
      }
    },
    "oldValue" : null
  },
  {
    "name" : "slotID",
    "newValue" : "auditing.pagelet2-slot",
    "oldValue" : null
  },
  {
    "name" : "hiddenFlag",
    "newValue" : false,
    "oldValue" : null
  }
]

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.SlotSharingInfoPO.pageletType.pageletID.pageletDefinitionQualifiedName.sourceDomain.targetDomain=Shared {0} "{1}" (template="{2}") from "{3}" into "{4}".

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.pagelet.SlotSharingInfoPO.pageletType.pageletID.pageletDefinitionQualifiedName.sourceDomain.targetDomain
"descriptionParameters":
[
  "component template",
  "auditing.pagelet2-pagelet_64",
  "auditing.pagelet2-pagelet",
  "TestOrganization1372150198589-Repository",
  "1372150136549"
]

ViewContextAuditMessageProducer

Supported Types

The message producer tracks attribute changes on instances of ViewContextPO and ViewContextPOAttributeValuePO.

Attribute Changes

The following attributes will be audited:

Attribute	Datatype	Description
definitionqualifiedname	String	the qualified name
domainid	String	the domain, the view context exists
id	String	the view context id
pageflag	Boolean	true, if it is a page, otherwise it is an include
systemmanagedflag	Boolean	true, if it is system managed, or user maintained by a back office manager

The following snippet shows an example of an attribute change in JSON format in the payload when creating a view context instance:

"attributeChanges":[

    {
        "name":"definitionQualifiedName",
        "newValue":"viewcontext.page.category.pagelet2-viewContext",
        "oldValue":null
    },
    {
        "name":"domainRef",
        "newValue":{
            "@class":"com.intershop.component.auditing.capi.ref.objects.AuditDomainRef",
            "domainName":"PrimeTech-PrimeTechSpecials"
        },
        "oldValue":null
    },
    {
        "name":"systemManagedFlag",
        "newValue":false,
        "oldValue":null
    },
    {
        "name":"pageFlag",
        "newValue":true,
        "oldValue":null
    },
    {
        "name":"id",
        "newValue":"AViewContext",
        "oldValue":null
    }

],

Localization Key and Parameters

The localization message can be found by the descriptionKey in auditing_en.properties and auditing_de.properties.

auditing_en.properties

auditing.message.CREATE.com.intershop.component.pmc.internal.viewcontext.ViewContextPO.viewContextID.viewContexType.viewContextDefinitionQualifiedName=Created {1} view context "{0}" (template="{2}").
auditing.message.CREATE.com.intershop.component.pmc.internal.viewcontext.ViewContextPOAttributeValuePO.viewContextID.viewContexType.viewContextDefinitionQualifiedName.avName.avLocaleID=Created attribute "{3}" (locale="{4}") of {1} view context "{0}" (template="{2}").

The localization framework replaces all placeholders by the values stored in the payload.

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.viewcontext.ViewContextPOAttributeValuePO.viewContextID.viewContexType.viewContextDefinitionQualifiedName.avName.avLocaleID
"descriptionParameters": 
[
  "viewContext_0",
  "include",
  "auditing.pagelet2-viewContext",
  "description",
  "en_US"
]

"descriptionKey": auditing.message.CREATE.com.intershop.component.pmc.internal.viewcontext.ViewContextPO.viewContextID.viewContexType.viewContextDefinitionQualifiedName
"descriptionParameters": 
[
  "viewContext_0",
  "include",
  "auditing.pagelet2-viewContext"
]

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Table of Contents

Auditing Jobs

JobConfigurationAuditMessageProducer

Attribute Changes

Payload sample

Auditing PriceLists

PriceListAuditMessageProducer

Attribute Changes

Payload sample

PriceListUserGroupAssignmentAuditMessageProducer

Attribute Changes

Payload sample

PriceScaleEntryAuditMessageProducer

Attribute Changes

Payload sample

PriceScaleTableAuditMessageProducer

Attribute Changes

Payload sample

PriceScaleTableAssignmentAuditMessageProducer

Attribute Changes

Payload sample

Auditing Products

ProductMessageProducer

Supported Types

Attribute Changes

Localization Key and Parameters

DerivedProductMessageProducer

Supported Types

Attribute Changes

Localization Key and Parameters

BundleAssignmentMessageProducer

Supported Types

Attribute Changes

Localization Key and Parameters

DerivedProductCostPriceMessageProducer

Supported Types

Attribute Changes

Localization Key and Parameters

DerivedProductListPriceMessageProducer

Supported Types

Attribute Changes

Localization Key and Parameters

ImageProductAssignmentMessageProducer

Supported Types

Attribute Changes

Localization Key and Parameters

ImageReferenceMessageProducer

Supported Types

Attribute Changes

Localization Key and Parameters

PageletEntryPointProductAssignmentMessageProducer

Supported Types

Attribute Changes

Localization Key and Parameters

ProdcutLinkMessageProducer

Supported Types

Attribute Changes

Localization Key and Parameters

ProductCategoryAssignmentMessageProducer

Supported Types

Attribute Changes

Localization Key and Parameters

ProductCostPriceMessageProducer

Supported Types

Attribute Changes

Localization Key and Parameters

ProductLabelAssignmentMessageProducer

Supported Types

Attribute Changes

Localization Key and Parameters

ProductLinkPositionMessageProducer

Supported Types

Attribute Changes

Localization Key and Parameters

ProductListPriceMessageProducer

Supported Types

Attribute Changes

Localization Key and Parameters

ProductRatingCommentMessageProducer

Supported Types