Summary

• Page properties (2 modified, 0 added, 0 removed)
• Attachments (0 modified, 0 added, 3 removed)
  • 1649942613906-103.png
  • 1649943564529-130.png
  • SendFtp.png

Details

Page properties

Parent

...	...	@@ -1,1 +1,1 @@
1		-User Guide.The iXPath BPMN.WebHome
	1	+Documentation.iXPath.User Guide.The iXPath BPMN.WebHome

Content

...	...	@@ -1,5 +1,6 @@
1		-= __Introduction__ =
	1	+{{toc/}}
2	2
	3	+= Introduction =
3	3
4	4	Variable is a container that holds a value and can be called in the iXPath Scenario. The importance of
5	5
...	...	@@ -10,8 +10,9 @@
10	10	* System variables
11	11	* Local variables
12	12
13		-== __System variables__ ==
	14	+To call a variable, we should put it inside ${}. Eg: for a variable named ‘iXVar’, it can be called as ${iXVar}.
14	14
	16	+== System variables ==
15	15
16	16	System variables define some default values in the system, and they can be called by users several times.
17	17
...	...	@@ -23,10 +23,10 @@
23	23	1*. env: name of the environment.
24	24	1*. inputFile: this variable collect all input files in one list.
25	25	1. For a **mail listener : **
26		-1*. iXFrom: refers to the sender of the mail that we are listening on.
27		-1*. iXSubject: refers to the Subject of the mail that we are listening on.
	28	+1*. iXFrom: refers to the sender of the mail.
	29	+1*. iXSubject: refers to the mail subject.
28	28	1. For an **AS2 listener **:
29		-1*. iXFrom: return the value of the source of the AS2 that we are listening on.
	31	+1*. iXFrom: return the value of the AS2 sender.
30	30	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 :
31	31	1*. (((
32	32	(% style="width:884px" %)
...	...	@@ -56,70 +56,28 @@
56	56	${XmlToXml1.get(1).type()}
57	57	)))
58	58	)))
59		-1. Variables used to charge the connectors properties in the xsl file without charging them in the scenario manually. Those variables helps reduce time consuming and avoid reputation in the scenario elements:
60		-1*. For the SendFTP et SendSFTP, there are 3 variables:
61		-1**. __**i​​XTo**__: used to charge the property **Destination **of the connector in the XSL file.
62		-1**. __**iXServerConfig**__: used to charge the property **Server Config** of the connector in the XSL file.
63		-1**. __**iXDirectory**__: used to charge the property **Folder** of the connector in the XSL file.
64		-1**. [[image:SendFtp.png]]
65		-1*. For the CallScenario Connector, there are 3 variables:
66		-1**. **iXScenario**: used to charge the property **Scenario **of the connector in the XSL file.
67		-1**. **iXSwitchEnv**: is a boolean variable used to charge the checkbox property **switch environnement** of the connector in the XSL file.
68		-1**. **iXEnv**: used especially when the developper wants to switch the environment and use another scenario in another environment. It is a variable that precise the name of the new environment
69		-1**. [[image:1649942613906-103.png]]
70	70
71		-(% class="wikigeneratedid" id="H" %)
72		-When you change the environment, make sure to verify that the variable iXSwitchEnv has the value true.
	62	+== Local variables ==
73	73
74		-== __Local variables__ ==
75		-
76		-
77	77	Local variable is a type of variable that can be newly created and used for a certain need.
78	78
79	79	So as to create a local variable "newVar" with a value equals to "var number 1", we should write this piece of XSL code :
80	80
81		-
82	82	{{code language="XML"}}
83		-<xsl:value-of select=" ixf:SetVar('newVar', 'var Number 1','false')"></xsl:value-of>
	69	+<xsl:value-of select=" ixf:SetVar('newVar', 'var Number 1')"></xsl:value-of>
84	84
85	85	{{/code}}
86	86
87		-=== Explanation: ===
88		-
89		-* ixf:SetVar: Presumably a custom function or extension function that sets a variable.
90		-* 'newVar': The name of the variable being created.
91		-* 'var Number 1': The value assigned to the variable.
92		-* 'false': The third argument determining whether the variable is global (true) or local (false). if the variable is true so this meaning we can get the variable from the parent scenario.
93		-
94	94	The call of this new variable in the scenario is similar to previous system variables:  **${newVar}.**
95	95
96	96	To get 'newVar' inside an XSL file :
97	97
98		-
99	99	{{code language="XML"}}
100	100	<xsl:value-of select="ixf:getVar('newVar')"></xsl:value-of>
101	101	{{/code}}
102	102
103		-= __How to call the variables? :__ =
	81	+= Examples =
104	104
105		-
106		-To call a variable inside a connector, we should put it inside ${}. Eg: for a variable named ‘Var’, it can be called as ${Var}.
107		-
108		-For the condition in the connector's property, to check if the variable verify the condition, we can use " VarName== 'Value' " or " VarName!='Value' ".
109		-
110		-To call a variable in an xsl file, we should use the local variables SetVar ou GetVar.
111		-
112		-= __Examples__ =
113		-
114		-
115		-
116		-* (((
117		-===== __**1^^st^^ Example:**__ =====
118		-
119		-
120		-
121		-)))
122		-
123	123	We set a simple example of a scenario to illustrate how to use variables.
124	124
125	125	We want to receive a file by a FileListener and send it by mail that contains a message body.
...	...	@@ -138,38 +138,10 @@
138	138	* iXSession : ID session
139	139	* path : the path of BpmnFile in FileListener1.
140	140
141		-* (((
142		-===== __**2^^nd^^ Example**__ =====
	101	+= String Class =
143	143
	103	+String class is java object class that
144	144
145		-
146		-)))
147	147
148		-This is an example to charge the call scenario variables:
149	149
150		-
151		-[[image:1649943564529-130.png]]
152		-
153		-
154		-As shown in the mail body, we called 3 variables which are :
155		-
156		-* **iXEnv**: the Environment when the new scenario exists
157		-* **iXScenario**: ='**error_sc_out_trk_and_statut**'. It means that the current scenariowhere the **connector CallScenario** will be changed to "error_sc_out_trk_and_statut'"
158		-* **iXSwitchEnv**: ='**true**'. It means that the current env will be switched to "**Danone**"
159		-
160		-= =
161		-
162		-= __String Class__ =
163		-
164		-
165		-
166		-in java language, The String class represents character strings. It contains a lot of functions to handle String object.
167		-
168		-you can discover all these functions on the following URL :
169		-
170		-__[[https:~~/~~/docs.oracle.com/javase/8/docs/api/java/lang/String.html#method.summary>>https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#method.summary]] __
171		-
172		-Eg: to check if a variable "myVar" is empty or not, we refer to the isEmpty() method as ${myVar.isEmpty()}, if so then it returns true, if not it will return false.
173		-
174		-
175	175

1649942613906-103.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.achmiti

Size

...	...	@@ -1,1 +1,0 @@
1		-20.3 KB

Content

1649943564529-130.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.achmiti

Size

...	...	@@ -1,1 +1,0 @@
1		-41.2 KB

Content

SendFtp.png

Author

...	...	@@ -1,1 +1,0 @@
1		-XWiki.achmiti

Size

...	...	@@ -1,1 +1,0 @@
1		-21.6 KB

Content