FileToXML - XWiki

== **__Introduction:__** ==

This connector is used to transform a file. It is a connector allowing to transform a file of another format (CSV, PLAT, - EDIFACT...) to an XML file based using a file called « **format **».

4

== **__Icon:__** ==

[[image:1646134524824-934.png||height="112" width="126"]]

10

11

12

The connector exists in the scenario panel:

[[image:1.png]]

== **__Configuration:__** ==

17

18

19

[[image:1646134567096-508.png]]

- __//Configuration ~://__

24

25

FILE_TO_XML is a transformation connector used to set up the connector, you should click on the blue button above the connector and fill in the properties displayed :

26

27

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

28

* //**Format **//: The XML file allowing to transform the input or output file to XML format or vice versa. We have several existing standard formats (EDIFACT, X12..)

29

* //**FileName **//: To give a name to the output file of the current step. This step is very useful for the monitoring of the platform.

30

* **//Input & Output Charset//** : to precise the encoding for the files. The default encoding is UTF-8.

31

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

32

* //**Add boundary OnError**// : It is checked only to add an additional treatment in the case of an error on the treatment step.

33

34

== __**Le fichier Format:**__ ==

35

36

37

The format file is mandatory for the connector to work. The iXPath file formats are described in XML and stored in the client environment's format directory.

38

39

The XML format represents the actual hierarchical structure of the temporary format file.

40

41

The XML output file will strictly use the tag names and structure defined in the format structure file.

42

43

In this chapter we will go through all the possible cases of the format file.

44

45

1. (((

46

==== __**Format Edifact**__ ====

47

)))

48

49

//__**Introduction:**__//

50

51

The Edifact format allows the user to transform an edifact file to an xml file respecting the standard format. There are so many platforms that validate the structured files.

52

53

XML documents must contain one root element that is the parent of all other elements. This element should exist once in all the document. In general it is a node called "ixDOC".

54

55

56

__//**Elements of the file format:**//__

57

58

Any group of information (even those that are not delimited by characters, a line break or other) must be represented in the document (e.g. groups of EDIFACT segments, Messages, etc.).

59

60

61

**~ Attributes **are considered one of the important elements in the format xml file. They tell the translation processor what actions to take when reading the document. They should be defined globally in the root element or individually on each tag.

62

63

64

All the attributes defined in the root tag will be automatically carried over to all the tags in the format. These are therefore the default attributes. An undefined attribute will take the default value defined in the document.

65

66

Each attribute should be indicated only if it is really useful. Some attributes can slow down the processing.

67

68

69

(% class="table-bordered" %)

70

(% class="active" %)|(% colspan="2" %)(((

71

====== __**List of Processing Attributes:**__ ======

)))

|(((

**format**

//string//

)))|(((

**Default Value : **«** **none »

79

80

**Description : **Defines how the data will be taken from the file

81

82

* **« none » :** Defines a group of information, not delimited.

83

* **« variable » :**Data delimited by one or more characters. The "end" attribute is mandatory for this format.

84

* **« fixed » :**Fixed size data. The « length » attribute is mandatory.

)))

|(((

**end**

//string//

)))|(((

**Default Value : **empty

92

93

**Description :** Defines the character or characters delimiting a variable format. The characters " \r " (carriage return) " \n " (newline) " \t " (tab), can be used.

)))

|(((

**length**

//integer//

)))|(((

**Default Value : **empty

101

102

**Description :** Defines the number of characters to be taken for a structure of type "fixed".

)))

|(((

**min**

//integer//

)))|(((

**Default Value : **0

110

111

**Description : **Defines the minimum number of successive occurrences of this tag. If min="1", it means that the tag is mandatory and should exist in the output file.

)))

|(((

**max**

//integer//

)))|(((

**Default Value : **1

119

120

**Description : **Defines the maximum number of successive occurrences of this tag. The character "n" can be used to indicate that the tag could be repeated without a max limit.

)))

|(((

**doRead**

//boolean//

)))|(((

**Default Value : **true

128

129

**Description : **Used for reading only. Defines whether the XML tag should be written to the output XML file. Not writing a tag frees up memory and speeds up processing. It becomes essential to use this attribute to process big sized files (**≈ **Mo).

)))

