3. Variables

= Introduction =

Variable is a container that holds a value and can be called in the iXPath Scenario. The importance of variables is to make flexibility in using some values without referring to their origins.

4

5

There are 2 types of variables:

* System variables

* Local variables

To call a variable, we should put it inside ${}. Eg: for a variable named ‘iXVar’, it can be called as ${iXVar}.

11

12

== System variables ==

13

14

System variables define some default values in the system, and they can be called by users several times.

15

16

Here is the list of system variables :

17

18

1. At the declaration of the scenario:

19

1*. iXSession: it returns the ID of the current session.

20

1*. iXSessionPath: gets the Path of the session folder.

21

1*. env: name of the environment.

22

1*. inputFile: this variable collect all input files in one list.

23

1. For a **mail listener : **

24

1*. iXFrom: refers to the sender of the mail.

25

1*. iXSubject: refers to the mail subject.

26

1. For an **AS2 listener **:

27

1*. iXFrom: return the value of the AS2 sender.

28

1. All connectors declare a system variable of type BpmnFile, the connector variable uses a bunch of functions to handle the list of BpmnFiles that will be detailed in the table below :

29

1*. (((

30

|(% style="width:150px" %)**Function**|(% style="width:365px" %)**Description**|(% style="width:394px" %)**Use**

31

|(% style="width:150px" %)Get(i) |(% style="width:365px" %)Get a file with index number "i" from the BpmnFile list, the indexes begin from 0 as the first element, and so on.|(% style="width:394px" %)(((

32

if we have an XmlToXml connector named "XmlToXml1" we can get __the second__ BpmnFile as :

${XmlToXml1.get(1)}

NB: we will make examples on the same connector "XmlToXml1".

37

)))

38

|(% style="width:150px" %)getTrkValues()|(% style="width:365px" %)Return the Tracking values from a BpmnFile.|(% style="width:394px" %)Eg : ${XmlToXml1.get(0).getTrkValues()} returns the tracking values of the first BpmnFile.

39

|(% style="width:150px" %)path()|(% style="width:365px" %)Return the absolute path of the BpmnFile.|(% style="width:394px" %)Eg : ${XmlToXml.get(3).path()} returns the path of the __fourth__ BpmnFile

40

|(% style="width:150px" %)fileName()|(% style="width:365px" %)Return the name of the BpmnFile. |(% style="width:394px" %)Eg : ${XmlToXml1.get(2).fileName()} retrieves the name of the third BpmnFile.

41

|(% style="width:150px" %)extension()|(% style="width:365px" %)Returns the extension of the BpmnFile.|(% style="width:394px" %)(((

42

Eg : if we want to get the extension of the first BpmnFile, we will proceed as below :

43

44

${XmlToXml1.get(0).extension()}

45

)))

46

|(% style="width:150px" %)fullName()|(% style="width:365px" %)Returns the file name + its extension |(% style="width:394px" %)Eg : ${XmlToXml1.get(0).fullName()} returns the full name of the BpmnFile.

47

|(% style="width:150px" %)size()|(% style="width:365px" %)Returns the size of the BpmnFile|(% style="width:394px" %)

)))

Wiki source code of 3. Variables