IBackgroundTaskHandler - CleanupMetrics
Cleans up the Tridion Docs objects from the metrics database.
Input data
- a topic
- an illustration
- a publication
The identifying input data XML for the topic, illustration or publication specifies the following:
- ishobject
-
The input data root element.
- Required: yes
- ishobject @ishref
-
The logical identifier of the object.
- Required: yes
- ishobject @ishtype
-
The object type.
- Required: yes
- Allowed values:
ISHModulefor a topicISHIllustrationfor an illustrationISHPublicationfor a publication
- ishobject @ishlogicalref
-
The unique numeric identifier of the logical level of the object (for example, 24163526).
- Required: yes
- ishobject @ishversionref
-
The unique numeric identifier of the version level of the object (for example, 24163527). Specified when a version of a topic, illustration or publication gets deleted.
- Required: no
- ishobject @ishlngref
-
The unique numeric identifier of the language level of the object (for example, 24163528).
- Required: no
- ishfields
-
A container for object metadata fields. The container contains one or more
ishfieldelements.- Required: yes
- ishfield
-
An object metadata field.
- Required: no
- ishfield @name
-
The name of the
ishfieldelement.- Required: yes
- ishfield @level
-
The level of the
ishfieldelement.- Required: yes
- Allowed values:
logicalversionlng
- ishfield @ishvaluetype
-
The type of the values for the field.
- Allowed values:
valueidelementlabel
- Allowed values:
The identifying topic input data XML specifies the following:
The identifying illustration input data XML specifies the following: The identifying publication input data XML specifies the following:
Input data example
Here are examples for when a logical item has been deleted, and for when an item version has been deleted.
<ishobject ishref="GUID-1AEC2209-9024-4EE3-941E-3D73B91BD16A" ishtype="ISHModule" ishlogicalref="16774477">
<ishfields>
<ishfield name="FTITLE" level="logical" ishvaluetype="value">Topic1</ishfield>
</ishfields>
</ishobject>
<ishobject ishref="GUID-D8805649-AA25-4F98-923E-2CB6E8C5462E" ishtype="ISHPublication" ishlogicalref="16774398" ishversionref="16774399">
<ishfields>
<ishfield name="VERSION" level="version">1</ishfield>
<ishfield name="FTITLE" level="logical" ishvaluetype="value">Publication</ishfield>
<ishfield name="VERSION" level="version" ishvaluetype="value">1</ishfield>
</ishfields>
</ishobject>
Background task configuration
There are no configurable parameters.
Default background task configuration example
The following configuration gets and handles a CLEANUPMETRICS event from the background task queue:<handler eventType="CLEANUPMETRICS">
<scheduler executeSynchronously="false" />
<authorization type="authenticationContext" />
<execution timeout="01:00:00" recoveryGracePeriod="00:10:00" isolationLevel="None" />
<activator>
<net name="CleanupMetrics">
<parameters />
</net>
</activator>
<errorHandler maximumRetries="99">
<actions>
<add errorNumber="-503005" action="Retry" delay="00:10:00" />
</actions>
</errorHandler>
</handler>
Flow
- Retrieves the event data.
- Determines the logical objects that must be processed.
- Sends data to be removed from Metrics storage to the respective endpoint using the Metrics API .