1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
|
%global _empty_manifest_terminate_build 0
Name: python-openlxp-xia
Version: 1.4.2
Release: 1
Summary: Sample installable XIA
License: MIT
URL: https://github.com/OpenLXP/openlxp-xia/
Source0: https://mirrors.aliyun.com/pypi/web/packages/d4/1a/9a508a0214e031ef39841f980c810aed5bc01e5df23fc440432eeaec8ec2/openlxp-xia-1.4.2.tar.gz
BuildArch: noarch
Requires: python3-Django
%description
# OPENLXP-XIA
## What is it?
OpenLXP XIA is a Python package that provides the validation functionality of extracted metadata from the source. In addition, it helps transform metadata into target metadata and further load it into indexing services. The OpenLXP XIA package does not include the metadata extraction process because extraction methods can be different for different sources. But once metadata gets extracted from the source, OpenLXP-XIA continues the V-T-V-L (Validate-Transform-Validate-Load) cycle.
The schema files used for validation can be placed on the schema server. Currently, OpenLXP-XIA uses AWS S3 buckets as a schema server.
Below are the workflow which are performed by the OpenLXP-XIA after package installation.
## Workflows
The OpenLXP-XIA implements five core workflows after extracting metadata from the Specifiec source, as follows:
1. `Validate`: Compares extracted learning experience metadata against the configured source metadata reference schema stored in the Experience Schema Service (XSS).
2. `Transform`: Transforms extracted+validated source learning experience metadata to the configured target schema using the "XSR-to-Target" transformation map stored in the Experience Schema Service (XSS)
3. `Validate`: Compares transformed learning experience metadata against the configured target metadata reference schema stored in the Experience Schema Service (XSS).
4. `Load`: Pushes transformed and validated learning experience metadata to the target Experience Index Service (XIS) for further processing.
5. `Log`: Records error, warning, informational, and debug events which can be reviewed and monitored.
## Prerequisites
`Python >=3.7` : Download and install python from here [Python](https://www.python.org/downloads/).
## Installation
$ python -m pip install OpenLXP-XIA (use the latest package version)
Add OpenLXP-XIA in the setting.py in your project.
INSTALLED_APPS = [
...
'openlxp_xia',
....
]
## Configuration
1. On the Admin page, log in with the admin credentials
2. `Add xis configuration`: Configure Experience Index Services (XIS):
`Xis metadata api endpoint`: API endpoint for XIS where metadata will get stored.
Example:
`Xis metadata api endpoint`: http://localhost:8080/api/metadata/
`Xis supplemental api endpoint`: API endpoint for XIS where supplemental metadata will get stored.
Example:
`Xis supplemental api endpoint`: http://openlxp-xis:8020/api/supplemental-data/
(Note: Replace localhost with the XIS Host)
3. `Add xia configuration` : Configure Experience Index Agents(XIA):
`Publisher`: Agent Name
`Xss api`: API endpoint for XSS where schemas will be retrieved from.
Example:
`Xss api`: https://localhost:8000/api/
`Source metadata schema`: Schema iri or name for source metadata validation
`Target metadata schema`: Schema iri or name for target metadata validation
(Note: Please make sure to upload schema files in the Experience Schema Server (XSS). )
4. `Add metadata field overwrite`: Here, we can add new fields and their values or overwrite values for existing fields.
`Field name`: Add new or existing field Name
`Field type`: Add date type of the field
`Field value`: Add corresponding value
`Overwrite`: Check the box if existing values need to be overwritten.
## Running ETL Pipeline:
ETL or EVTVL (Extract-Transform-Load) Pipeline can be run through two ways:
1. Through API Endpoint:
To run ETL tasks run below API:
http://localhost:8000/api/xia-workflow
(Note: Change localhost with XIA host)
2. Periodically through celery beat:
On the admin page add periodic task and it's schedule. On selected time interval celery task will run.
## Logs
To check the running of celery tasks, check the logs of application and celery container.
## Documentation
## Troubleshooting
## License
This project uses the [MIT](http://www.apache.org/licenses/LICENSE-2.0) license.
%package -n python3-openlxp-xia
Summary: Sample installable XIA
Provides: python-openlxp-xia
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-openlxp-xia
# OPENLXP-XIA
## What is it?
OpenLXP XIA is a Python package that provides the validation functionality of extracted metadata from the source. In addition, it helps transform metadata into target metadata and further load it into indexing services. The OpenLXP XIA package does not include the metadata extraction process because extraction methods can be different for different sources. But once metadata gets extracted from the source, OpenLXP-XIA continues the V-T-V-L (Validate-Transform-Validate-Load) cycle.
The schema files used for validation can be placed on the schema server. Currently, OpenLXP-XIA uses AWS S3 buckets as a schema server.
Below are the workflow which are performed by the OpenLXP-XIA after package installation.
## Workflows
The OpenLXP-XIA implements five core workflows after extracting metadata from the Specifiec source, as follows:
1. `Validate`: Compares extracted learning experience metadata against the configured source metadata reference schema stored in the Experience Schema Service (XSS).
2. `Transform`: Transforms extracted+validated source learning experience metadata to the configured target schema using the "XSR-to-Target" transformation map stored in the Experience Schema Service (XSS)
3. `Validate`: Compares transformed learning experience metadata against the configured target metadata reference schema stored in the Experience Schema Service (XSS).
4. `Load`: Pushes transformed and validated learning experience metadata to the target Experience Index Service (XIS) for further processing.
5. `Log`: Records error, warning, informational, and debug events which can be reviewed and monitored.
## Prerequisites
`Python >=3.7` : Download and install python from here [Python](https://www.python.org/downloads/).
## Installation
$ python -m pip install OpenLXP-XIA (use the latest package version)
Add OpenLXP-XIA in the setting.py in your project.
INSTALLED_APPS = [
...
'openlxp_xia',
....
]
## Configuration
1. On the Admin page, log in with the admin credentials
2. `Add xis configuration`: Configure Experience Index Services (XIS):
`Xis metadata api endpoint`: API endpoint for XIS where metadata will get stored.
Example:
`Xis metadata api endpoint`: http://localhost:8080/api/metadata/
`Xis supplemental api endpoint`: API endpoint for XIS where supplemental metadata will get stored.
Example:
`Xis supplemental api endpoint`: http://openlxp-xis:8020/api/supplemental-data/
(Note: Replace localhost with the XIS Host)
3. `Add xia configuration` : Configure Experience Index Agents(XIA):
`Publisher`: Agent Name
`Xss api`: API endpoint for XSS where schemas will be retrieved from.
Example:
`Xss api`: https://localhost:8000/api/
`Source metadata schema`: Schema iri or name for source metadata validation
`Target metadata schema`: Schema iri or name for target metadata validation
(Note: Please make sure to upload schema files in the Experience Schema Server (XSS). )
4. `Add metadata field overwrite`: Here, we can add new fields and their values or overwrite values for existing fields.
`Field name`: Add new or existing field Name
`Field type`: Add date type of the field
`Field value`: Add corresponding value
`Overwrite`: Check the box if existing values need to be overwritten.
## Running ETL Pipeline:
ETL or EVTVL (Extract-Transform-Load) Pipeline can be run through two ways:
1. Through API Endpoint:
To run ETL tasks run below API:
http://localhost:8000/api/xia-workflow
(Note: Change localhost with XIA host)
2. Periodically through celery beat:
On the admin page add periodic task and it's schedule. On selected time interval celery task will run.
## Logs
To check the running of celery tasks, check the logs of application and celery container.
## Documentation
## Troubleshooting
## License
This project uses the [MIT](http://www.apache.org/licenses/LICENSE-2.0) license.
%package help
Summary: Development documents and examples for openlxp-xia
Provides: python3-openlxp-xia-doc
%description help
# OPENLXP-XIA
## What is it?
OpenLXP XIA is a Python package that provides the validation functionality of extracted metadata from the source. In addition, it helps transform metadata into target metadata and further load it into indexing services. The OpenLXP XIA package does not include the metadata extraction process because extraction methods can be different for different sources. But once metadata gets extracted from the source, OpenLXP-XIA continues the V-T-V-L (Validate-Transform-Validate-Load) cycle.
The schema files used for validation can be placed on the schema server. Currently, OpenLXP-XIA uses AWS S3 buckets as a schema server.
Below are the workflow which are performed by the OpenLXP-XIA after package installation.
## Workflows
The OpenLXP-XIA implements five core workflows after extracting metadata from the Specifiec source, as follows:
1. `Validate`: Compares extracted learning experience metadata against the configured source metadata reference schema stored in the Experience Schema Service (XSS).
2. `Transform`: Transforms extracted+validated source learning experience metadata to the configured target schema using the "XSR-to-Target" transformation map stored in the Experience Schema Service (XSS)
3. `Validate`: Compares transformed learning experience metadata against the configured target metadata reference schema stored in the Experience Schema Service (XSS).
4. `Load`: Pushes transformed and validated learning experience metadata to the target Experience Index Service (XIS) for further processing.
5. `Log`: Records error, warning, informational, and debug events which can be reviewed and monitored.
## Prerequisites
`Python >=3.7` : Download and install python from here [Python](https://www.python.org/downloads/).
## Installation
$ python -m pip install OpenLXP-XIA (use the latest package version)
Add OpenLXP-XIA in the setting.py in your project.
INSTALLED_APPS = [
...
'openlxp_xia',
....
]
## Configuration
1. On the Admin page, log in with the admin credentials
2. `Add xis configuration`: Configure Experience Index Services (XIS):
`Xis metadata api endpoint`: API endpoint for XIS where metadata will get stored.
Example:
`Xis metadata api endpoint`: http://localhost:8080/api/metadata/
`Xis supplemental api endpoint`: API endpoint for XIS where supplemental metadata will get stored.
Example:
`Xis supplemental api endpoint`: http://openlxp-xis:8020/api/supplemental-data/
(Note: Replace localhost with the XIS Host)
3. `Add xia configuration` : Configure Experience Index Agents(XIA):
`Publisher`: Agent Name
`Xss api`: API endpoint for XSS where schemas will be retrieved from.
Example:
`Xss api`: https://localhost:8000/api/
`Source metadata schema`: Schema iri or name for source metadata validation
`Target metadata schema`: Schema iri or name for target metadata validation
(Note: Please make sure to upload schema files in the Experience Schema Server (XSS). )
4. `Add metadata field overwrite`: Here, we can add new fields and their values or overwrite values for existing fields.
`Field name`: Add new or existing field Name
`Field type`: Add date type of the field
`Field value`: Add corresponding value
`Overwrite`: Check the box if existing values need to be overwritten.
## Running ETL Pipeline:
ETL or EVTVL (Extract-Transform-Load) Pipeline can be run through two ways:
1. Through API Endpoint:
To run ETL tasks run below API:
http://localhost:8000/api/xia-workflow
(Note: Change localhost with XIA host)
2. Periodically through celery beat:
On the admin page add periodic task and it's schedule. On selected time interval celery task will run.
## Logs
To check the running of celery tasks, check the logs of application and celery container.
## Documentation
## Troubleshooting
## License
This project uses the [MIT](http://www.apache.org/licenses/LICENSE-2.0) license.
%prep
%autosetup -n openlxp-xia-1.4.2
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-openlxp-xia -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Thu Jun 08 2023 Python_Bot <Python_Bot@openeuler.org> - 1.4.2-1
- Package Spec generated
|
