Sync Purview glossaries to CluedIn vocabularies

On this page

• Preparation
  • Preparation in Purview
  • Preparation in CluedIn
• Feature demonstration

In this article, you will learn how to sync Purview glossaries to CluedIn vocabularies.

Preparation

To sync glossaries from Purview to CluedIn vocabularies and vocabulary keys, complete 2 preparation steps:

1. Prepare glossary terms in Purview – create a new term template with an attribute to indicate that glossary terms can be synced to CluedIn vocabulary keys and prepare glossary terms for syncing.

2. Configure settings in CluedIn – enable the sync Purview glossaries to CluedIn vocabularies feature and provide the attribute to identify the glossary terms for syncing.

Preparation in Purview

Make sure you have the existing classic type glossary that contains some glossary terms along with child glossary terms. The child glossary terms in Purview must be assigned to the schema of the asset that is synced with CluedIn. Purview glossary terms will be synced to CluedIn vocabularies and Purview child glossary terms will be synced to CluedIn vocabulary keys.

On the following screenshot, we have the CluedIn glossary that contains 7 glossary terms. The Contact glossary term contains 2 child glossary terms: Email and FullName. In this section, you will find an instruction on how to prepare these two child glossary terms for synchronization with CluedIn.

Additionally, the glossary terms should contain an attribute to indicate that they can be synced to CluedIn vocabulary keys. The name of this attribute should be the same as in the Glossary to Vocabulary Attribute Filter field from CluedIn settings. The default value is CluedInVocab. You can create this attribute in Purview with the help of a new term template.

To create a new term template

1. In the Microsoft Purview portal, navigate to Unified Catalog > Catalog management > Classic types, and then select the glossary that contains the term you want to sync to CluedIn.

2. On the glossary terms details page, select New term.

3. Select New term template.

4. Enter the Template name.

   

5. Select New attributes.

6. Enter the Attribute name. It should be the same as in the Glossary to Vocabulary Attribute Filter field from CluedIn settings. The default value is CluedInVocab.

7. In Field type, select Boolean.

   

8. Select Apply, and then select Create.

   Now, when you create a new glossary term that you want to sync to CluedIn vocabulary key, set the attribute to True.

   

To prepare Purview child glossary terms

1. In the Microsoft Purview portal, navigate to Data Map > Domains. In your default domain, select the collection that stores the assets from Azure Data Lake Storage.

2. Select the assets card.

3. Find and select the asset that is synced with CluedIn.

4. On the asset details page, select Schema.

5. Find and select the column that should be associated with the child glossary term that you want to sync.

   

6. On the column details pane, select Edit.

   

7. In Glossary terms, find and select the child glossary term that you want to assign to the column.

   

8. Select Save.

   The child glossary term is now associated with the column.

   

9. Repeat steps 1–8 for all child glossary terms that you want to sync to CluedIn vocabularies.

Preparation in CluedIn

1. In CluedIn, go to Administration > Settings, and then scroll down to find the Purview section.

2. Turn on the toggle in Sync Purview glossaries to CluedIn glossaries.

3. You can leave the other settings for this feature at their default values.

   

4. Select Save.

Feature demonstration

Once you enable synchronization of Purview glossaries to CluedIn vocabularies, you will receive a notification when the vocabulary key is created in CluedIn. If there are matching CluedIn vocabularies, they will be updated; otherwise, new CluedIn vocabularies are created for the incoming Purview glossaries.

To find synced vocabulary keys in CluedIn

1. On the navigation pane, go to Management > Data Catalog > View All Vocabularies.

2. Find and expand the vocabulary that is named as the Purview glossary term.

   The vocabulary (a) corresponds to the glossary term in Purview. It contains vocabulary keys (b) that correspond to child glossary terms in Purview. According to default settings, the vocabulary is automatically associated with the Purview/Contact entity type, and the vocabulary key prefix is “purview”. However, you can change these settings if needed.