Manage data contracts

You can create or manage data contracts and their manifests through the Collibra user interface (UI). You can also use a command-line interface (CLI) or direct API calls to interact with the Data Contract service.

Create a data contract

Prerequisites

  • You have a global role with the Product Rights > Data Contract global permission.
  • You have View permission on the domain where you want to create a data contract.
  • You have a resource role that has the following resource permissions on the domain:
    • Asset > Add
    • Asset > Attribute > Add
  • If you want the data contract to include a Schema section with tables and columns, ensure that the data product port is linked to a physical table or view with columns, or to a schema that contains one or more tables or views with columns. To do this, use the "is implemented as Data Product Port Asset" relation type.

Steps

  1. Open the Data Product asset page.
  2. In the "exposes data as Data Product Port" section, click the data product port card for which you want to create a data contract.
  3. In the Preview sidebar, on the Data contract tab, select one of the following methods to create a data contract.
    MethodDescription
    Knowledge graph generation

    Creates a data contract with manifest based on the information in the data product, data product port, and any linked tables in Collibra.

    1. Click Generate contract manifest.
    2. In the Generate manifest dialog box, enter the following information, and then click Generate (or Generate and download):
      • Name: A name to identify the Data Contract asset.
      • Domain: The domain to which you want to add the data contract. We recommend that you add it to the same domain as the data product.
      • Initial version: The version of the manifest. The default value is 0.0.1.
      • Manifest ID: Defines how you want to structure the ID of the manifest.
      • Download manifest: Select this checkbox if you want to download the generated manifest.
    File Upload

    Creates a data contract with manifest based on the information in the file that you upload.

    1. Click Upload contract manifest.
    2. In the Upload manifest dialog box, click Upload a file, and then select the required manifest.
    3. Enter the following information, and then click Upload:
      • Name: A name to identify the Data Contract asset. The default value is the name of the data product port appended with "contract".
      • Domain: The domain to which you want to add the data contract. The default and the recommended value is the domain of the current data product.
      • Initial version: The version of the manifest. The default value is 0.0.1. Ensure that the value in this field matches the version in the file content.
      • Manifest ID: Defines how you want to structure the ID of the manifest. The default value is the manifest ID in the file content.
    CLIProvides the CLI command to create a new Data Contract asset and manifest.

Upload a new manifest version

Prerequisites

  • You have a global role with the Product Rights > Data Contract global permission.
  • You have View permission on the Data Contract asset.
  • You have a resource role with the following resource permissions on the Data Contract asset:
    • Asset > Attribute > Add
    • Asset > Attribute > Update

Steps

  1. Open the Data Contract asset page, and then click the Contract Manifest tab.
  2. In the upper-right corner within the tab, click More icon > Upload a new version.
  3. In the Upload new manifest version dialog box, click Upload a file, and then select the required manifest.
  4. Enter the following information, and then click Upload.
    FieldDescription
    New version to upload

    The version of the manifest. The default value is 0.0.1. Ensure that the value in this field matches the version in the file content.

    Collibra checks the version in this field against existing versions to prevent duplicates, ignoring the file name or file content. If the version number already exists, Collibra shows an error message unless you select the Force overwrite if version already exists checkbox.

    Set as active manifest version

    A data contract can have multiple manifest versions. Select this checkbox if you want to make the new version the active version. This deactivates the current active version.

    Force overwrite if version already exists

    Select this checkbox if you want to upload the new version even if it already exists for the data contract. To check whether a manifest version already exists, Collibra considers the version number that is shown in this dialog box, not your manifest file name or the version number that is inside the file.

Generate a new manifest version

Prerequisites

  • You have a global role with the Product Rights > Data Contract global permission.
  • You have View permission on the Data Contract asset.
  • You have a resource role with the following resource permissions on the Data Contract asset:
    • Asset > Attribute > Add
    • Asset > Attribute > Update

Steps

You can generate a new version of a manifest based on the latest synchronized metadata.

  1. Open the Data Contract asset page, and then click the Contract Manifest tab.
  2. In the upper-right corner within the tab, in the drop-down list, select the version that you want to be the base for the new version.
  3. Click More icon > Generate a new version.
  4. In the Generate and upload a new version dialog box, in the New version field, enter the version number that you want to assign to the new version.
  5. Click Generate.
    Collibra retrieves the latest synchronized metadata and updates the relevant content in your base version. Any custom code or unsynchronized content in your base version is preserved. The generated version is shown as raw code.
  6. Review, edit, or download the new version. To see the differences between the new version and the base version, click Compare.
  7. Click Continue, enter the following information, and then click Upload.
    FieldDescription
    Set as active manifest version

    A data contract can have multiple manifest versions. Select this checkbox if you want to make the new version the active version. This deactivates the current active version.

    Force overwrite if version already exists

    Select this checkbox if you want to generate the new version even if it already exists for the data contract. To check whether a manifest version already exists, Collibra considers the version number that is shown in this dialog box.

Apply a manifest version

Prerequisites

  • You have a global role with the Product Rights > Data Contract global permission.
  • You have View permission on the Data Contract asset.
  • To apply SLAs: You have a resource role with the following resource permissions on the Data Contract asset:
    • Asset > Attribute > Add
    • Asset > Attribute > Update
    • Asset > Attribute > Remove
  • To apply relations: You have a resource role with Asset > Attribute > Add resource permission on the Data Product Port asset.

Steps

When you apply a manifest version, Collibra updates the knowledge graph to match your manifest version. The process updates Service Level Agreement (SLA) attributes on the Data Contract asset and creates or updates relations between Data Product Port assets and Table assets based on the information in the manifest.

  1. Open the Data Contract asset page, and then click the Contract Manifest tab.
  2. If needed, set a different version as active.
  3. In the upper-right corner within the tab, click More icon > Apply manifest.
  4. In the Apply Changes to Knowledge Graph dialog box, ensure that the correct data product port and manifest version are shown, and then click Next.
  5. Review the proposed changes to SLA attributes.
  6. To accept the changes, click Apply changes. To skip the changes, switch off the Apply changes option, and then click Skip.
  7. Review the proposed changes to relations.
  8. To accept the changes, click Apply changes. To skip the changes, switch off the Apply changes option, and then click Skip.
  9. Click Done.

Set a manifest version as active

Prerequisites

  • You have a global role with the Product Rights > Data Contract global permission.
  • You have View permission on the Data Contract asset.
  • You have a resource role with the following resource permissions on the Data Contract asset:
    • Asset > Attribute > Add
    • Asset > Attribute > Update

Steps

  1. Open the Data Contract asset page, and then click the Contract Manifest tab.
  2. In the upper-right corner within the tab, in the drop-down list, select the version that you want to set as active.
  3. Click More icon > Set as active.
  4. In the Set new active version dialog box, click Set as active.

Compare manifest versions

Prerequisites

  • You have a global role with the Product Rights > Data Contract global permission.
  • You have View permission on the Data Contract asset.

Steps

  1. Open the Data Contract asset page, and then click the Contract Manifest tab.
    The active version of the manifest is shown.
  2. In the upper-right corner within the tab, in the drop-down list, select the primary version that you want to compare.
  3. Click More icon > Compare to.
  4. In the Compare versions dialog box, in the Version field on the right, select the version that you want to compare with the primary version.
    Image of the Compare versions dialog box

Download a manifest version

Prerequisites

You have View permission on the Data Contract asset.

Steps

  1. Open the Data Contract asset page, and then click the Contract Manifest tab.
  2. In the upper-right corner within the tab, in the drop-down list, select the version that you want to download, and then click Download icon.

Delete a manifest version

Prerequisites

  • You have a global role with the Product Rights > Data Contract global permission.
  • You have View permission on the Data Contract asset.
  • You have a resource role with Asset > Attribute > Remove resource permission on the Data Contract asset.

Steps

Note You cannot delete an active manifest version.
  1. Open the Data Contract asset page, and then click the Contract Manifest tab.
  2. In the upper-right corner within the tab, in the drop-down list, select the version that you want to delete, and then click More icon > Delete.

Delete a data contract

Prerequisites

  • You have a global role with the Product Rights > Data Contract global permission.
  • You have View permission on the Data Contract asset.
  • You have a resource role with Asset > Remove resource permission on the Data Contract asset.

Steps

  1. Open the Data Contract asset page.
  2. Click More icon > Delete.

Related topics