Wiki source code of Installation

Version 45.1 by Outhman Moustaghfir on 2022/07/08 16:29
Show last authors
1 (% class="box successmessage" %)
2 (((
3 Contents :
4
5 {{toc/}}
6
7
8 )))
9
10 = Introduction =
11
12 This current doc will guide you to install correctly iXPath and will give more details about each present configuration.
13
14 == Installation methods : ==
15
16 The installation can be done in 2 ways :
17
18 1. Online Installation: this installation requires downloading some resources online, so it's necessary to have an internet network, then complete the installation.
19 1. Offline Installation: this installation requires the existence of resources on a hard disk or any sources of storage (CD / USB ...), and does not require an internet network.
20
21 |(% style="width:205px" %) |(% style="width:843px" %)Installation elements
22 |(% style="width:205px" %)**Online**|(% style="width:843px" %)(((
23 * jar executable: ixpath.exe
24 * directory bin, that must be next to the jar executable.
25 )))
26 |(% style="width:205px" %)**Offline**|(% style="width:843px" %)(((
27 * jar executable: ixpath.exe
28 * directory bin, that must be next to the jar executable.
29 * the "Install.zip" archive which contains all necessary resources for the installation.
30 )))
31
32 = I - First Installation (Première installation) =
33
34 == 1) Online Installation ==
35
36 The online installation uses remote resources, which makes the internet connection mandatory.
37
38
39 [[image:1657192466936-778.png||height="491" width="796"]]
40
41 if no window displays, please make sure of the existence of the "bin" directory, that contains the java virtual machine to launch the iXPath installation.
42
43 Click on "Pemière installation", and it redirects you to the window below, which gives you the components needed to be installed.
44
45 [[image:1657197821929-405.png||height="441" width="693"]]
46
47 Installation components :
48
49 * Portail: frontend code of iXPath
50 * Moteur (Engine): backend package of iXPath code source. it will install two services: COM (running on port 8091) and Engine (running on port 8090), so please make sure to free these ports, or you can change both of them in the configuration that will be explained later in this document.
51 * Base de données: Script to install the database with all the newest updates.
52 * MySQL: Relational database management system installation.
53 * WebServer (Apache & PHP): Apache server and PHP installation for both "Moteur" and "Portail"
54 * RabbitMQ & Erlang.
55
56 if you already have the RabbitMQ component installed, uncheck it.
57
58 the installation begins with the broker RabbitMQ, and it uses Erlang OTP which is mandatory for its functioning.
59
60 uncheck "Erlang Documentation" as shown below : 
61
62 [[image:1657203367108-301.png||height="440" width="566"]]
63
64 After that, it comes the installation of RabbitMQ :
65
66 [[image:1657203596434-660.png||height="410" width="528"]]
67
68 Next, continue the installation of RabbitMQ, followed by the installation of the "Moteur"/Engine.
69
70
71 [[image:1657203808711-492.png||height="334" width="561"]]
72
73 **Congrats !!! **you have installed iXPath successfully, and you can log in to the app on the "http:~/~/localhost" URL and use "admin" as user and "admin" as password.
74
75
76 == 2) Offline installation ==
77
78 As mentioned before, the offline installation does not require an internet network.
79
80 Click on the executable "ixpath.exe"
81
82 [[image:1657205308850-727.png||height="375" width="608"]]
83
84
85 Then click on "Première installation", and will pop up this window indicating that no internet connection has been detected:
86
87 [[image:1657205397383-147.png||height="112" width="445"]]
88
89 Click on "Oui"/yes.
90
91 if the "Install.zip" does not exist in the same directory as "Ixpath.exe", mention the directory where it belongs:
92
93 [[image:1657205582948-948.png||height="112" width="540"]]
94
95 Eg: if the path is **"C:/InstallationIxpath/Install.zip"**, you will fill in the field with **"C:/InstallationIxpath/". **And the Installation begins...
96
97 [[image:1657205737602-896.png||height="344" width="578"]]
98
99 Accept the 3 Windows authorizations that will pop up during the installation. they are related to 3 components: "Database", "WebServer" and "Engine".
100
101
102 [[image:1657206588463-690.png||height="339" width="570"]]
103
104 **Congrats !!! **you have installed iXPath successfully, and you can log in to the app on the "http:~/~/localhost" URL and use "admin" as user and "admin" as password.
105
106 = II - Architecture of iXPath : =
107
108 here is a brief presentation of the roles of each component in the iXPath app.
109
110 [[image:2022-07-07_17h21_37.png||height="414" width="547"]]
111
112 = III - Update =
113
114 Updating the iXPath app or just some components g__oes exactly the same as the online installation__, which makes the internet network necessary to fetch any updates from the remote resources.
115
116 = IV - Configurations & Monitoring =
117
118 there are configuration files that help to maintain all needed parameters for the functioning of iXPath.
119
120 * config.properties: configuration of the Engine. here we can configure ports, directories, hosts ... it's located in **/SERVER/engine/config.properties **path
121 * config.ini: Configuration of "Portail". here we configure all parameters to connect Engine to Portail. it's located in **./SERVER/wwwroot/config/config.ini **path
122
123 == 1) Ports ==
124
125 * As mentioned before, iXPath takes 8090 (Engine) and 8091 (COM) automatically as ports.
126 if in any case, you want to change them, go to **./SERVER/engine/ixEngine.cmd **script and change them to wanted ports, then execute the script on administrator mode. 
127 For example, we want to change the Engine port to 9090 and the COM port to 9091 
128 [[image:1657208183258-245.png||height="48" width="712"]]
129 \\and make the changes on **./SERVER/engine/config.properties :** 
130 \\[[image:1657208426432-822.png||height="349" width="478"]]
131 \\and same for  **./SERVER/wwwroot/config/config.ini ** : 
132 [[image:1657208646920-357.png||height="146" width="543"]]
133 \\NB: 'Rest' refers to Engine service, and 'COM' refers to COM service 
134
135 * the Engine also uses ports 22920 and 22921 for FTP and FTPS respectively** **
136 [[image:2022-07-07_17h03_53.png||height="337" width="501"]]
137
138 * SFTP port : 
139 [[image:2022-07-07_17h09_58.png||height="124" width="425"]]
140 \\
141
142 NB: You can change all these COM ports via the iXPath interface directly, by selecting the configuration target
143
144 [[image:2022-07-07_17h46_52.png]]
145
146 and change the port from the system configuration:
147
148 [[image:2022-07-07_17h45_14.png||height="163" width="724"]]
149
150
151 == 2) Services ==
152
153 * To maintain services on your operating system, go to the search bar and type "services.msc" :
154
155 [[image:1657272390060-679.png||height="200" width="387"]]
156
157 the services related to iXPath are :
158
159 [[image:2022-07-08_10h29_02.png||height="62" width="646"]]
160
161 [[image:2022-07-08_10h30_20.png||height="16" width="654"]]
162
163 here you can start, restart, pause, or stop the service target by right-clicking on it and choosing the option needed after accessing its properties:
164
165 [[image:manage-startup-type.png]] [[image:startup-type.png]]
166
167
168
169 {{{NB: all services must be running to run the iXPath app correctly.
170 }}}
171
172 * if the Apache service cannot be on running status because of the unavailability of port 80, please follow these steps :
173 ** open a command line and type :  **netstat -aon | findstr :80**
174 [[image:1657273380453-615.png||height="308" width="512"]]
175
176 ** Next, you type the command: **tasklist /fi  "pid eq 4" **
177 [[image:1657273433854-228.png||height="202" width="513"]]
178 ** stop and disable the following services :
179 *** **world wide web publishing service (W3SVC)**
180 *** **windows activation service (WAS)**
181 *** **SQL Server Reporting Services (ReportServer)**
182 *** **BranchCache (PeerDistSvc)**
183 *** **Network Connection Broker (NcbService) **
184 ** start apache service  
185 [[image:1657275791598-755.png||height="233" width="356"]]
186
187 == 3) Logs ==
188
189 There are some log files to help you figure out what causes the dysfunctioning of the iXPath app, and here are all of them :
190
191 |(% rowspan="8" %)(((
192 (% class="wikigeneratedid" id="HCOM" %)
193 //**COM**//
194 )))|(% rowspan="2" %)(((
195 (% class="wikigeneratedid" id="HPORTAL" %)
196 //**PORTAL**//
197 )))|iXPath Front Php:|.\SERVER\wwwroot\Logs
198 |Portal Log:|.\SERVER\wwwroot\Logs
199 |(% rowspan="6" %)(((
200 (% class="wikigeneratedid" id="HCOM-1" %)
201 //**COM**//
202 )))
203 |(% colspan="1" rowspan="2" %)Communication Protocol
204 |.\SERVER\Data\config\COM
205 |Communication Protocol (AS2) Log (Example)|.\SERVER\Data\config\COM\AS2\LOGS
206 |(% colspan="1" rowspan="2" %)LogCom
207 |.\SERVER\Engine\ (logRESTCOM.log)
208 |(% rowspan="4" %)(((
209 (% class="wikigeneratedid" id="HENGINE" %)
210 //**ENGINE**//
211 )))|(% rowspan="3" %)(((
212 (% class="wikigeneratedid" id="HENGINE2019sLog" %)
213 //**ENGINE’s Log**//
214 )))|Source:|.\SERVER\Engine\ixpath.jar
215 |LogRest:|.\SERVER\Data\LOGS\REST (logREST.log)
216 |LogApp:|.\SERVER\Engine\ (ixpath.log ou ixpathErr.log)
217 |(((
218 (% class="wikigeneratedid" id="HProcessLOGS" %)
219 //**Process LOGS**//
220 )))|Process LOGS|.\SERVER\Data\LOGS\ENGINE
221 |(((
222 (% class="wikigeneratedid" id="HBDD" %)
223 //**BDD**//
224 )))|(((
225 (% class="wikigeneratedid" id="HDataBase" %)
226 //**DataBase**//
227 )))|Query Log|.\SERVER\mysql\logs
228
229 = V - FAQ =
230
231 * During the installation, it might happen that the directory already exists, and that will block it.
232 [[image:1657290152857-725.png||height="361" width="606"]]
233 you should take action by following these steps below :
234 ** make a backup for the directory '**SERVER'.**
235 ** delete the directory '**SERVER'**
236 ** relaunch the installation.
237 * if you can't start RabbitMQ service, 
238 [[image:1657290453989-461.png||height="99" width="560"]]
239 add new environment variable named RABBITMQ_SERVER with the RabbitMQ installation Path  :
240 [[image:1657290504230-487.png||height="159" width="554"]]
241 \\RABBITMQ_SERVER : C:\Program Files\RabbitMQ Server\rabbitmq_server-3.10.1C:\Program Files\RabbitMQ Server\rabbitmq_server-3.10.1
242 \\And now restart the RabbiMQ service. 
243 [[image:1657290585573-818.png||height="66" width="585"]]
244 *
245 \\
This wiki is hosted and managed by iXPath
Powered by XWiki 13.3 debian