Wiki source code of XMLToTrk

Last modified by Outhman Moustaghfir on 2022/06/13 13:18

version	line-number	content
2.2	1	= Introduction =
2.1	2
	3	XMLtoTracking connector allows users to create new trackings or update old ones by inserting an XML file.
	4
	5
	6	= Configuration =
	7
2.2	8	=== Tracking ===
	9
2.1	10	The connector requires an input XML file which must contain a parent tag <ixDoc> that includes all other tracking tags.
	11
	12	And here are some attributes that can be defined inside a tracking tag :
	13
	14	\|(% style="width:215px" %)Attribute\|(% style="width:496px" %)Explanation\|(% style="width:278px" %)Example
	15	\|(% style="width:215px" %)//TrkStatusTypeID//\|(% style="width:496px" %)setting the ID of tracking status that would be changed.\|(% style="width:278px" %)TrkStatusTypeID = "12"
	16	\|(% style="width:215px" %)//TrkStatusTypeAlias//\|(% style="width:496px" %)It's another way to declare the tracking status using directly the alias\|(% style="width:278px" %)TrkStatusTypeAlias= ‘Delivred’
	17	\|(% style="width:215px" %)//UpdateAllStatusFrom//\|(% style="width:496px" %)The attribute allows updating the status of all trackings which have a certain status defined with __//TrkStatusTypeID//__// or __TrkStatusTypeAlias.__//\|(% style="width:278px" %)(((
	18	<Order TrkStatusTypeAlias = ‘Closed’ UpdateAllStatusFrom=‘Available’>
	19
2.2	20	~-~-> this will change the value of status from 'Closed' to "Available" in all "Order" trackings.
2.1	21	)))
	22	\|(% style="width:215px" %)//TrkID//\|(% style="width:496px" %)This will update a certain tracking with the TrkID value if it exists. If not, it will be added with this TrkID.\|(% style="width:278px" %)TrkID = 245
	23	\|(% style="width:215px" %)//EnvAlias//\|(% style="width:496px" %)It aims to relate the tracking to the indicated environments, which should be split by ';' inside the attribute.\|(% style="width:278px" %)EnvAlias = ‘Ixpath;loreal’
4.1	24	\|(% style="width:215px" %)Key-Value\|(% style="width:496px" %)(((
5.1	25	These 2 attributes retrieve a certain tracking with pairs of Key-Value split by ';', and update the corresponding tracking without creating a new one with the updated values.
2.1	26
4.1	27	This pair came to replace the old method of GetTrkDataByData.
	28	)))\|(% style="width:278px" %)(((
	29	<Order Key="OrderNumber;BuyerCode" Value="19222;4000">
	30
2.3	31	~-~-> it will retrieve the first 'Order' that contains OrderNumber = 19222 and BuyerCode=4000, and update it.
2.2	32	)))
	33
2.3	34	===== Example of the input XML file : =====
2.2	35
4.2	36	The following example updates a tracking with TrkID=162470 with embedded tags data and the status, and an other one with Key-Value pair (LineNumber=12 and ProdItemNb=3300).
2.2	37
	38	{{code language="XML" layout="LINENUMBERS"}}
	39	<CMO_OrderLine TrkID="162470"
	40	TrkStatusTypeID="0"
	41	TrkTypeID="86">
	42	<SAP_ProductCode>1050634</SAP_ProductCode>
	43	<LabelProduct>FORLAXGO 12STICKS CZ PL</LabelProduct>
	44	<OrderedQuantity>7000</OrderedQuantity>
	45	<DeliveryDate>2019-02-10</DeliveryDate>
4.1	46	<ProductionEndDate></ProductionEndDate>
2.2	47	<LineNumber>10</LineNumber>
	48	<ConfirmedQty>7000</ConfirmedQty>
	49	<ProdItemNb>3</ProdItemNb>
	50	</CMO_OrderLine>
4.1	51	<CMO_OrderLine Key ="LineNumber;ProdItemNb" Value="12;3300"
2.4	52	TrkStatusTypeID="0"
	53	TrkTypeID="86">
	54	<SAP_ProductCode>1670634</SAP_ProductCode>
	55	<LabelProduct>FORLAXGO 12STICKS MA FR</LabelProduct>
	56	<OrderedQuantity>7000</OrderedQuantity>
	57	<DeliveryDate>2019-08-10</DeliveryDate>
