Add SQL worksheets to a Marketplace product

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

Packaging a worksheet also lets you package the Ontology SQL functions published from it, since the function depends on the worksheet.

Supported features

Worksheets that read from datasets and object types can be included in Marketplace products. When a product is installed, the worksheet is created in the installation project and its SQL is rewritten to reference the resources the installer selects.

  • Datasets: Each dataset the worksheet references becomes a product input.
  • Object types: Each object type the worksheet references becomes a product input, along with each of the object type's properties that the worksheet uses.

The following worksheets cannot be included in Marketplace products:

  • Worksheets that write to outputs, such as worksheets that create or insert into tables.
  • Worksheets that call procedures.
  • Private worksheets. Save the worksheet into a project before adding it to a product.

Add SQL worksheets to products

To add a worksheet to a product, first create a product, then add outputs. Choose the Add files option to navigate to the worksheet from within the Compass filesystem and add it to your product. The datasets and object types the worksheet references are added to the product as inputs.

Install and upgrade

When installing the product, map each input to a dataset or object type in your environment. Object type property inputs are mapped to properties of the selected object type.

When a new product version is published, upgrading an installation updates the installed worksheet to the new version while keeping your input mappings.