Skip to content

Commit 5a9e4d0

Browse files
authored
Merge pull request #479 from OP-TED/feature/TED-1364
Feature/ted 1364
2 parents fbd9fca + e44369d commit 5a9e4d0

6 files changed

Lines changed: 94 additions & 66 deletions

File tree

107 KB
Loading
127 KB
Loading
125 KB
Loading
119 KB
Loading
35.1 KB
Loading

docs/antora/modules/ROOT/pages/user_manual/workflow-management-airflow.adoc

Lines changed: 94 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,8 @@ including their names, a short description and a high level diagram.
124124

125125
[arabic]
126126

127-
. *notice_processing_pipeline* - this DAG performs the processing of a
127+
=== notice_processing_pipeline
128+
This DAG performs the processing of a
128129
batch of notices, where the stages take place: normalization,
129130
transformation, validation, packaging, publishing. This is scheduled and
130131
automatically started by other DAGs.
@@ -137,9 +138,9 @@ image:user_manual/media/image25.png[image,width=100%,height=162]
137138

138139
[arabic, start=2]
139140

140-
. *load_mapping_suite_in_database* - this DAG performs the loading of a
141-
mapping suite or all mapping suites from a branch on GitHub, with the
142-
mapping suite the test data from it can also be loaded, if the test data
141+
=== load_mapping_suite_in_database
142+
143+
This DAG performs the loading of a mapping suite or all mapping suites from a branch on GitHub, with the mapping suite the test data from it can also be loaded, if the test data
143144
is loaded the notice_processing_pipeline DAG will be triggered.
144145

145146

@@ -163,10 +164,8 @@ suites on that branch or tag)
163164

164165
image:user_manual/media/image96.png[image,width=100%,height=56]
165166

166-
[arabic, start=3]
167-
. *fetch_notices_by_query -* this DAG fetches notices from TED by using a
168-
query and, depending on an additional parameter, triggers the
169-
notice_processing_pipeline DAG in full or partial mode (execution of
167+
=== fetch_notices_by_query
168+
This DAG fetches notices from TED by using a query and, depending on an additional parameter, triggers the notice_processing_pipeline DAG in full or partial mode (execution of
170169
only one step).
171170

172171
*Config DAG params:*
@@ -180,11 +179,9 @@ only one step).
180179

181180
image:user_manual/media/image56.png[image,width=100%,height=92]
182181

183-
[arabic, start=4]
184-
. *fetch_notices_by_date -* this DAG fetches notices from TED for a day
185-
and, depending on an additional parameter, triggers the
186-
notice_processing_pipeline DAG in full or partial mode (execution of
187-
only one step).
182+
=== fetch_notices_by_date
183+
184+
This DAG fetches notices from TED for a day and, depending on an additional parameter, triggers the notice_processing_pipeline DAG in full or partial mode (execution of only one step).
188185

189186
*Config DAG params:*
190187

@@ -197,21 +194,20 @@ only one step).
197194

198195
image:user_manual/media/image33.png[image,width=100%,height=100]
199196

200-
[arabic, start=5]
201-
. *fetch_notices_by_date_range -* this DAG receives a date range and
202-
triggers the fetch_notices_by_date DAG for each day in the date range.
197+
=== fetch_notices_by_date_range
203198

204-
*Config DAG params:*
199+
This DAG receives a date range and triggers the fetch_notices_by_date DAG for each day in the date range.
205200

201+
*Config DAG params:*
206202

207203
* start_date : string with date format %Y%m%d
208204
* end_date : string with date format %Y%m%d
209205

210206
image:user_manual/media/image75.png[image,width=601,height=128]
211207

212-
[arabic, start=6]
213-
. *reprocess_unnormalised_notices_from_backlog -* this DAG selects all
214-
notices that are in RAW state and need to be processed and triggers the
208+
=== reprocess_unnormalised_notices_from_backlog
209+
210+
This DAG selects all notices that are in RAW state and need to be processed and triggers the
215211
notice_processing_pipeline DAG to process them.
216212

217213
*Config DAG params:*
@@ -226,9 +222,11 @@ notice_processing_pipeline DAG to process them.
226222

227223
image:user_manual/media/image60.png[image,width=601,height=78]
228224

229-
[arabic, start=7]
230-
. *reprocess_unpackaged_notices_from_backlog -* this DAG selects all
231-
notices to be repackaged and triggers the notice_processing_pipeline DAG
225+
image:user_manual/media/image106.png[image,width=100%,height=70]
226+
227+
=== reprocess_unpackaged_notices_from_backlog
228+
229+
This DAG selects all notices to be repackaged and triggers the notice_processing_pipeline DAG
232230
to repackage them.
233231

234232
*Config DAG params:*
@@ -247,9 +245,11 @@ to repackage them.
247245

248246
image:user_manual/media/image81.png[image,width=100%,height=73]
249247

