TRKToXML - XWiki

(% aria-label="macro:toc widget" contenteditable="false" role="region" tabindex="-1" %)

(((

(% style="background-image:url(https://ixpath.app/xwiki/webjars/wiki%3Axwiki/application-ckeditor-webjar/1.53.2/plugins/widget/images/handle.png); background:rgba(220,220,220,0.5); display:none" %)[[image:data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==||height="15" role="presentation" title="Click and drag to move" width="15"]]

)))

= Introduction =

In this section, we will go throw TRKToXml connector to get trackings by trkID and tracking type or using keys.

== **__Icon:__** ==

[[image:trkToXml.png]]

20

21

The connector exists in the scenario panel:

22

23

[[image:connectors.png]]

24

25

== **__Configuration:__** ==

26

27

28

**__[[image:configuration.png]]__**

29

30

* //**Name **//: To give a name to the processing step (connector). It is very useful to give meaningful names

31

* **Output FileName** : The name of your output file.

32

* **//Condition //**: This field allows you to add a condition to execute the processing step only if the condition is met.

33

34

== __**Example :**__ ==

35

36

37

__**[[image:scenarioTrackingToXml.png]]**__

38

39

40

You will find in this part an example of an input file with the correct format and an output file.

41

42

=== __input File:__ ===

<iXDoc>

<TrackingType >IXEnvironment</TrackingType>

<Keys>parent</Keys>

<Values>iXPath</Values>

<Order>TrkID</Order>

<Status>Available</Status>

</iXDoc>

1. trackingType: it refers to type of tracking wanted. (eg : order , IXEnvironment, baseArticle ...).**it's mandatory.**

65

1. TrKIDs :it refers to the trkIDs of trackings wanted separated by spaces .

66

1. keys: it can handle 2 values, "trkID" or keys separated by ';' (eg: 'orderNumber;City;Phone') if the key contains '_' at the first character, it means we look for metadata (_statusTracking, _creationDate ...).**In order for the input file to be valid, it must contain either a TrkIDs tag or a keys tag, or both.**

67

1. limit: it defines the max number of tracking to retrieve. **it's optional.**

68

1. order: whether you want to order the list of trackings in a descending way or not by a certain key order. The default value is 'trkID' and it's optional as long as you fill the limit value.

= __output File:__ =

<?xml version="1.0" encoding="UTF-8"?>

<iXDoc>

<alias>iXPath</alias>

<logo/>

</IXEnvironment>

</iXDoc>

The tracking data and metadata are included in the output file.

Wiki source code of TRKToXML

Navigation

Applications

author	version	line-number	content
		1
		2
		3	{{box cssClass="floatinginfobox" title="Contents"}}
		4	(% aria-label="macro:toc widget" contenteditable="false" role="region" tabindex="-1" %)
		5	(((
		6	{{toc/}}
		7
		8	(% style="background-image:url(https://ixpath.app/xwiki/webjars/wiki%3Axwiki/application-ckeditor-webjar/1.53.2/plugins/widget/images/handle.png); background:rgba(220,220,220,0.5); display:none" %)[[image:data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==\|\|height="15" role="presentation" title="Click and drag to move" width="15"]]
		9	)))
		10	{{/box}}
		11
		12	= Introduction =
		13
		14	In this section, we will go throw TRKToXml connector to get trackings by trkID and tracking type or using keys.
		15
		16	== __Icon:__ ==
		17
		18
		19	[[image:trkToXml.png]]
		20
		21	The connector exists in the scenario panel:
		22
		23	[[image:connectors.png]]
		24
		25	== __Configuration:__ ==
		26
		27
		28	__[[image:configuration.png]]__
		29
		30	* //Name //: To give a name to the processing step (connector). It is very useful to give meaningful names
		31	* Output FileName : The name of your output file.
		32	* //Condition //: This field allows you to add a condition to execute the processing step only if the condition is met.
		33
		34	== __Example :__ ==
		35
		36
		37	__[[image:scenarioTrackingToXml.png]]__
		38
		39
		40	You will find in this part an example of an input file with the correct format and an output file.
		41
		42	=== __input File:__ ===
		43
		44	<iXDoc>
		45
		46	<TrackingType >IXEnvironment</TrackingType>
		47
		48	<TrkIDs>62ec9e0928e4773780f37762</TrkIDs>
		49
		50	<Keys>parent</Keys>
		51
		52	<Values>iXPath</Values>
		53
		54	<Limit>1</Limit>
		55
		56	<Order>TrkID</Order>
		57
		58	<Status>Available</Status>
		59
		60	</iXDoc>
		61
		62
		63
		64	1. trackingType: it refers to type of tracking wanted. (eg : order , IXEnvironment, baseArticle ...).it's mandatory.
		65	1. TrKIDs :it refers to the trkIDs of trackings wanted separated by spaces .
		66	1. keys: it can handle 2 values, "trkID" or keys separated by ';' (eg: 'orderNumber;City;Phone') if the key contains '_' at the first character, it means we look for metadata (_statusTracking, _creationDate ...).In order for the input file to be valid, it must contain either a TrkIDs tag or a keys tag, or both.
		67	1. limit: it defines the max number of tracking to retrieve. it's optional.
		68	1. order: whether you want to order the list of trackings in a descending way or not by a certain key order. The default value is 'trkID' and it's optional as long as you fill the limit value.
		69
		70	= __output File:__ =
		71
		72
		73	<?xml version="1.0" encoding="UTF-8"?>
		74
		75	<iXDoc>
		76
		77	<IXEnvironment creationDate="2022-08-05 16:47:08" envID="iXPath" modificationDate="2022-08-05 16:47:08" statusTracking="Available">
		78
		79	<parent/>
		80
		81	<gitRepository/>
		82
		83	<timezone>GMT</timezone>
		84
		85	<alias>iXPath</alias>
		86
		87	<active>true</active>
		88
		89	<logo/>
		90
		91	<id>62ec9e0928e4773780f37762</id>
		92
		93	</IXEnvironment>
		94
		95	</iXDoc>
		96
		97	The tracking data and metadata are included in the output file.