Add widget set to a Marketplace product

Use Foundry DevOps to include your widget set in Marketplace products for other users to install and reuse. Learn how to create your first product.

Supported features

All Custom Widgets features are supported by Marketplace products with the exception of:

  • Modifying installed source code in a Foundry code repository to develop and publish new versions. Source code in installed Foundry code repositories is available for debugging purposes only and not compatible for development.
  • Automatically enabling Ontology APIs during installation.
  • Ontology resources with different API names. All ontology resources must use the same API names as the source, either by installing without prefixes, or by mapping inputs to existing ontology resources.
  • Using versioned functions with the Ontology SDK. Only the latest version of a function is supported.
  • Packaging map tile sources. Installing a product in another enrollment preserves the original tile source reference.

Adding Custom Widgets widget sets to products

To add a Custom Widgets widget set to a product, first create a product, then add outputs. Choose the Add files option to navigate to the widget set from within the Compass filesystem and add it to your product.

Alternatively, if you have a Workshop application that embeds a widget set, you can add the Workshop module to the product and the widget set will be included automatically.

A minimum version of @osdk/widget.vite-plugin ↗ of 3.1.0 is required. If a previously published widget set version uses an older version of the vite plugin, first update the vite plugin version in the source code project, then republish a new widget set version before including in DevOps.

Ontology resource API names

Widget sets using Ontology SDK (OSDK) require all ontology resources to use the same API names as the source. These include object types, properties, link types, action types, interfaces, and functions.

At runtime, an installed widget set using OSDK will request the original API names it was published with against the installed ontology. Older products including widget sets do not enforce stable API names at installation time. In this case if API names do not match the source this may lead to 404 not found errors or loading a different ontology resource than intended.

Newer products including widget sets enforce this at validation time. If the names do not match, Marketplace blocks installation with an apiBindingNotStable blocking validation error. The error explains the API name mismatch for the relevant ontology resource.

To fix this you can:

  • Make sure to install ontology resources with the same API names as the source and without prefixes
  • Update existing API names in Ontology Manager to match the source manually. Take care of impact on any other workflows already relying on the API names.
  • Map ontology resource inputs to correct existing ontology resources with the same API names as the source
  • Remove ontology resources from the OSDK on the source if they are unused, regenerate a new OSDK version, install the latest version into the widget set code repository, then republish a new widget set version to use in your product.

Manually enable Ontology APIs after installation

Widget sets using Ontology SDK (OSDK) require a one-time manual configuration after installation to enable Ontology APIs. This configuration persists across product upgrades. For detailed instructions, see Use Ontology SDK (OSDK) in a widget set.