Skip to main content

Create custom data quality badges (CTK)

This topic explains how to add data quality badges to resources in your catalog. By default, the catalog provides three out-of-the-box badges—Good, Moderate, and Poor—to indicate data quality. If these options do not meet your needs, you can create custom badges. These badges are used in the Data Quality API.

Add a new custom data quality badge

Important

Perform this task in the Catalog Configuration organization.

To add a new custom data quality badge:

  1. On the Organization profile page, go to the Resources tab.

  2. Click the New button and select Catalog resource.

  3. On the Create a new resource page, in the Select type tab, select Status. Click the Continue to configure fields button.

    The Create a new Status page opens.

  4. In the Configure fields tab, set the following in the About section.

    1. In the Title field, provide a label for the data quality badge you want to add.

      Important

      If you change the title of the data quality badge after it is in use in the destination organizations, you must setup the IRI override to maintain seamless object visibility and functionality across all systems.

    2. From the Collections dropdown, select the Metadata profile collection.

  5. In the Configure fields tab, set the following in the More information section.

    • In the Status category field, select Data Quality Badge. A data quality badge appears on the search card and the resource page. For details, see Data quality.

    • In the Status disposition field, select from Positive, Negative, Neutral. This disposition determines the color of the badge - that is - Green (positive), Red (negative), or Yellow (neutral).

  6. Click Continue to review the status.

  7. In the Review status tab, check the configuration details for any possible errors before saving it. If adjustments are needed, click Back to edit the configuration.

  8. Click Create. The creation page is closed and you are taken to your new Status page.

Publish the changes

Retriev the IRI of the badge

Important

Perform this task in the Sandbox or Main organization.

  1. In the Sandbox or Main organization, browse to the DDW Sandbox Catalog (ddw-catalog) dataset.

  2. Click Launch workspace to open the query editor space.

  3. Run the following SPARQL query to find the IRI of the badge you just added.

    SELECT ?badgeLabel ?badgeIri ?sentiment
FROM :
WHERE {  
  ?badgeIri rdf:type kos-data-quality:Badge ;        
    rdfs:label ?badgeLabel ;        
    kos-data-quality:hasSentiment ?sentiment .
}

  4. In the Results pane, in the badgeiri column, click the arrow and uncheck the Hide IRI prefixis option.

  5. Locate the custom badge you want to use in the data Quality API and note down the IRI of the badge.

    badge_iri.png

  6. Use the custom badge IRI while setting up API for data quality.

View the results

  • The custom badge is now visible on the resource pages.

    data_quality_badge.png
In this section: