Enterprise Data Governance (EDG)
TopBraid Enterprise Data Governance (EDG) application lets organizations tailor their governance solutions to suit their enterprise technology environments and management concerns. Leveraging standards-based semantic technologies, EDG enables users to manage many kinds of business and technical assets with the flexibility to customize, extend, or integrate the solutions as needed. TopBraid EDG offers comprehensive, modular Data Governance capabilities. It is available in different governance packages that together let users work with wide range of business and technical assets.
The EDG User Guide
The following pages cover the concepts and functions that users access via the web-based interface.
Users create and manage various
The EDG User Interface (UI)
Many EDG views are oriented toward a particular type of asset collection, such as taxonomy, ontology, data asset collection, etc. Every view has a header that provides breadcrumb navigation, global lookup, and special application links. There is also a collapsible left-navigation menu that provides direct links to all of the asset collection types and to other top-level functions and views. The entire left-navigation menu can be toggled down to icons via the left-arrow at the top, and the main menu sections can be expanded/collapsed by selecting the +/-
The main home view provides access to top-level EDG searches and user-specific listings.
Left Navigation Menu
The left navigation bar has three main sections: Dashboard, Asset Collections, and Governance Model.
Asset Collection Home
When you click on the name of an asset collection e.g., Geography Taxonomy, you will see a page that lets you view and edit its content. The horizontal menu bar on top of the page gives you access to the editing application for the collection type (first tab) and to various operations you can perform on the collection accessed by clicking on other tabs.
The name of the first tab varies depending on the type of selected collection e.g., Taxonomy if you selected a Taxonomy, Codes if you selected a Reference Dataset, Mappings if you selected a Crosswalk.
Other tabs are uniform across all collection types. However, items you will see on each tab may vary. Further, your access privileges for a collection also impact the tabs you see. For example, only users with Manager privileges for a collection will see Manage tab.
As an example, a screenshot below shows what you may see if you clicked on a Taxonomy and navigated to one of its items.
The name of an asset collection (e.g., Geography Taxonomy) is editable if you have appropriate privileges. Icon displayed directly to the left of the collection's name corresponds to the collection's type and will bring you to the page listing all collections of this type (aka collection-type home page).
To understand all the functions available to you on each of the tabs in the horizontal menu, go to the Asset Collections section of the guide and select the type of collection you are interested in. This information is organized in two subsections:
Many of the features are the same across collection types, providing you with a consistent user experience, but there are some differences as well.
Additional UI Controls
1. "Hamburger menu" : The header's three-bar "hamburger" icon drops down a quick-navigation menu for direct access to any asset collection you have access to.
2. Toggle left-nav labels: The left/right arrow atop the left-navigation menu toggles the text labels off/on, trading them for screen real estate.
3. Special links: The right-header has links to the user's page, and help documentation.
Searching Across TopBraid EDG
You can search within each asset collection. You can also search across all collections.
A Global Lookup text box In the page header lets you find assets (resources) across all asset collections in EDG by entering their name. This is an auto-complete look up field. As you type, any resource whose label is prefixed by the search text will appear in a popup list. Label and Preferred label with a language tag in the current browser's language or with no language tag will be matched against the entered string.
Selecting a listed resource displays form with its information in a new browser tab - in the context of the collection where it is defined.
There are three specific search functions in the left-navigation menu's DASHBOARD section.
Find Asset Collection
To search the $ProductAbbrevName application for a particular asset collection based on its metadata, use $ProductAbbrevName Home > Find Asset Collection. This feature becomes more useful as the number of managed asset collections grows.
The left Filter pane of the search form lets you specify search criteria, with the Search Results showing in the right pane. $ProductAbbrevName top-level asset collection form-searches work similarly to form searches in editors, but properties are not shown as columns in the results. Click the Reset button at the bottom of the search form to remove all search criteria entered on the form. Enter a value in the Search any Text property at the top to indicate that you want to search all the metadata properties for that particular text. This includes a checkbox to control whether the search is case-sensitive. Clicking the white triangle on the right of any property gives you greater control over how the value entered there is used in the search. The following options may appear on this menu, depending on the nature of the data stored in the property you are using in your search criteria:
The gear menu
Exported search results will be displayed in your browser. Select Save As from your browser's File menu to save the results as a text file.
Find Code (for Reference Datasets)
To search for a code across all reference datasets, the EDG Home > Find Code search provides a simple concept identifier lookup. In the Search for Code pane, enter the code of the desired concept and click Search. EDG searches across all managed datasets and shows the found concepts in the Search Results pane. Clicking on a result shows the concept's properties in the right pane, whose title changes from Selected Item to the label and (concept type).
This lists the tasks you have access to across all asset collections in $ProductAbbrevName.
Tasks do not appear until enabled by an administrator (see $ProductAbbrevName Administration: $ProductAbbrevName Configuration Parameters).
Filter the list by status and/or assignee. See also the (Utilities) > Task View documentation for any collection type.
Search the EDG
This searches across all EDG resources that EDG administrator and/or manager of a specific collection elected to include in the index. This decision can be done from made upon creation of a collection and can also be made later on the Manage tab of the collection or upon creation of the collection.
Submitting a search from the home page opens a page with the search results summary. Your search key words will be matched against text in any of the fields that have been configured for searching. You may have fields that contain text tagged with different languages, note that search will be performed across all values, irrespective of the language. In the search results page, you can:
Note that what information is presented in the search summary and detail views, along with the properties and facets, is no longer configurable via an administrative UI in EDG version 6.0. By default, the results are configured to include more information, the summary and detail views will only contain labels of the found items and what asset collection they belong to. In order to customize this screens, please see the developer guide to create your own extension or contact a TopQuadrant representative for a custom extension. All properties of the collection will be indexed for search as well as applicable facets.
The results of search are sorted by score, then alphabetically. The score is calculated based on the number of matches to the term within the document. Lucene also offers query boosting per field.
For example searching:
*id^3 -will find anything that ends in "id" and assign it a weight of 3, boosting those results
Lucene integration and query language
Search the EDG uses Apache Lucene for indexing text. The index is (re)built on system startup and then in intervals set by a configuration setting. To rebuild the cache on demand, use the Cached Graphs administration page. In addition to simply using search keywords, users can combine them with Lucene operators to form richer search queries. By default wildcard search has been implemented before and after the search term. For example, searching for customer actually searches *customer*.
Example Lucene Operators
EDG administrators can disable the indexing via the Disable Lucene Indexing parameter. Disabling the index reverts to using SPARQL queries and will cause poor performance for large or numerous collections. The full range of Lucene syntax is only available when the index is active, otherwise only partial value matching is supported. Note, this will also disable the text index search used for tabular editors.
User's Work Items
The Home page shows user-specific listings for workflows with pending actions, open tasks, and recently viewed collections.
Each user can maintain a basket, which is a personal list of favorite ("bookmarked") asset collections or asset items. To add (or remove) a collection, select it and then select (or deselect) its star icon in the collection's header, for example:
To add an asset item, select it in the collection's editor and then select the "..." button
Selecting the left-nav DASHBOARD > Basket action shows the saved elements, allowing the user to either select or delete them.
This lists the workflows for which the current user has potential status-transition actions pending. (For an overview of workflows, see Governance Model > Workflows.) The workflows are listed in a table showing the following information for each:
The following operations can be performed, some require a that a workflow is selected (users can select a workflow from the list by clicking on it):