Create a widget set
To create a new widget set, follow the instructions below:
- Select Files from the workspace navigation bar and find your desired project or folder.
- 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.
- In the create new widget set wizard, configure the name of your widget set and select whether you will be developing in or outside of Foundry. Developing in Foundry is the easiest way to get started, as it automatically bootstraps a code repository with built-in CI/CD for creating, testing, and publishing your widget set. Alternatively, you can host your code in your own repository (such as GitHub) and use our CLI to manage version control and publish the widget set yourself.
Enabling 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 choose to configure an Ontology SDK, you must also enable the Ontology APIs for your widget set, which can be done by any user with the Information Security Officer role. Otherwise, API calls made from the OSDK will fail. Review Using Ontology SDK (OSDK) in a widget set documentation for further details.
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 the Edit in Code Workspaces option.
- Select Tags in the top bar of Code Workspaces and then into the listed tag's check page.
If you opted to develop outside of Foundry, refer to the instructions provided on publishing a widget set documentation.
Previewing widgets
After the first version of your widget has been released, refresh the widget set's overview page to show a new widget. Select the widget will allow you to preview it.
