Using plugin templates

In the Pipeline Studio, you can create plugin templates. Plugin templates are customized versions of a plugin that are reusable and contain preconfigured settings. Optionally, you can lock individual properties when you configure the plugin template.

After you create a plugin template, you can edit it and delete it.

You can use the plugin template in pipelines just like any other plugin.

Creating a plugin template

To create a plugin template, follow these steps:

  1. In the Pipeline Studio, hover over the plugin you would like to use for your template, such as the CloudSQL MySQL source plugin. Three dots will appear.

  2. Click the three dots.

  3. Click Create Template.

    The Create Template dialog box appears.

  4. If you have multiple versions of the plugin deployed, in the Choose Version field, select the version you want to use as a template.

  5. In the Template Name field, type the name of the template.

  6. Configure the rest of the properties for the plugin.

  7. Optional: You can lock individual properties of the configuration so that they are not editable.

  8. To save the template, click Add.
    The plugin template appears in the plugin template with an additional "T" icon to indicate that it is a template.

Editing a plugin template

After you create a plugin template, you can make changes to the plugin properties. However, any changes you make do not affect existing pipelines that include the plugin template because those pipelines are created from the artifacts as specified in the plugin template at the time of creation of the pipeline.

To edit or delete a plugin template, follow these steps:

  1. In the plugin palette, hover over the plugin template you want to edit. Three dots will appear.

  2. Click the three dots.

  3. To make changes to the plugin properties, click Edit Template.

  4. After you finish editing the plugin properties, click Save.
    The plugin template appears in the plugin palette and is ready to use in pipelines.

Deleting a plugin template

When you delete a plugin template, it is removed from the plugin palette and is no longer available to be used in pipelines. Deleting a plugin template does not effect existing pipelines that use this plugin template because those pipelines are created from the artifacts as specified in the plugin template at the time of creation of the pipeline.

To delete a plugin template, follow these steps:

  1. In the plugin palette, hover over for the plugin template you want to edit or delete. Three dots will appear.

  2. Click the three dots.

  3. Click Delete Template.
    The plugin template is removed from the plugin palette and is no longer available to use in pipelines.

     

Created in 2020 by Google Inc.