Wiki source code of TRKToXML
Version 6.1 by Outhman Moustaghfir on 2022/12/27 11:32
Show last authors
| 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. | ||
| 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 | You will find in this part an example of an input file with the correct format and the output file. | ||
| 37 | |||
| 38 | === __input File:__ === | ||
| 39 | |||
| 40 | <iXDoc> | ||
| 41 | |||
| 42 | <TrackingType >IXEnvironment</TrackingType> | ||
| 43 | |||
| 44 | <TrkIDs>62ec9e0928e4773780f37762</TrkIDs> | ||
| 45 | |||
| 46 | <Keys>creationDate</Keys> | ||
| 47 | |||
| 48 | <Values>2022-08-05T04:35:21.731+00:00</Values> | ||
| 49 | |||
| 50 | <Limit>1</Limit> | ||
| 51 | |||
| 52 | <Order>TrkID</Order> | ||
| 53 | |||
| 54 | <Status>Available</Status> | ||
| 55 | |||
| 56 | </iXDoc> | ||
| 57 | |||
| 58 | |||
| 59 | 1. trackingType: it refers to type of tracking wanted. (eg : order , IXEnvironment, baseArticle ...) | ||
| 60 | 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 ...) | ||
| 61 | **NB:** all metadata will be explained in detail in another paragraph. | ||
| 62 | 1. values: the values must be ordered the same as 'keys'. if we're searching by 'trkID', 'values' should contain trkIDs separated by space ' '. eg : '121ee 123DD 55evr om432' | ||
| 63 | In the other case where we use values depending on keys, they must be separated by ';' as shown below : | ||
| 64 | if we take the last example in 'keys' param, 'orderNumber;City;Phone' , 'values' will be by example '1243;Paris;06070706053' . | ||
| 65 | 1. limit: it defines the max number of tracking to retrieve. **it's optional.** | ||
| 66 | 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. | ||
| 67 | |||
| 68 | = __output File:__ = | ||
| 69 | |||
| 70 | |||
| 71 | <?xml version="1.0" encoding="UTF-8"?> | ||
| 72 | |||
| 73 | <iXDoc> | ||
| 74 | |||
| 75 | <IXEnvironment creationDate="2022-08-05 16:47:08" envID="iXPath" modificationDate="2022-08-05 16:47:08" statusTracking="Available"> | ||
| 76 | |||
| 77 | <parent/> | ||
| 78 | |||
| 79 | <gitRepository/> | ||
| 80 | |||
| 81 | <timezone>GMT</timezone> | ||
| 82 | |||
| 83 | <alias>iXPath</alias> | ||
| 84 | |||
| 85 | <active>true</active> | ||
| 86 | |||
| 87 | <logo/> | ||
| 88 | |||
| 89 | <id>62ec9e0928e4773780f37762</id> | ||
| 90 | |||
| 91 | </IXEnvironment> | ||
| 92 | |||
| 93 | </iXDoc> | ||
| 94 | |||
| 95 | |||
| 96 | = Paragraph 2 = | ||
| 97 | |||
| 98 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
| 99 | |||
| 100 | == Sub-paragraph == | ||
| 101 | |||
| 102 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
| 103 | |||
| 104 | == Sub-paragraph == | ||
| 105 | |||
| 106 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. |