250-
[arabic, start=8]
251-
. *reprocess_unpublished_notices_from_backlog -* this DAG selects all
252-
notices to be republished and triggers the notice_processing_pipeline
248+
image:user_manual/media/image107.png[image,width=100%,height=70]
249+
250+
=== reprocess_unpublished_notices_from_backlog
251+
252+
This DAG selects all notices to be republished and triggers the notice_processing_pipeline
253253
DAG to republish them.
254254

255255
*Config DAG params:*
@@ -263,16 +263,18 @@ DAG to republish them.
263263
*Default values:*
264264

265265

266-
* start_date = None , because this param is optional
266+
* start_date = None, because this param is optional
267267
* end_date = None, because this param is optional
268268
* form_number = None, because this param is optional
269269
* xsd_version = None, because this param is optional
270270

271271
image:user_manual/media/image37.png[image,width=100%,height=70]
272272

273-
[arabic, start=9]
274-
. *reprocess_untransformed_notices_from_backlog -* this DAG selects all
275-
notices to be retransformed and triggers the notice_processing_pipeline
273+
image:user_manual/media/image108.png[image,width=100%,height=70]
274+
275+
=== reprocess_untransformed_notices_from_backlog
276+
277+
This DAG selects all notices to be retransformed and triggers the notice_processing_pipeline
276278
DAG to retransform them.
277279

278280
*Config DAG params:*
@@ -293,9 +295,11 @@ DAG to retransform them.
293295

294296
image:user_manual/media/image102.png[image,width=100%,height=69]
295297

296-
[arabic, start=10]
297-
. *reprocess_unvalidated_notices_from_backlog -* this DAG selects all
298-
notices to be revalidated and triggers the notice_processing_pipeline
298+
image:user_manual/media/image105.png[image,width=100%,height=70]
299+
300+
=== reprocess_unvalidated_notices_from_backlog
301+
302+
This DAG selects all notices to be revalidated and triggers the notice_processing_pipeline
299303
DAG to revalidate them.
300304

301305
*Config DAG params:*
@@ -315,25 +319,50 @@ DAG to revalidate them.
315319

316320
image:user_manual/media/image102.png[image,width=100%,height=69]
317321

318-
[arabic, start=11]
319-
. *daily_materialized_views_update -* this DAG selects all notices to be
320-
revalidated and triggers the notice_processing_pipeline DAG to
322+
image:user_manual/media/image105.png[image,width=100%,height=70]
323+
324+
=== daily_materialized_views_update
325+
326+
This DAG selects all notices to be revalidated and triggers the notice_processing_pipeline DAG to
321327
revalidate them.
322328

323329
*This DAG has no config or default params.*
324330

325331
image:user_manual/media/image98.png[image,width=100%,height=90]
326332

327-
[arabic, start=12]
328-
. *daily_check_notices_availability_in_cellar -* this DAG selects all
329-
notices to be revalidated and triggers the notice_processing_pipeline
333+
=== daily_check_notices_availability_in_cellar
334+
335+
This DAG selects all notices to be revalidated and triggers the notice_processing_pipeline
330336
DAG to revalidate them.
331337

332338
*This DAG has no config or default params.*
333339

334-
335340
image:user_manual/media/image67.png[image,width=339,height=81]
336341

342+
=== reprocess_published_in_cellar_notices
343+
344+
This DAG selects publicly available notices that shall be retransformed and triggers the notice_processing_pipeline DAG to republish them.
345+
346+
*Config DAG params:*
347+
348+
* start_date : string with date format %Y-%m-%d
349+
* end_date : string with date format %Y-%m-%d
350+
* form_number : string
351+
* xsd_version : string
352+
353+
*Default values:*
354+
355+
356+
* start_date = None , because this param is optional
357+
* end_date = None, because this param is optional
358+
* form_number = None, because this param is optional
359+
* xsd_version = None, because this param is optional
360+
361+
image:user_manual/media/image102.png[image,width=100%,height=69]
362+
363+
image:user_manual/media/image105.png[image,width=100%,height=70]
364+
365+
337366
== Batch processing
338367

339368
== Running pipelines (How to)
@@ -471,7 +500,7 @@ be fetched and transformed with format: yyyymmdd.
471500

472501
image:user_manual/media/image51.png[image,width=100%,height=331]
473502

474-
==== UC4: How to fetch and process notices using a query?
503+
=== UC4: How to fetch and process notices using a query?
475504

476505
As a user I want to fetch and process notices published by specific
477506
filters that are available from the TED API so that they are published
@@ -517,10 +546,7 @@ image:user_manual/media/image49.png[image,width=100%,height=357]
517546
As a user I want to reprocess notices that are in the backlog so that
518547
they are published in Cellar and available to the public in RDF format.
519548

520-
Notices that have failed running a complete and successful
521-
notice_processing_pipeline run will be added to the backlog by using
522-
different statuses that will be added to these notices. The status of a
523-
notice will be automatically determined by the system. The backlog could
549+
Notices that have failed running a complete and successful notice_processing_pipeline run will be added to the backlog by using different statuses that will be added to these notices. The status of a notice will be automatically determined by the system. The backlog could
524550
have multiple notices in different statuses.
525551

