Version 15.1 by Rabie Chettahi on 2022/06/13 13:18
Show last authors
1 **Definition: **
2
3
4 iXPath is a B2B integration platform in SAAS (software as a service) mode allowing to link the information systems of our customers to those of their various partners but also to manage the internal information flows of the company.
5
6 iXPath offers complete and secure management of data exchanges regardless of the communication protocols used and the file formats to be processed.
7
8 iXPath provides its customers with a web portal service dedicated to identified data flows. In addition to traditional EDI flows, the iXPath portal enables an ordering party to quickly deploy flow automation to all its partners, regardless of their size and technical capacities.
9
10 Different business processes are modeled and can be adapted according to the needs of our customers
11
12 Order to Cash: Sales order, Delivery note, Invoicing
13 Logistics flows: reception, preparation, stock image, stock movements
14 Order Entry: online order entry, acknowledgment of receipt, delivery note
15 Process specific to the client's activity
16
17 iXPath adapts to your business processes and is configured according to the desired management rules.
18
19 **The Dashboard:**
20
21 The dashboard contains a vertical menu that contains shortcuts to the main modules of the application. This table allows the consultation of filters, statistics adapted to the needs of the user.
22
23
24 **Documents page :**
25
26 The "Documents" page of the iXPath application consists of displaying and managing the filters, in fact a filter is the set of parameters selected by the administrator or privileged user to do a search in the Tracking.
27
28 [[image:2.PNG||alt="Documentation"]]
29
30 The filter results are displayed in a table format that contain several Tracking lines.
31
32 [[image:create filter.PNG||alt="filter"]]
33
34 This window represent a list of filters with their setting management (Add, Edit and Delete).
35
36 [[image:base article.PNG||alt="o" height="242" width="203"]]
37
38 Window which displays data statics that are linked to a predefined filter with setting management.
39
40 [[image:n.PNG||alt="tab" height="252" width="187"]]
41
42 ====== ======
43
44 ====== Window that displays additional information about a slected Tracking from filter results. ======
45
46 **Filters creation:**
47
48 The cration of a filter goes through several  tabs : Globall, Criteria, View, Buttons, Statistics and Calendar.
49
50 [[image:1615473612114-424.png]]
51
52 The "Global" tab fields allow to identify the filter by its name, envitonnement and the types of documents that belong to it.
53
54 [[image:k.PNG||alt="doc"]]
55
56 The "Criteria" tab allows to add the search criteria for the creation of the filter, you can add one or more criteria while combining the different types of the documents, data and values.
57 The added criterias are displayed in the right part of the "Criteria" tab with the "Delete" button that allows you to delete a criteria.
58
59 CAPTURE
60
61 The "Display" tab allows to select the fields to be displayed in the filter result, it also allows to set several options and settings to reorganize the columns and display the filter in customized formats.
62 Data redefinition consists of assigning other data types to a selected field when combining several document types in a single filter
63
64 CAPTURE
65
66 "Buttons" tab consists of adding buttons to a filter that allow to perform certain actions on the whole filter data or specifically on a single row of the filter data.
67 Section "Active buttons" allows the identification of the button by an alias, its position and other options.
68 To associate an icon with a button, we have two options: either we add it via the "Download icon" button or we select it from a list that is displayed via the "Icons" button.
69 The added button is displayed with its icon, its alias and its action.
70
71 CAPTURE
72
73 On the filter, we recognize "Top Buttons" which is moved to the header of the filter and executing actions on all data of the filter.
74
75 CAPTURE
76
77 There is also "Line Buttons" that are moved to each line of the data in the filter and it only executes actions of that specefic line.
78
79 CAPTURE
80
81 The "Actions" section consists in defining the action(s) to be executed by a button, indeed each type has specific fields to define its settings.
82 These are the following actions:
83
84 CAPTURE
85
86 CAPTURE 02
87
88 "Statistics" tab allows you to set up the data statistics of a filter. There are 6 types of graphs:
89
90 * Histogram
91 * Curve
92 * Radar
93 * Segments
94 * Ring
95 * Polar zone
96
97 CAPTURE
98
99 "Calendar" tab allows to display the number of tracking on a determined period.
100
101 ======
102 Modification of filters ======
103
104 You can modify a filter by clicking on the "Modify" button.
105 Indeed, this operation goes through the same tabs when creating a filter.
106
107 Capture
108
109 Deleting the filters
110
111 In order to delete a filter, click on the "Delete" button.
112 Confirm the deletion by clicking on "Continue" in the confirmation message.
113
114 CAPTURE
115
116 Capture
117
118 This is a monitoring tool that displays all the jobs processed during an EDI file translation.
119
120
121 Job Research
122 This part consists of identifying the different "Jobs" that have been carried out in a defined period and in a specific environment.
123 The Job search is a combination of several criteria with operators and search values.
124
125 Capture
126
127 To perform a search :
128 Select an environment if there are several ones.
129 Choose the criteria.
130 The result is found on the list Jobs.
131 Each job has its sub-jobs and its parent job.
132 In fact, you can display the hierarchy of the Jobs via the icon (+).
133
134
135 The Job action buttons allow you to upload incoming files, intermediate files converted to XML and the outgoing files.
136
137 CAPTURE
138
139 File Search :
140 You can search for a file that has been used in a job by its name and type.
141
142 CAPTURE
143
144 The "Display history" checkbox includes all files that have been passed through the conversion from the initial stage to its final.
145 The action buttons allow:
146
147 * Download the file.
148 * Show linked documents via a filter.
149 * Show linked jobs.
150
151 CAPTURE
152
153 This interface allows you to manage environments and sub-environments.
154 Each environment belongs to its parent environment. - The "Activation URL" option allows you to send an email containing an activation URL for the account of any newly created user.
155
156 CAPTURE 01
157
158 CAPTURE 02
159
160
161 Labels :
162
163
164 CAPTURE
165
166 This module allows you to manage aliases and labels, you can actually link the labels to their aliases which define the fields.
167 To display a field, we first look for its label, otherwise we display its alias.
168
169 In the "Labels" interface, there are the following boxes:
170
171 * Display of all aliases with action buttons.
172 * List of alias tables with the total number of aliases and the total number of empty aliases in each table.
173 * List of all labels with action buttons.
174 * Label search area.
175 * Label Info" box that displays the ID and aliases related to the tables.
176
177 - Associate / Unlink an alias:
178
179 To assign a label to an alias, select it from the list of labels and click on the "Associate" action button
180 To unlink an alias and a label, click on the "Unlink" button
181 - Add / Modify / Delete label:
182
183 To add a new label, click on the button "New Label" which also allows you to link it with an alias.
184 The label is made up of two fields, French and English.
185
186 You can change or delete a label by clicking on the action buttons in the "Labels" list
187
188
189 CAPTURE
190
191 The Tracking editor consists of creating and managing the different types of tracking, in this interface there is a table of tracking and a table of data.
192
193 - Types of tracking:
194 In the Tracking table, we can see :
195 The Tracking Alias.
196 The type.
197 Volume: Total number of records per Tracking type.
198 Threads: Total number of threads.
199 Data: Total number of data related to the Tracking.
200 Tracking label.
201 To add a Tracking, click on the "New Tracking" button and fill in the form that appears at the bottom of the "Tracking" frame.
202 The action buttons of the Tracking frame
203 - Add / Modify Tracking buttons
204
205 [[image:LL.PNG||alt="J"]]
206 Allows you to add or modify a button related to the type of Tracking by assigning an action to it.
207 A form is displayed that is similar to the one for creating filter buttons.
208
209 - Show linked Tracking
210
211 [[image:QQ.PNG]]
212
213 This button displays the list of Trackings linked to the selected Tracking with the relationship type "Parent" or "Son".
214
215 CAPTURE
216
217 - View Tracking Data
218
219 [[image:WW.PNG]]
220
221 This button displays the list of data related to the selected Tracking with their details, e.g. field format, indexed or not ...
222
223 CAPTURE
224
225 - Modify label / Delete Tracking
226
227 [[image:1615477120900-279.png]]
228
229 You can modify the Tracking label by clicking on the "Modify Label" button. The "Label" field becomes an editable text box.
230 The second button allows you to delete the Tracking.
231 The deletion of Tracking that is linked to other elements "Linked Tracking, Linked Data, ..." is only possible after these elements have been deleted.
232
233 - Data types:
234 The data types allow you to define the fields that make up the Trackings.
235 To add a new data type, click on the "add" button and fill in the text fields at the end of the frame: Alias, Label Fr, Label En.
236
237 CAPTURE
238
239 To link data to a Tracking :
240
241
242 * Display the data linked to the Tracking.
243 * Click on the button "Link a new data".
244 * Fill in the line at the bottom of the frame that contains the list of data aliases, formats and choose whether the field is indexed or not.
245
246 The interface also contains two zones to search on Tracking and on data by alias.
247
248 CAPTURE
249
250 The form editor consists of creating and managing the forms used in the Tracking filters.
251
252 To add a form, click on the "New Form" button
253
254 After that, the user goes through 4 tabs:
255
256 * Global.
257 * Sections.
258 * Buttons.
259 * File.
260
261 a- Global tab
262 This tab consist of assignning to a format an alias, type of document (Tracking Type) and an environnement.
263
264 b- Section tab
265 A form contains one or more sections. There is always an "Information" section, which exists in all forms.
266 In general, there are two main types of sections: Filter and Data.
267
268
269 CAPTURE
270
271 * Number of Columns : indicates the number of columns in the created section.
272 * Image : indicates if the section is an image when uploaded by the component at the form edition level.
273 * Section column : indicates in which column the data will be displayed.
274 * Color : it's the color of the displayed field
275 * Mandatory : the field is mandatory to fill in.
276 * Modifiable: indicates whether the field can be changed or not at the editing level.
277
278 b- Buttons tab
279 In this tab, the administrator can add buttons to the form that perform actions.
280
281
282 CAPTURE
283
284 * The user finds the buttons created by the administrator when the registration is displayed.
285 * The buttons are displayed with their labels, e.g.: "Add Supplementary Doc" "Close" "Submit Purchases".
286 * The display of a button is linked to the Tracking status.
287 * If a user opens a form under modification, it is locked from the others.
288
289 d- Tab File
290 In this tab, the administrator specifies whether the registration can contain files or capture an image as well,
291
292 CAPTURE
293
294 It can also specify:
295
296 * The type of files.
297 * The download folder.
298 * The Mask, that is the extension of the files.
299 * The direction of the files: input file, output file or both directions.
300 * The maximum number of files to attach.
301
302 - The attachment of files or the capture of images is done in the "modification" mode of the form.
303 - The files are displayed on the left side of the "Information" section of the form.
304 - The file management buttons that were activated when the form was created.
305 - At the end of the file attachment, the form is saved.
306
307
308 CAPTURE
309
310 This interface is used to define the default display of the filter. Indeed, a filter can contain one or more data types (Tracking Type).
311
312 Thus, this form allows the administrator to specify which type of data will be displayed by default in the filter on a given environment.
313
314 The "Global" option specifies whether the default filter will be applied to all sub-environments.
315
316 CAPTURE
317
318 The Data Editor allows you to create a DataList and to assign a list of values to it.
319
320 This list is usually used in the forms that have been created before for the modification of the Trackings.
321
322 CAPTURE
323
324 This interface is reserved for administrators and generally allows to execute a set of actions that are gathered in a system button.
325 E.g.: Sending a confirmation mail, running a script, ...
326
327 The system buttons are :
328 CreateUserBtnID : we assign actions to execute when creating a user
329 ModifyUserBtnID : we assign actions to be executed when modifying a user.
330 DeleteUserBtnID: we assign actions to be executed when deleting a user.
331 CreateEnvBtnID: we assign actions to be executed when creating an environment
332 ModifyEnvBtnID: we assign actions to be executed when modifying an environment
333 DeleteEnvBtnID: we assign actions to be executed when deleting an environment
334
335
336 CAPTURE
337
338 The "Permissions" module allows you to manage the access rights and the privileges of administrators and users.
339
340 These rights define which users are allowed to access the different modules of the application and also the detailed functionality of each module.
341
342 Access rights are assigned to hierarchical groups (see Sec. 2.4.1. Group Editor), so a child group can only inherit the rights of the parent group.
343
344 CAPTURE
345
346 For technical issues, the end user can contact the iXPath support team through the technical issue management interface or at support@ixpath.com.
347
348
349
350
351
352
353
354
355
356
357
358
359
360 ​
This wiki is hosted and managed by iXPath
Powered by XWiki 13.3 debian