Create a widget set

To create a widget set:

  1. Select Files from the workspace navigation bar and find your desired project or folder.
  2. Select New > Widget set in the top right to create a new widget set within the current project or folder. The new widget set will inherit the permission of the project or folder.
Create a new widget set.
  1. In the creation wizard, enter a name and select where you will develop the widget set:
    • Select In Foundry to create a Foundry Code Repository with built-in CI/CD for testing and publishing the widget set.
    • Select Outside of Foundry to host the source code in your own repository (such as GitHub) and publish the widget set with the CLI.

Create new widget set wizard.

Enable Ontology SDK (OSDK)

To access the ontology from your widget set in code, configure an OSDK using the creation wizard (optional during setup). You can add or configure an OSDK for your widget set at any time.

If you configure an Ontology SDK, you also need to enable the Ontology APIs for your widget set so that API calls made from the OSDK can succeed. This action can be performed by a user with the Information Security Officer default enrollment role. Alternatively, a user with a custom enrollment role that grants the Enable widget set unscoped API access workflow can also perform this action. For instructions, see Use Ontology SDK (OSDK) in a widget set.

Configuring the OSDK screen.

First release

If you chose to develop in Foundry, the widget release will be started automatically and should complete within a few minutes. To check the status of your custom widget:

  • Select Edit in Code Workspaces.
  • Select Tags in the top bar, and then select the listed tag to open its checks page.

If you chose to develop outside of Foundry, follow Publish a widget set to create the first release.

Preview widgets

You do not need to wait for the first release to preview a widget. Use dev mode to preview an unpublished widget in the custom widgets playground or a VS Code workspace.

To preview a widget without dev mode, wait for the first release to finish publishing and then refresh the widget set overview page. Select the widget to preview its published version.

Widget set overview page.

Preview your widget.