526552
The backlog is divided in five categories as follows:
@@ -533,10 +559,7 @@ The backlog is divided in five categories as follows:
533559

534560
==== UC5.a Deal with notices that couldn't be normalised
535561

536-
In the case that the backlog contains notices that couldn’t be
537-
normalised at some point and will want to try to reprocess those notices
538-
just run the *reprocess_unnormalised_notices_from_backlog* DAG following
539-
the instructions below.
562+
In the case that the backlog contains notices that couldn’t be normalised at some point and will want to try to reprocess those notices just run the *reprocess_unnormalised_notices_from_backlog* DAG following the instructions below.
540563

541564
[arabic]
542565
. Enable the reprocess_unnormalised_notices_from_backlog DAG
@@ -550,10 +573,7 @@ image:user_manual/media/image76.png[image,width=100%,height=54]
550573

551574
==== UC5.b: Deal with notices that couldn't be transformed
552575

553-
In the case that the backlog contains notices that couldn’t be
554-
transformed at some point and will want to try to reprocess those
555-
notices just run the *reprocess_untransformed_notices_from_backlog* DAG
556-
following the instructions below.
576+
In the case that the backlog contains notices that couldn’t be transformed at some point and will want to try to reprocess those notices just run the *reprocess_untransformed_notices_from_backlog* DAG following the instructions below.
557577

558578
[arabic]
559579
. Enable the reprocess_untransformed_notices_from_backlog DAG
@@ -566,10 +586,7 @@ image:user_manual/media/image77.png[image,width=100%,height=54]
566586

567587
==== UC5.c: Deal with notices that couldn’t be validated
568588

569-
In the case that the backlog contains notices that couldn’t be
570-
normalised at some point and will want to try to reprocess those notices
571-
just run the *reprocess_unvalidated_notices_from_backlog* DAG following
572-
the instructions below.
589+
In the case that the backlog contains notices that couldn’t be validated at some point and will want to try to reprocess those notices just run the *reprocess_unvalidated_notices_from_backlog* DAG following the instructions below.
573590

574591
[arabic]
575592
. Enable the reprocess_unvalidated_notices_from_backlog DAG
@@ -581,12 +598,9 @@ image:user_manual/media/image66.png[image,width=100%,height=41]
581598

582599
image:user_manual/media/image52.png[image,width=100%,height=52]
583600

584-
==== UC5.d: Deal with notices that couldn't be published
601+
==== UC5.d: Deal with notices that couldn't be packages
585602

586-
In the case that the backlog contains notices that couldn’t be
587-
normalised at some point and will want to try to reprocess those notices
588-
just run the *reprocess_unpackaged_notices_from_backlog* DAG following
589-
the instructions below.
603+
In the case that the backlog contains notices that could not be packaged at some point and will want to try to reprocess those notices just run the *reprocess_unpackaged_notices_from_backlog* DAG following the instructions below.
590604

591605
[arabic]
592606
. Enable the reprocess_unpackaged_notices_from_backlog DAG
@@ -600,10 +614,7 @@ image:user_manual/media/image71.png[image,width=100%,height=49]
600614

601615
==== UC5.e: Deal with notices that couldn't be published
602616

603-
In the case that the backlog contains notices that couldn’t be
604-
normalised at some point and will want to try to reprocess those notices
605-
just run the *reprocess_unpublished_notices_from_backlog* DAG following
606-
the instructions below.
617+
In the case that the backlog contains notices that couldn’t be published at some point and will want to try to reprocess those notices just run the *reprocess_unpublished_notices_from_backlog* DAG following the instructions below.
607618

608619
[arabic]
609620
. Enable the reprocess_unpublished_notices_from_backlog DAG
@@ -615,6 +626,23 @@ image:user_manual/media/image38.png[image,width=100%,height=38]
615626

616627
image:user_manual/media/image19.png[image,width=100%,height=57]
617628

629+
=== UC6: How to re-transform notices that have been successfully published and publicly available ?
630+
631+
As a user I want to re-transform notices that have been successfully published and publicly available so that new versions of the RDF notices are published in Cellar and available to the public in RDF format.
632+
633+
This use cases is appropriate only when a new version of the Mapping suite has been loaded into the TED-SWS system. Otherwise, the output of the re-transformation will be the same as before.
634+
635+
636+
[arabic]
637+
. Enable the *reprocess_published_in_cellar_notices* DAG
638+
639+
image:user_manual/media/image109.png[image,width=100%,height=38]
640+
641+
[arabic, start=2]
642+
. Trigger DAG
643+
644+
image:user_manual/media/image19.png[image,width=100%,height=57]
645+
618646
== Scheduled pipelines
619647

620648
Scheduled pipelines are DAGs that are set to run periodically at fixed

0 commit comments

Comments
 (0)