Managing Purview Integration
Go Up to User Menu
My Settings > Purview
Note: In order to view this page, your user account must have the proper license and permissions.The Purview Integration page allows you to manage the following areas:
- Connection. Allows you to set up the connection with Purview and test the settings.
- Property Mappings. Allows you to configure property mappings for the integration.
- Glossary. Allows you to manage the Glossary synchronization.
- Model Publishing. Allows you to publish data models from Team Server to Purview with mappings to related Business Terms.
Connection
The Purview Integration Connection page provides areas for your administrator to set up the connection with Purview . You must set up this connection before you can access any of the other Purview integration pages. After making your changes, click Apply Changes at the bottom of the page to save your updates.
Note: You can set the Purview URL to Team Server Property Name only once when applying your changes. This action creates a Managed Attribute with the same name in Purview under the ER/Studio group.
WARNING:
- Users must not mark the ER/Studio group or the property name as Expired in Purview. You also must not add any other custom attribute to this group.
- Adding any Managed Attribute with the Mark as Required option may lead to a failure scenario.
- Users should not map any base attribute created for logical or physical models on the Purview side while using the Property Mapping page on the Team Server side.
- Users cannot map Definition and Additional Notes to any text field for Business Terms as there is no option to create rich text template attributes.
- Users should not make any changes on the Logical Metamodel side as it may cause a failure while syncing the code as the metamodel creation is allowed only once.
- Users must be careful while creating the text list on the Team Server side to be mapped with Multi List or Single List in Purview as setting different options on Purview and Team Server leads to a failure scenario while syncing the data for Terms, Logical Models, and Physical Models.
- Users must be careful while marking Managed Attributes on the Purview side as Mark as Required. They must either provide default data on the Purview side or the default value on the Team Server side while creating the Managed Attribute. If the default value is not provided, Text field property names are sent as values, Boolean fields are False, and for single-list and multi-list, it is the first option.
The following areas are useful as follows:
- Purview Linking. Type the host URL and user account information used to access Purview. The Host field accepts a valid Purview URL with or without protocol or default port. Click Test to connect to the Purview REST API using the entered details. Click Apply Changes as soon as you have a successful connection.
- Note: For more information about what actions occur during the Purview REST API connection test, see Making the Connection With Purview.
- Unlink This is effectively a factory reset for the Purview integration. It works through all of the objects in Purview already linked to Team Server, and then unlinks them and vice versa for Team Server objects. It then clears all settings for the integration.
- Linking between Tools. Use these fields to create UI labels for the links between Purview and Team Server.
- Purview URL label in Team Server displays Open in Purview by default.
- Team Server URL label in Purview displays Open in Team Server by default. If you clear this field, the Team Server URL does not appear in Purview.
- Purview URL to Team Server property name displays ER/Studio URL by default.
Property Mappings
The Property Mappings page allows your administrator to set property mappings for all Purview-synchronized objects, based on asset type. Properties allow for only one mapping, so once a Team Server property is mapped to a Purview property, it no longer appears in the Team Server Property list as an available property for mapping. You can map Business Terms, Tables, Columns, Entities, and Attributes. After making your changes, click Save at the bottom of the page to apply your updates.
Note: You cannot access this page until your Purview integration settings are applied. If those settings are not applied, an error message appears. Upon clicking OK, the Settings page appears.When you attempt to map two properties, Team Server confirms that the data types of these two properties match based on the following table:
| Item | Description |
|---|---|
| Purview Data Type | Compatible Team Server Data Type |
| Date | Date |
| Multiple Selection | Text List (with Multi Select) |
| Number | Numeric |
| Selection | Text List |
| Text | Text |
| True/False | Boolean |
You can automatically map existing properties, which then create the properties of the Purview objects in Team Server and map. Click Auto Create Properties and the system attempts to map existing Team Server custom properties to all Purview properties that have no mapping. If no Team Server properties are available, new properties are created.
To manually map a Team Server Property to the displayed Purview Property, use the drop-down list to select the appropriate Team Server property for the Purview Property in this row. This list is populated with the available Custom Properties for the corresponding Team Server object. For example, only properties selected for Business Terms in the Managed Attributes page appear in the drop-down list for the Business Term Property Mappings page.
Glossary
The object of the Glossary feature is to synchronize the list of Glossary Terms in Purview with the list of Business Terms in Team Server for mapped Glossaries. This begins as a manual process as the synchronizer does not automatically create Glossaries in Team Server or Collibra. However, synchronization does become autonomous once the initial settings and preferences are provided so that the user does not have to make these same selections each time a synchronization is required. The integration currently supports only Classic glossaries but will soon support the newer Glossaries part of Business Domains.
Metamodel
Team Server and Purview have different metamodels for business terms. The relationships between terms in the two tools are as follows and have the key differences shown:
| Team Server Relationship | Purview Relationship | Notes |
|---|---|---|
| relates to | relates to | |
| synonym of | synonym of | |
| is type of | is child of | Identitying Relationsip (see Section below) |
| is attribute of | is child of | Identitying Relationsip (see Section below) |
Note: Identitying Relationsips. In Purview a term in a glossary is unique by its name AND its parent term. Thus a term "Policy" with a parent of the term "Insurance" would be different to a term "Policy" with a parent "Internal Operations". In Team Server terms in a glossary are unique by their name only. When synchronizing the two structures you will notice that changes to terms will be made to allow for the mismatch of the two metamodels. For instance, when synchronizing from Purview to Team Server in the "Policy" example you will see two terms created in Team Server "Insurance_Policy" and "Internal Operations_Policy". Options
The Options page allows an administrator to manage new Terms, Terms Properties, Term Relationships, and schedule Glossary synchronization. Select whether you want new Terms sent to Purview/Team Server upon creation as well as which system is the Master for changes to Term Properties and Relationships. Purview is the default setting for the master options. Click Apply Changes when done.
The Glossary Scheduling Status area allows an admin to set the synchronization frequency in minutes. Note that if 0 is in this field, synchronization DOES NOT occur. Use Synchronize New to trigger a synchronization immediately.
Glossary Selection
The Glossary Selection page allows an administrator to create a map that selects which Purview Glossaries are synchronized and to which Team Server Glossaries they map. Note that as you make changes to each row, the settings are applied and mapped IDs are then applied to the Team Server Glossary object. These changes are retained on the client but only saved to the server's internal database when you click Save. Click the refresh button in the upper right corner of the page to update the list of Glossaries from Purview.
To set Glossary mapping
- Use the Map to Team Server Glossary drop-down list to select the appropriate match from the Glossaries available in Team Server.
- If the Glossary does not exist in Team Server, use the add (+) button to create a new glossary object in Team Server.
- Verify that the Will be synchronized box is checked.
- Click Save.
Logical Data Models and Physical Data Models
Model publishing allows admins to publish Logical Data Models and Physical Data Models from Team Server to Purview with mappings to each other and related Business Terms. This feature provides a user with the mechanism to set up selective publishing of models to Purview, which can automatically occur as models are published to Team Server or can occur as a manual operation.
A Collection in the Domains section of Data Map must be present in Purview in order to map to a data model in ER/Studio.
For Logical Data Models, Team Server will load and subsequently synchronize objects to the Collection. These will appear in the All or Business Assets sections of the Collection. You can attach these Logical Data Model assets to Data Products in the Data Catalog to represent the design of Data Products in a business-friendly format.
For Physical Data Models, Team Server will not create or change the existing schema in Purview, but merely add business metadata such as mappings to Terms and mappings to previously loaded logical models along with properties based on which property mappings have been selected. Thus an asset must have already been scanned into Purview before you can publish physical model information.
Once a Purview Data Asset Domain is mapped to a Logical or Physical Data Model in ER/Studio, you can choose how the model is published to Purview.
Logical Data Models Options
The Options page for the Logical Data Models lets you create a metamodel in Purview. Note that you can use Create Metamodel in Purview only once. The Metamodel Status area shows whether a metamodel already exists.
Data Model Selection
The Model Selection page provides a list of Team Server Diagrams in which you can browse Models available for publishing. You can map to each Model a Domain in Purview.
Use the Update Mode drop-down list to select the publishing process mode. Options include:
- Upon Publish. Push the Model to Purview every time it is published to Team Server.
- Manual. Push the Model to Purview only when the user clicks the Publish button, and the model is selected. This option is selected by default.
Once you map the Purview domain to the ER/Studio model, click Save to store the mapping.
You can now leave the tool to perform the publish automatically, if Upon Publish is selected. Alternatively, you can manually publish the model by selecting the check box next to the model, and then clicking Publish at the top of the page.
The Last Update column displays the last status and timestamp of publication to Purview. Publication states include Published, In Progress, and Failed.
Publication logs are available from the Log Download selection in the upper right corner of the page. Download Purview Log provides a text file containing only Purview operations while Download Detailed Logs provide a text file containing the full set of Team Server and Purview logs.