|(((

**skipEmpty**

//boolean//

)))|(((

**Default Value : **true

137

138

**Description : **Used for reading only. Defines if an empty XML tag should be generated if the data is empty in the source file.

)))

|(((

**errorLevel**

//boolean//

)))|(((

**Default Value : **false

146

147

**Description : **When this attribute is set to "true", the translator will make a copy of the reading point. In case of error, the first characters will be returned in the error message. It is advisable to set this attribute to " true " on the records or segments.

)))

|(((

**key**

//boolean//

)))|(((

**Default Value : **false

155

156

**Description : **Defines if the data is a key for its parent. The data must be identical to the value inside the tag described in the format.

)))

|(((

**dataPick**

//boolean//

)))|(((

**Default Value : **true

164

165

**Description : **For the "fixed" format only. It defines if the data is really taken.

)))

|(((

**emptyEnd**

//boolean//

)))|(((

**Default Value : **false (if the tag has children) - true (if the tag has no children)

173

174

**Description : **Defines whether the end separator for a variable format should be written if the data is empty.

)))

|(((

**lastEnd**

//boolean//

)))|(((

**Default Value : **true

182

183

**Description : **Defines whether the end separator for a variable format should be written if the data is the last in a sequence.

)))

|(((

**optionChar**

//string//

)))|(((

**Default Value** : empty

191

192

**Description : **For a fixed format, this attribute defines one or more characters that will be taken beyond the size initially planned. This attribute is particularly useful to manage optional line breaks (case of UNA in an EDIFACT message).

193

)))

194

195

(% class="table-bordered" %)

196

(% class="active" %)|(% colspan="2" %)(((

197

====== __**Lists of Formatting Attributes:**__ ======

)))

|(((

**minSize**

//integer//

)))|(((

**Default Value : **0

205

206

**Description : **Defines the minimum size of the data to be read.

)))

|(((

**maxSize**

//integer//

)))|(((

**Default Value : **2099999999

214

215

**Description : **Defines the maximum size of the data to be read.

)))

|(((

**numeric**

//boolean//

)))|(((

**Default Value : **false

223

224

**Description : **Defines if the field is numeric. For the fixed format, the value will be formatted with zeros on the left. For the variable format, the value will be formatted according to the minimum size.

)))

|(((

**relChar**

//string//

)))|(((

**Default Value : **empty

232

233

**Description : **Defines an escape character, especially when the string to be sampled, contains a character that uses a reserved character in the format file.

234

235

**Example :** We will use the escape character "?" to write/read the following segment NAD+BY++L?'Oreal' because ' is a character reserved in the format file and "L'Oreal" is a string that uses the ' character.

)))

|(((

**trim**

//integer//

)))|(((

**Default Value : **true

243

244

**Description : **Removes spaces before and after the retrieved data

)))

|(((

**setAttribute**

//string//

)))|(((

**Default Value : **empty

252

253

**Description : **The collected data will be stored in the named variable. This variable can then be reused in the following attributes by using the prefix "$". This allows to have a dynamic structure (like in EDIFACT where the separators are defined in the UNA).

)))

|(((

**alignAlpha**

//string//

)))|(((

**Default Value : **left

261

262

**Description : **Used for writing only. Defines the alignment of a character string (not numeric). Possible values are " left " and " right ".

)))

|(((

**fillAlpha**

//string//

)))|(((

**Default Value : **« » (espace)

270

271

**Description : **Defines the character used to complete a text whose size is less than the minimum size (defined by "minSize" or "length")

272

)))

273

274

(% class="table-bordered" %)

275

(% class="active" %)|(% colspan="2" %)(((

276

====== __**List of Log Attributes: **__ ======

)))

|(((

**logLevel**

//string//

)))|(((

**Default Value : **empty

284

285

**Description : **Creates an object in the tracking (of the attribute name), for each occurrence of this tag (read). Several objects can be defined, separated by ";". It is possible to have sub-objects: "Object.SubObject".

286

287

**Example :** « Message », « Message;Toto », « Message.Ligne »

)))

|(((

**logLevelKey**

//string//

)))|(((

**Default Value : **empty

295

296

**Description : **Defines the name of a tracking field used to group multiple records in a single message. This is useful for single record files. Multiple fields can be defined by separating them with ";".

297

298

**Example : **« Message.DocNumber »

)))

|(((

**logTracking**

//string//