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

You can create a data contract from the Data Product asset page.

Tip You can also create a data contract from the asset page of any asset type in the Data Contract Subject asset type group, for example, Data Product Port. In the should operate according to Data Contract section of the asset page, click New data contract, and then go to step 4.

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 with the following resource permissions on the domain where you want to create a data contract:
    • Asset > Add
    • Asset > Attribute > Add
  • You have the Asset > Attribute > Add resource permission on the governed asset.
  • If a data contract is already created without a manifest and you want to initialize the contract:
    • 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 Product asset page.
  2. In the exposes data as Data Product Port section, click the data product port card.
  3. In the Preview sidebar, click the Data contract tab.
  4. Choose one of the following methods.
    MethodDescription
    Knowledge graph generation

    Creates or updates a data contract with a manifest based on the information in the governed asset and any linked tables. If you select this method:

    1. Click Generate contract manifest.
    2. In the Generate manifest dialog box, review or edit the values.
    3. Click Generate (or Generate and download).
    File upload

    Creates or updates a data contract with a manifest based on the information in the file that you upload. If you select this method:

    1. Click Upload contract manifest.
    2. In the Upload manifest dialog box, click Upload a file, and then select the required manifest.
    3. Review or edit the values. Ensure that the value in the Initial version field matches the version in the file content.
    4. Click Upload.
    CLIProvides the CLI command to create a new Data Contract asset with manifest.
Tip 
  • You can create a data contract without a governed asset in the data contract registry.
    Image of the data contract registry

  • You can link a governed asset to the data contract later. To do so, on the Contract Manifest tab of the Data Contract asset page, click Link asset. You need to have View permission on the Data Contract asset and a resource role with the Asset > Attribute > Add resource permission on the governed asset.

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 Asset > Attribute > Update resource permission on the Data Contract asset.

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.
  8. If you want to make the new version the active version, select the Set as active manifest version checkbox. A data contract can have multiple manifest versions. This action deactivates the current active version.
  9. If you want to generate the new version even if it already exists for the data contract, select the Force overwrite if version already exists checkbox. To check whether a manifest version already exists, Collibra considers the version number that is shown in this dialog box.
  10. Click Upload.

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 Asset > Attribute > Update resource 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, 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.

Compare two 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 two versions.
  4. In the Compare versions dialog box, in the Version field that is on the right, select the version that you want to compare with the primary version.
    Image of the Compare versions dialog box

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 Asset > Attribute > Update resource 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 set as active.
  3. Click More icon > Set as active.

  4. In the Set new active version dialog box, click Set as active.

Update knowledge graph with a data contract

You can update the Collibra knowledge graph to match your active manifest. 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.

Prerequisites

  • You have a global role with the Product Rights > Data Contract global permission.
  • You have View permission on the Data Contract asset.
  • To update 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 update relations: You have a resource role with Asset > Attribute > Add resource permission on the Data Product Port 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. If needed, set a different version as active.
  3. In the upper-right corner within the tab, click More icon > Update knowledge graph.
  4. In the Update knowledge graph dialog box, verify that the correct target governed asset and manifest version are shown, and then click Next.
  5. Review the proposed changes to SLA attributes.
  6. To accept the changes, click Update. To skip the changes, switch off the Update option, and then click Skip.
  7. Review the proposed changes to relations.
  8. To accept the changes, click Update. To skip the changes, switch off the Update option, and then click Skip.
  9. Click Done.

Check alignment between an active manifest and knowledge graph

Every 24 hours, Collibra automatically checks whether a data contract's active ODCS manifest matches the current state of the knowledge graph. It also checks the alignment immediately after you set a manifest version as active or update the knowledge graph with a data contract. You can also manually check the alignment.

Note Alignment check applies only to ODCS manifests.

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. Point to the alignment status, and then click Refresh icon (Re-check now).
    Tip You can also compare the active manifest to the knowledge graph.
    Image of the Contract Manifest tab with the Re-check now button
    A message appears after the alignment check is complete.

Compare an active manifest to knowledge graph

You can compare an active manifest to the current state of the knowledge graph, and then choose whether to update the manifest or the knowledge graph to resolve any differences.

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. Click More icon > Compare to knowledge graph.
    The Compare to knowledge graph dialog box appears, showing the active manifest and the knowledge graph side by side, along with a table listing all differences.
    Image of the Compare to knowledge graph dialog box
  3. Click Next.
  4. Verify that the targeted data contract is correct.
  5. Select one of the following options.
    OptionDescription
    Generate new manifest version

    Generates a new version of the manifest based on the latest SLA and schema metadata.

    Click Generate new version, and then complete the remaining steps.

    Update the knowledge graph

    Updates the knowledge graph based on the active manifest.

    Click Update knowledge graph, and then complete the remaining steps.

Download 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.

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.
  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