Skip to content

application-deep-links.md

Latest commit

 

History

History
65 lines (52 loc) · 2.69 KB

application-deep-links.md

File metadata and controls

65 lines (52 loc) · 2.69 KB
Raw

Applications deep links

Documentation and product pages may open an application example already bundled in DataLab-Web. The query string must declare the complete workflow contract:

Parameter Meaning
plugin Namespaced plugin identifier
pluginVersion Exact bundled plugin version
recipe Namespaced recipe identifier
recipeVersion Exact bundled recipe version
example Example identifier supported by the Web app

All five parameters are required. For example, the Camera quickstart link is:

?plugin=org.datalab.camera-characterization
&pluginVersion=0.1.0
&recipe=org.datalab.camera-characterization:relative-dn-characterization
&recipeVersion=1.1.0
&example=quickstart

The Pulse demo uses:

?plugin=org.datalab.pulse-characterization
&pluginVersion=0.1.0
&recipe=org.datalab.pulse-characterization:single-channel-campaign
&recipeVersion=1.1.0
&example=demo

These blocks are wrapped for readability. Remove the line breaks when building a URL, or construct the query with URLSearchParams so identifiers are encoded correctly.

Validation and loading

Once Pyodide is ready, DataLab-Web resolves the request from the live managed plugin registry. The matching record must be loaded and enabled, have source bundled-wheel, and have trust status verified. Plugin ID, plugin version, recipe ID, recipe version, example ID, and the example-to-recipe link must all match exactly.

Validation finishes before the workspace is changed. An unknown plugin, incomplete request, version mismatch, unsupported example, disabled plugin, or unverified artifact produces a visible error. A user-installed wheel with the same plugin ID is never an implicit target. DataLab-Web never downloads, installs, or enables a Python package in response to a deep link.

After validation:

  • Camera replaces the workspace with its packaged HDF5 quickstart, opens the Images panel, and marks the loaded workspace clean.
  • Pulse replaces the workspace with its deterministic 500-shot campaign, opens the Signals panel, and marks the generated workspace as unsaved.
  • The Applications dialog selects the requested plugin, highlights the recipe, and carries any generated example parameter defaults into its parameter dialog. The recipe is never executed until the user clicks Start analysis.

The generic same-origin preload workspace parameter remains available for ordinary HDF5 demos. When Applications parameters are present, their validated workflow takes precedence and preload is ignored.