Import a template

You can use the Import Template feature to, for example, import a custom template from your testing environment to your production environment.

Important 

In Collibra 2024.05, we launched a new user interface (UI) for Collibra Platform! You can learn more about this latest UI in the UI overview.

Use the following options to see the documentation in the latest UI or in the previous, classic UI:

In this topic

Prerequisites

Steps

  1. Open the templates page.
  2. In the Custom templates section, click , and then click Import template.
    The Import template dialog box appears.
  3. Click Upload template, and then select the template that you want to import.
    4. Tip If a template of the same name already exists in your environment, you are prompted to enter a new name for the template that you are importing.
  4. Click Import.
    A message stating that the template is imported appears. The template is added to the Custom templates section.
  1. Open the templates page.
  2. In the Custom Templates section, click Import Template.
    The Import a Template dialog box appears.
  3. Click the Upload a JSON file prompt, and then select the file you want to import. Alternatively, you can drop the file into the dialog box.
  4. If needed, change the value in the Template Name field.
  5. Click Import.
    The imported template is added to the Custom Templates section.

Template name

The template you are trying to import may have the same name as that of a template already in Collibra. Here, the term name refers to the title of the template in the JSON file, not the file name.

  •  If a Collibra (out-of-the-box) template with the same name already exists, a new template is created without replacing the existing Collibra template. The imported template has the status Draft, version V1, and a number appended to its name to differentiate it from the existing template. For example, if the existing template's name is Collibra, the imported template's name becomes Collibra (2). You can also rename the imported template in the Template Name field during the import.
  •  If a custom template with the same name already exists, you can choose one of the following options:
    • Import as a new version of the existing template: Replaces the existing template with your imported one. The existing template's ID is retained so that any integrations, such as workflows, continue to work. The imported template has the status Draft and its version is incremented. For example, if the existing template's version was V1, it now becomes V2.
    • Import as a new template: Creates a new template without replacing the existing one. The imported template has the status Draft, version V1, and a number appended to its name to differentiate it from the existing template. For example, if the existing template's name is Custom, the imported template's name becomes Custom (2). You can also rename the imported template in the Template Name field during the import.
  • If a template with the same name doesn't exist, you can still import your template as a new version of an existing custom template using the following option:
    • Import as a new version of the existing template: Replaces the existing template you select in the Template field with your imported one. The imported template has the status Draft and its version is incremented. For example, if the existing template's version was V1, it now becomes V2. You can also rename the imported template in the Template Name field during the import.