Wiki source code of PurgeTracking

Last modified by Assala Chmiti on 2022/07/29 16:09

version	line-number	content
1.1	1	{{box cssClass="floatinginfobox" title="Contents"}}
	2	{{toc/}}
	3	{{/box}}
	4
9.1	5	= __Introduction:__ =
1.1	6
10.1	7
7.1	8	"PurgeTracking" is a connector that allows administrators to delete all unused Tracking from the database by specifying some parameters to include in the format file.
1.1	9
7.1	10	The need to use such a connector is to reach the database availability and scalability by allegiance the size of each table relating to the Tracking process knowing that it takes a lot of memory if not resolved.
1.1	11
7.1	12	Our connector's presentation is going to be described in details in 3 parts :
1.2	13
	14	1. Parameters
	15	1*. format
	16	1. Use
	17
7.1	18	[[image:purgetrk.PNG]]
	19
9.1	20	= __Explaining the connector format:__ =
1.1	21
10.1	22
1.2	23	The parameters used in this connector are :
1.1	24
10.1	25	* //iXPurgeTrk//: root node where should be specified 2 attributes :
	26	"Retention**": it refers to the number of days, if passed it should delete all Tracking created before that date.
	27	"stopTime**": attribute showing numbers of minutes to stop PurgeTracking. Passing this time, the connector should stop working and go to the next connector of the current scenario.
1.1	28
10.1	29	* //iXToDelete//: a node where we add all tracking to be deleted in PurgeTracking. To add tracking to be deleted, we should follow these steps :
	30	** Add a node to the iXToDelete node.
	31	** Put the Tracking Type as the node name.
	32	** Specify Tracking Status type ID in the "StatusType" attribute. If it equals "*", it means we want to delete all Tracking regardless of Status. we can also put multiple status by separating them by comma, example : "StatusType" = "1,5,13,56".
	33
	34	* //iXToForbid//: an XML node to put trackings to not delete while executing PurgeTracking. It works similar to iXToDelete.
	35
9.1	36	[[image:purgetrk1.PNG\|\|height="402" width="447"]]
7.1	37
9.1	38	== ==
7.1	39
9.1	40	== __Example Format:__ ==
1.1	41
7.1	42	Below, we find an example showing a format file to delete trackings following some criteria :
1.1	43
10.1	44	* We want to delete all trackings of type 'Order' that its date passed 30 days. The connector will delete automatically all subtrackings of 'Order' selected by a SQL query, __in this case, __we should be careful and mention all trackings forbidden to be deleted__.__ The trackings to not be deleted are:
9.1	45	Tracking 'Order' with StatusType 1 and 12**.
	46	Tracking 'OrderLine' with StatusType 1**.
	47	All Status types for the tracking 'Product_Base**'.
1.1	48
9.1	49	* We set a stopTime of 7 hours. If PurgeTracking started at 1:00PM it should stop at 8:00PM, even if it didn't delete all tracking wanted.
	50
1.3	51	{{code language="XML"}}
	52	<?xml version="1.0" encoding="windows-1250"?>
	53
	54	<iXDoc>
	55	<iXPurgeTrk Retention = "30" stopTime="7">
	56
	57	<iXToDelete>
1.10	58	<Order StatusType="*"></Order>
1.3	59	</iXToDelete>
	60
	61	<iXToForbid>
1.10	62	<Order StatusType="1,12"></Order>
	63	<OrderLine StatusType="1"></OrderLine>
	64	<Product_Base StatusType = "*"></Product_Base>
1.3	65	</iXToForbid>
	66
	67	</iXPurgeTrk>
	68	</iXDoc>
	69
	70	{{/code}}
	71
	72
9.1	73	= __Use:__ =
1.1	74
	75	As explained before, the PurgeTracking connector is used to delete tracking and its subtrackings by writing the format file.
	76
7.1	77	Practically, the delete of tracking that has a certain ID (eg. TrkID = 1234 And TrackingType = 'OrderLine'), will generate all following deletes on this order :
1.1	78
10.1	79
1.11	80	1. Delete Tracking file from 'TrackingFile' table where TrkID=1234
	81	1. Delete Tracking environement from 'TrackingEnv' table where TrkID = 1234
4.1	82	1. Delete all Tracking Links from "TrackingLink' table where TrkID = 1234 or ParentTrkID = 1234
	83	1. Delete Tracking from '_OrderLine' table where TrkID = 1234
1.11	84	1. Finally, delete Tracking from 'Tracking' Table where TrkID =1234
1.1	85
1.12	86	In addition to that, the connector makes the execution in the current environment and its sub-environments. For example, if there is an environnement (EnvID = 1) which has 2 sub-environments ( EnvID = 2 and EnvID = 3), and we start 'PurgeTracking' in EnvID = 1, the connector will be automaticly executed in environments 1,2 and 3.
1.1	87
	88
12.1	89	=== __When the purge is executed?:__ ===
1.11	90
	91
14.1	92	As we can see in the format file, the tracking lines that are deleted are based on their status type. So, to delete the tracking lines, consultants needs only to set the status type of the tracking table lines that they want to delete to '99'. The value 99 is the one that corresponds to the status 'to be purged' in the database.
1.11	93
12.1	94	This step of changing the status type is necessary when a tracking table is no longer needed and the consultants are the ones that knows what are the tracking tables that should be deleted. The deletion will start once the tracking lines have a correct status type(with the value '99') mentionned in the iXToDelete tag in the format file and have a creation date that surpass the retention date from today's date.
9.1	95
12.1	96	This connector should only be executed by the iXPath members.
9.1	97
13.1	98	The retention attribute in the format file for the iXPurgeTrk tag is set to the value 180 (6 months) in the SIM and PROD server.
9.1	99
12.1	100
13.1	101
1.10	102	= =

Wiki source code of PurgeTracking

Navigation

Applications