4.1	58	<ProductionEndDate></ProductionEndDate>
2.4	59	<LineNumber>10</LineNumber>
	60	<ConfirmedQty>7000</ConfirmedQty>
	61	<ProdItemNb>3</ProdItemNb>
	62	</CMO_OrderLine>
2.2	63	{{/code}}
	64
	65	=== Sub Tracking : ===
	66
4.3	67	"XMLToTrk" allows also creating or updating __sub-trackings__.
2.2	68
2.3	69	an XML tag is recognized as sub-tracking if :
	70
	71	* the tag has an attribute "Type" equal to 'Tracking.
	72
	73	__OR__
	74
	75	* The tag name exists in the tracking type table of the database.
	76
2.4	77	===== Example of the input XML file : =====
2.3	78
2.5	79	The folowing example include 2 sub-trackings of "CMO_ProdLine" inside the "CMO_OrderLine" tracking : first one has a TrkID = 162471 which need to be updated, and the other one is a new sub-tracking to be inserted.
2.3	80
2.4	81	{{code language="XML" layout="LINENUMBERS"}}
	82	<CMO_OrderLine TrkID="162470" TrkStatusTypeID="0">
	83	<SAP_ProductCode>1050634</SAP_ProductCode>
	84	<LabelProduct>FORLAXGO 12STICKS CZ PL</LabelProduct>
	85	<OrderedQuantity>7000</OrderedQuantity>
	86	<DeliveryDate>2019-02-10</DeliveryDate>
	87	<CMO_ProdLine TrkID="162471" TrkStatusTypeID="0">
	88	<ProductionQty>2000</ProductionQty>
	89	<BatchNumber>BL-112273</BatchNumber>
	90	</CMO_ProdLine>
	91	<CMO_ProdLine >
	92	<ProductionQty>3000</ProductionQty>
	93	<BatchNumber>CT-478743</BatchNumber>
	94	</CMO_ProdLine>
	95	</CMO_OrderLine>
	96
	97	{{/code}}
	98
	99
2.6	100	=== File ===
	101
	102	We attach session files to a given tracking by adding a tag named 'FILE' inside the tracking wanted.
	103
	104	There are some attributes that would be filled to satisfy some criteria:
	105
	106
	107	\|(% style="width:276px" %)Attribute\|(% style="width:406px" %)Explanation\|(% style="width:307px" %)Example
	108	\|(% style="width:276px" %)//FileTypeAlias//\|(% style="width:406px" %)The type of files attached to Tracking.\|(% style="width:307px" %)Attachment, log, Work,… (EDI as the default value)
	109	\|(% style="width:276px" %)//FileSensAlias//\|(% style="width:406px" %)File sens \|(% style="width:307px" %)'in' , 'out' ('in' is the default value)
2.8	110	\|(% style="width:276px" %)//Connector//\|(% style="width:406px" %)The name of the connector in the scenario, and that's will include all its files.\|(% style="width:307px" %)Connector = "XMLtoXML1"
2.7	111	\|(% style="width:276px" %)//UserFile//\|(% style="width:406px" %)The path of the attached file to a user(absolute path).\|(% style="width:307px" %)
4.3	112	\|(% style="width:276px" %)//SessionFile//\|(% style="width:406px" %)The path of the attached file to a session (relative path to this session).\|(% style="width:307px" %)sessionFile= ‘in/7300111890.pdf’
2.6	113
2.9	114	===== Example of the input XML file : =====
2.6	115
2.9	116	{{code language="XML" layout="LINENUMBERS"}}
	117	<?xml version="1.0" encoding="UTF-8"?>
	118	<ixDOC xmlns:ixf="http://www.ixPath.com/Function">
	119	<CMO_OrderHeader TrkID="162469">
	120	<File FileSensAlias="out"
	121	FileTypeAlias="Attachment"
4.1	122	SessionFile="in/7300111890.pdf"></File>
2.9	123	</CMO_OrderHeader>
	124	</ixDOC>
	125
	126	{{/code}}
	127
	128	This example will add a session file "in/7300111890.pdf" for the TrkID = 162469 as an 'Attachment' with sens = 'out'.
	129
2.1	130

Wiki source code of XMLToTrk

Navigation

Applications