Creating and maintaining data contracts and their manifest files from Collibra

From Collibra, you can:

You can also use the Collibra Data Contracts CLI or APIs. For more information, go to Creating and maintaining data contracts and their manifest files through CLI and API

Steps overview

  1. Review the preflight checks.
  2. Create / manage the data contract.
  3. Verify the data contract information in Collibra.
    You can do this by navigating to the Data Contract asset type. You can also get a global view on all the data contracts in an environment through the Data Contract Registry.

1 Review the preflight checks

Before you create and maintain data contracts, check the following:

2 Create a data contract

Prerequisites

You have reviewed the preflight checks.

Steps

  1. Navigate to the Data Product asset page.
  2. Scroll down to the section that shows the Output ports viewer widget.
  3. Click the card of the Data Product Port you want to add a data contract to.
    The Preview panel opens showing tabs:
    • Data product port shows the attributes and schema information in the product port.
    • Data contract shows the data contract details if available.
  4. Click the Data contract tab.
    If no data contract has been initiated yet, buttons are shown which allow you to create a new contract.
  5. Choose one of the following methods to create a data contract:
    • Knowledge graph generation allows you to generate a data contract based on the available information in the Data Product, Data Product Port, and linked Tables.
      1. Click Generate contract manifest.
        The Generate manifest dialog box appears.
      2. Complete the fields as follows:
        FieldDescription
        NameThe name you want to give to the Data Contract asset.
        DomainThe domain in which you want to add the Data Contract. We advise to add it to the same domain as the Data Product.
        Initial versionThe version of the manifest. By default the version is set to 0.0.1.
        Manifest IDThe Manifest ID field defines how you want to structure the ID of the manifest file in the Data Contract asset. You can select the following options:
        • Use data contract asset UUID as manifest ID
        • Use custom manifest ID
        Download manifestSelect the Download manifest checkbox to download the generated manifest file.
      3. Click Generate or Generate and download.
        The name depends on your selection.
        A new Data Contract asset and manifest file are created. The manifest file is automatically completed with the Tables, Columns, and Descriptions from the Data Product Port asset. The manifest file also includes the values of some SLA attributes from the Data Contract asset. For more information, go to SLA mappings.
        If you have selected to download the file, the file is downloaded automatically to your computer.
    • File Upload allows you to create a file outside Collibra and use this file as the manifest file for the Data Contract asset of the Data Product Port.
      1. Click Upload contract manifest.
        The Upload manifest dialog box appears.
      2. Click Upload a file or drop it into the Upload a file section.
        The file gets uploaded.
      3. Complete the fields as follows:
        FieldDescription
        NameThe name you want to give to the Data Contract asset.
        DomainThe domain in which you want to add the Data Contract. We advise to add it to the same domain as the Data Product.
        Initial versionThe version of the manifest. By default the version is set to 0.0.1.
        Manifest IDThe Manifest ID field defines how you want to structure the ID of the manifest file in the Data Contract asset.

        The manifest ID defined in the uploaded file is automatically picked up.

      4. Click Upload.
        A new Data Contract asset is created. The uploaded manifest file is automatically set to the latest version of the Data Contract.
    • CLI allows you to get the correct command to use in the CLI to create a Data Data Contract and manifest file.
      Click the Copy to Clipboard icon and follow the instructions in the CLI information to start working on the data contract. For information, go to Creating and maintaining data contracts and their manifest files through CLI and API.

3 Manage a data contract via Collibra

In Collibra, you can manage the Data Contract Manifest files from the Data Contract asset page. You can, for example, replace a manifest with a new version by downloading the existing version, updating it locally, and uploading it again.

Prerequisites

Upload a new data contract version

  1. Navigate to the Contract Manifest information in a Data Contract asset page.
    The active data contract manifest is shown.
  2. From the More icon, select Upload a new version.
    The Upload new manifest version dialog box appears.
  3. Click Upload a file or drop the file into the upload area.
    4. Field Description
    Target data contract asset

    The name of the data contract.
    You can't change this field.

    New version to upload

    The version of the manifest.

    If you are generating a new version of the manifest file, you can't change the version number in this field.
    If you are uploading a first version of the manifest, by default, the version is set to 0.0.1. You can change this to another number.

    The upload process checks if the version number already exists. It doesn't look at the file name, nor the version number mentioned inside the file.
    If you don't force an overwrite through the Force overwrite if version already exists checkbox, Collibra shows an error message if the version already exists.
    Set as active manifest version Select the Set as active manifest version checkbox if you want the new file to become the active version. This means that the previous active version will be deactivated.
    Force overwrite if version already exists

    Select the Force overwrite if version already exists checkbox if you want to upload this file version even though it already exists for the data contract.

    To validate if the version already exists, the upload process checks the version number provided in this dialog box. It doesn't look at the file name, nor the version number mentioned inside the file.
  4. Click Upload.
    The new version is uploaded. Depending on your selections, the file is now the active version.

Generate a new data contract version

Collibra can generate a new draft manifest file based on the latest synchronized metadata in Collibra.

  1. Navigate to the Contract Manifest information in a Data Contract asset page..
    The active data contract manifest is shown.
  2. If needed, select another version from the drop-down list.
    The selected data contract manifest acts as the base for the new draft.
  3. From the More icon, select Generate a new version.
    The Generate and upload a new version dialog box appears, showing the Select version step.
  4. In New version, enter the version number that you want to give to the new draft.
  5. Click Generate.
    Collibra retrieves the latest synchronized metadata and updates the relevant content in the base manifest file. Any existing content that is not synchronized by Collibra remains unchanged, ensuring that unsynchronized content is preserved.
    The Review manifest step shows the new draft as code.
  6. Review the draft content and make changes as needed.
    You can also download the new draft at this point.
  7. Once all is good, click Continue.
    The Upload step is shown.
  8. Complete the fields as needed:
    FieldDescription
    Target data contract asset

    The name of the data contract.
    You can't change this field.

    New version to upload

    The version of the manifest.

    If you are generating a new version of the manifest file, you can't change the version number in this field.
    If you are uploading a first version of the manifest, by default, the version is set to 0.0.1. You can change this to another number.

    The upload process checks if the version number already exists. It doesn't look at the file name, nor the version number mentioned inside the file.
    If you don't force an overwrite through the Force overwrite if version already exists checkbox, Collibra shows an error message if the version already exists.

    Set as active manifest versionSelect the Set as active manifest version checkbox if you want the new file to become the active version. This means that the previous active version will be deactivated.
    Force overwrite if version already exists

    Select the Force overwrite if version already exists checkbox if you want to upload this file version even though it already exists for the data contract.

    To validate if the version already exists, the upload process checks the version number provided in this dialog box. It doesn't look at the file name, nor the version number mentioned inside the file.

  9. Click Upload.
    The new version is uploaded. Depending on your selections, the file is now the active version.

Make a data contract version active

  1. Navigate to a Data Contract asset page and click Contract Manifest.
    The current, active data contract manifest is shown.
  2. Select the version you want to make active from the drop-down list.
  3. From the More icon, select Set as active.
    The Set new active version dialog box appears informing you that this action will mean the existing active version becomes inactive.
  4. Click Set as active.
    The selected version becomes active. The active version is tagged with (Active) after the version.

Delete a data contract version

To delete a manifest file, select the version from the drop-down list and from the More icon select Delete.

You can't delete manifest files that are active.

What's next

Related topics