@@ -13,7 +13,7 @@ Broadcasts can be helpful for:
13
13
* Quickly developing tasks without having to
14
14
:ref: `edit and reload the workflow configuration <interventions.edit-the-workflow-configuration >`.
15
15
* Sending small amounts of data from a running task to other upcoming tasks (e.g. file paths).
16
- * Orchestrating production workflows from an external system .
16
+ * Reconfiguring production workflows while they are running .
17
17
18
18
Broadcasts which target specific cycles will eventually be
19
19
:ref: `expired <user_guide.broadcast.expiry >` when no longer needed.
@@ -57,8 +57,8 @@ For more information, run ``cylc broadcast --help``.
57
57
GUI
58
58
^^^
59
59
60
- Broadcasts can also be issued from the GUI in a similar way using the
61
- "Broadcast" command .
60
+ Broadcasts can also be issued from the GUI in a similar way by choosing
61
+ "Broadcast" from the task menu .
62
62
63
63
Additionally, the GUI provides a utility called "Edit Runtime" which loads
64
64
the tasks configuration into a form. Any changes you make are then broadcasted
@@ -77,22 +77,21 @@ Expiry
77
77
------
78
78
79
79
Broadcasts which target specific cycles will eventually expire (i.e. be
80
- deleted) as the workflow moves on. Otherwise they would gradually accumulate
81
- over the life of the workflow (note broadcasts are persisted when the workflow
82
- restarts).
80
+ deleted) as the workflow moves on, to avoid gradual accumulation
81
+ (note broadcasts are persisted when the workflow restarts).
83
82
84
83
85
84
Expiry Point
86
85
^^^^^^^^^^^^
87
86
88
- Broadcasts are only expired after they are no longer required by tasks.
87
+ Broadcasts expire once are they are no longer required by upcoming tasks.
89
88
The exact point at which a broadcast is expired depends on two things:
90
89
91
90
* The oldest cycle in the workflow to contain
92
91
:term: `active tasks <active task> `.
93
92
* The longest cycling :term: `recurrence ` in the workflow.
94
93
95
- Broadcasts which are older than the oldest cycle point to contain active tasks
94
+ Broadcasts which are older than the oldest :term: ` active cycle point`
96
95
*minus * the duration of the longest recurrence will be cleared.
97
96
98
97
For example, for the following workflow:
@@ -110,8 +109,8 @@ The longest cycling recurrence is ``P3Y``.
110
109
If there were no more tasks left running in the cycle ``2000 ``, then broadcasts
111
110
for cycles earlier than ``1997 `` (``2000 - P3Y ``) would be expired.
112
111
113
- This arrangement has been designed such that broadcasts should always be
114
- present for the previous instance of a task in case you want to re-run it.
112
+ This is designed to keep broadcasts as far back as the previous instance
113
+ of each task, in case you want to re-run it.
115
114
116
115
117
116
Broadcasting To Historical Cycles
@@ -120,9 +119,9 @@ Broadcasting To Historical Cycles
120
119
Broadcasts targeting historical cycles may be expired as soon as they are
121
120
issued as the result of broadcast expiry.
122
121
123
- Broadcast expiry does not occur while the workflow is paused. If you want to
124
- broadcast to a historical cycle before re-running it, first pause the workflow,
125
- then trigger the tasks, then resume the workflow, e.g:
122
+ However, broadcast expiry does not occur while the workflow is paused, so
123
+ you can pause the workflow, do the broadcast, trigger the tasks, and then
124
+ resume the workflow, e.g:
126
125
127
126
.. code-block :: bash
128
127
0 commit comments