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.

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.

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.

中文翻译¶

将微件集添加到 Marketplace 产品¶

使用 Foundry DevOps 将您的微件集（widget set）纳入 Marketplace 产品中，供其他用户安装和复用。了解如何创建您的第一个产品。

支持的功能¶

Marketplace 产品支持所有自定义微件（Custom Widgets）功能，但以下情况除外：

在 Foundry 代码仓库中修改已安装的源代码以开发和发布新版本。已安装的 Foundry 代码仓库中的源代码仅用于调试目的，不兼容开发用途。
在安装过程中自动启用 Ontology API。
使用不同 API 名称的 Ontology 资源。所有 Ontology 资源必须使用与源相同的 API 名称，要么在安装时不添加前缀，要么将输入映射到现有的 Ontology 资源。
在 Ontology SDK 中使用版本化函数（versioned functions）。仅支持函数的最新版本。

将自定义微件微件集添加到产品¶

要将自定义微件微件集添加到产品，首先创建一个产品，然后添加输出。选择 添加文件 选项，从 Compass 文件系统中导航到微件集，并将其添加到您的产品中。

或者，如果您有一个嵌入了微件集的 Workshop 应用，您可以将 Workshop 模块添加到产品中，微件集将自动包含在内。

需要 @osdk/widget.vite-plugin ↗ 的最低版本为 3.1.0。如果先前发布的微件集版本使用了较旧版本的 vite 插件，请先在源代码项目中更新 vite 插件版本，然后重新发布新的微件集版本，再将其纳入 DevOps。

安装后手动启用 Ontology API¶

使用 Ontology SDK (OSDK) 的微件集在安装后需要一次性手动配置以启用 Ontology API。此配置在产品升级后仍然保留。有关详细说明，请参阅在微件集中使用 Ontology SDK (OSDK)。

Add widget set to a Marketplace product（将微件集添加到 Marketplace 产品）¶