|
| 1 | +--- |
| 2 | +title: "Using Galaxy webhooks to nudge users toward better tools" |
| 3 | +date: "2026-03-13" |
| 4 | +tease: "A small tool-form extension can mark legacy tools as deprecated, keep them available for reproducibility, and guide users toward faster and more efficient alternatives." |
| 5 | +tags: [tools, ui-ux, feature, environmental, esg] |
| 6 | +subsites: [all-eu, esg, global] |
| 7 | +main_subsite: eu |
| 8 | +contributions: |
| 9 | + funding: |
| 10 | + - eu |
| 11 | + - eurosciencegateway |
| 12 | + - elixir-europe |
| 13 | + - AustralianBioCommons |
| 14 | +--- |
| 15 | + |
| 16 | +Galaxy instances accumulate history. That is a strength, but it also creates a familiar problem: |
| 17 | +Some tools remain scientifically valid and still need to run for old workflows to enable |
| 18 | +reproducibility, while newer alternatives are often faster, have better defaults or are easier to |
| 19 | +use. Outright removing the older tool risks breaking reproducibility. Leaving it untouched means |
| 20 | +users keep selecting them out of habit. |
| 21 | + |
| 22 | +One practical answer is a soft deprecation layer in the Galaxy tool form itself. |
| 23 | + |
| 24 | +Galaxy already supports site-specific UI extensions through [webhooks](https://docs.galaxyproject.org/en/master/admin/webhooks.html). The same pattern can be used to add contextual information to |
| 25 | +specific tools. When a user opens an older (still functional) tool, Galaxy can display a short |
| 26 | +notice explaining that the tool is retained for compatibility, why it is no longer the preferred |
| 27 | +choice, and which replacement tool should be used instead. |
| 28 | + |
| 29 | +We want to: preserve execution, but improve defaults. |
| 30 | + |
| 31 | +The `FastQC` to `Falco` transition on the European Galaxy server is a good example. `FastQC` is a quality control tool for high-throughput sequence data which has |
| 32 | +been executed more than two million times over the years and is still deeply embedded in many |
| 33 | +sequencing workflows. But `Falco`, published in 2021 as a reimplementation of `FastQC`, is roughly |
| 34 | +three times more efficient. When `Falco` first appeared on the European Galaxy server in June 2024, |
| 35 | +uptake was limited. Starting in September 2024, we began nudging users more actively. In |
| 36 | +the `FastQC` interface, in search results, and in training materials. The result was `Falco` reached 158,748 runs, about 29% of `FastQC`'s 546,369 runs in the same time window. |
| 37 | + |
| 38 | + |
| 39 | + |
| 40 | +These images show the three intervention points together: a notice inside the old tool form, a hint in search results, and updated training content that is using the more efficient tool. |
| 41 | + |
| 42 | +With a webhook-backed tool-form extension, the message can be simple and local to the instance: |
| 43 | + |
| 44 | +- This tool is still available for compatibility and reuse |
| 45 | +- This tool is no longer the recommended default for new analyses |
| 46 | +- We recomment a replacement |
| 47 | +- Here is why the replacement is better: faster runtime, lower resource use, better maintenance status, or improved interoperability |
| 48 | +- Here is a direct link to open the alternative tool or the relevant training material |
| 49 | + |
| 50 | +This approach is intentionally lightweight. It does not require to fork tools, remove wrappers, or |
| 51 | +invalidate existing workflows. It allows each Galaxy server to maintain a small registry of additional tool annotation mappings and display them only where they matter. |
| 52 | + |
| 53 | +Soft deprecation helps us reduce wasted CPU time, memory, and |
| 54 | +job queueing time without forcing abrupt migrations. It also creates a transparent path for |
| 55 | +community tool curation. A tool can continue to exist for provenance and backward compatibility, while the interface tells users clearly that the community has moved on. |
| 56 | + |
| 57 | +`FastQC` and `Falco` show why this matters. Many users were not looking for a new quality-control |
| 58 | +tool, they were simply opening the tool they already knew and that is cited in throusands of |
| 59 | +papers. A small information banner changed that behaviour. Extending the tool form with |
| 60 | +webhook-driven deprecation notices gives Galaxy administrators a practical way to repeat that |
| 61 | +success for other pairs of tools, whether the motivation is performance, sustainability, |
| 62 | +maintenance, or a better user experience. |
0 commit comments