Child pages
  • User Interface - Overview
Skip to end of metadata
Go to start of metadata

Page Contents


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 Asset Collections, each of which has separate pages for viewing/editing contents of the collection and utilities (operations) that users can perform on the collection as a whole such as importing data or managing access to a collection. The availability of each collection type depends on EDG licensing; see how TopBraid manages assets for details. EDG also supports user-teams' development and maintenance work through role-based workflows and features. Additionally, TopBraid Explorer and TopBraid Tagger and AutoClassifier are available as optional add-on modules. Another add-on module lets users define new, custom collection types and provides access to Data Graphs collection type.

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 +/- in the top right hand corner of the section. The screenshot below shows these sections collapsed.

EDG Home

The main home view provides access to top-level EDG searches and user-specific listings.

click image to enlarge

  1. Global Lookup: This searches across all EDG resources by label prefix (see below).
  2. Search the EDG: Application wide faceted searching across selected EDG resources (see below).
  3. Recently Viewed Collections : This widget is a personal view of the last 5 collections viewed by the user.
  4. My Tasks: This widget is a personal view of open tasks assigned to the user.
  5. My Governance Roles: This widget shows which Subject Areas a user is a member of and their Governance Role within that Subject Area.

Left Navigation Menu

The left navigation menu consists of three main sections: Dashboard, Asset Collections, and Governance Model.

  1. DASHBOARD: This section provides access to Server Administration (if the user has Administrator privileges), it also provides two overviews of the current user's work items: dashboards and workflows. It also contains links to basket with user selected items and three search tools: for particular asset collections, reference codes, and tasks. See below for details.
  2. ASSET COLLECTIONS: This section lists types of asset collections available in your EDG installation. When you click on the type such as Taxonomies, you will, as shown in the screenshot below, see all collections of this type that you have access to. These graphs contain the details of—and relationships among—various business and technical assets in the enterprise. The availability of each collection type depends on EDG licensing (see TopBraid products and data governance packages for details). The displayed page (home page for a collection type) also lets you create new collections of the selected type e.g., Taxonomies. If you do not see the Create New button, talk to your EDG Administrator. You probably have read-only access. For details of each collection type, see its documentation pages in either the page-tree (left) or the list above.
  3. GOVERNANCE MODEL: This holds the Operational Governance Model defined for your TopBraid EDG solution. It includes overall structure of the organization, subject areas, roles, and users involved in Information Governance. It also contains links to Workflow Templates installed on your EDG server. See Governance Model Overview for more information. The version number is also stored below this section



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 tab 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 the asset collection (e.g., Geography Taxonomy) is editable if you have appropriate privileges. Icon displayed directly to the left of the collection name corresponds to the collection type and will bring you to the page listing all collections of this type (aka collection-type home page).

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.

Global Lookup

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.

Left-Nav Searches

There are three specific search functions in the left-navigation menu's DASHBOARD section.

Find Asset Collection

To search the EDG application for a particular asset collection based on its metadata, use EDG 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. EDG 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:

  • text contains Finds asset collections that have the entered string anywhere in the value for this property. It will match full or partial words containing the search string. This is the default behavior of each field on the search form.

  • text equals Finds asset collections that have this exact string in this property.

  • text matches regular expression Uses the regular expression entered here to find a collection. Users will need to be familiar with the regular expression syntax. For example, while setting this field to "text contains" and entering "Virginia" would start a search that finds both "Virginia" and "West Virginia", a regular expression search for "^Virginia" would search only for values that begin with "Virginia", because ^ is used in regular expression syntax to indicate the beginning of an expression.

  • nested form When the field is a relationship, open up a nested form to describe the search criteria using the properties of the related entity.

  • any value Finds asset collections that have any value at all in this property.

  • min/max number of values Finds asset collections whose number of values for this property falls in the range specified by the two numbers you enter. For example, entering the values 2 and 4 for the  data steward  property would search for asset collections that had more than 1 but less than 5 data stewards assigned to them.

  • no value Finds asset collections that have no value set for this property.

The gear menu  below the search form gives you several options for what you can do with search results - for example, export them in different formats.

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

 

Find Tasks

This lists the tasks you have access to across all asset collections in EDG.

Tasks do not appear until enabled by an administrator (see EDG Administration: EDG Configuration Parameters).

Filter the list by status and/or assignee. See also the (Utilities) > Task View documentation for any collection type.

  click image to enlarge

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 can be done from 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:

  • refine or completely change the search terms and re-execute the search,
  • filter results via facets,
  • click on any of the result results to see more information about it,
  • make comments about any of the found resources and see comments made by other users,
  • access interactive visual views and diagrams for a found resource - what is available depends on a type of the item.


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

  • Wildcards (* ?): "?" performs a single character wildcard search and "*" performs a multiple character wildcard search. For example, te?t matches "test", "text", etc and Ken* matches all values that start with "Ken". *product* -will find anything with the word "product" in it. name -will find anything that ends in "name"

  • Fuzzy (~): Matches similar spellings of the word. For example john~, will match "john" and "jean". The similarity threshold is set to 0.5 by default. You can adjust it using any number between 0 and 1. For example, john~0.8.
  • Prohibit (-term or NOT term): excludes matches that contain the term after the "-" or "NOT" symbols. For example, Ken* -Kentucky matches all values that start with "Ken" but excludes anything that matches 'Kentucky'.
  • Modifiers (AND OR): using the AND operator will match items that contain both terms while the OR operator matches an item that contains either of the terms.
  • Range queries: using TO operator will match items with the range of values. For example, "Finland TO Germany" in curly brackets. If you want to limit this to a particular field (for example) only a label, use <property name>:{<search query>}. For example, skos_prefLabel:{Finland TO Germany}.

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.

Basket

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 (More Actions) > Add to Basket.

Selecting the left-nav DASHBOARD > Basket action shows the saved elements, allowing the user to either select or delete them.

My Workflows

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:

  • Workflow: displays the type and name of the workflow.
  • Asset: displays the asset over which the workflow was started.
  • Asset Collection: name of the asset the workflow belongs to.
  • State: current state of the workflow.
  • Creator: shows who created this workflow.
  • Started: displays the date this workflow was created.
  • Priority: shows the priority assigned to the workflow, if defined.
  • Next Actions: denotes what actions can be taken on this workflow.

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):

  • Go to Workflow: navigates to the overview page of the selected workflow.
  • Go to Asset: navigates to the asset page the workflow is associated with.

  • No labels