Wiki source code of 3. Variables
Version 2.5 by Outhman Moustaghfir on 2021/04/27 14:45
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | = Introduction = | ||
| 2 | |||
| 3 | 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: | ||
| 6 | |||
| 7 | * System variables | ||
| 8 | * Local variables | ||
| 9 | |||
| 10 | 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:161px" %)Function|(% style="width:397px" %)Description|(% style="width:352px" %)Use | ||
| 31 | |(% style="width:161px" %)Get(i) |(% style="width:397px" %)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:352px" %)((( | ||
| 32 | if we have an XmlToXml connector named "XmlToXml1" we can get second bpmn file as : | ||
| 33 | |||
| 34 | ${XmlToXml1.get(1)} | ||
| 35 | ))) | ||
| 36 | |(% style="width:161px" %) |(% style="width:397px" %) |(% style="width:352px" %) | ||
| 37 | |||
| 38 | |||
| 39 | ))) | ||
| 40 | |||
| 41 | |||
| 42 | |||
| 43 | |||
| 44 | |||
| 45 |