Table of Contents
TopBraid Enterprise Data Governance (EDG)
The TopBraid Enterprise Data Governance (EDG) application environment lets users flexibly manage many kinds of vocabularies and assets. Leveraging standards-based semantic technologies, EDG enables the tailoring of governance solutions to suit the scope of enterprise technology environments and management concerns.
The User Guide
The following pages cover the concepts and functions that users access via the web-based interface.
- EDG Team Workflow and Change Management
- EDG Tagger User Guide
- EDG Vocabularies and Assets
The heart of the application are the various Vocabularies and Assets that users create and manage, each of which has views for Management and Editing. Additionally, the workflow for teams applies to all models, and Tagger with AutoClassifier is an optional component.
Navigating the EDG User Interface
In the main EDG home view, there are several functions that apply to all vocabularies and assets.
- On the home screen and manage screens of EDG, you will find a Global Lookup box to search for classes, objects, or properties in any asset within your workspace. Clicking the concept will open a new tab for editing the asset with the concept pre-selected.
- The left hand navigation menu is available on the home screen and manage screens of EDG. To minimize this menu to icons only and give yourself more screen real estate click the double arrows on the top of the menu.
- A quick navigation menu in the top left side is available throughout the EDG application. Here you can navigate directly to a particular asset.
Find Code (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 a Vocabulary or Asset in EDG
To search the EDG application for a particular vocabulary or asset based on its metadata, use EDG Home > Find Vocabulary/Asset. There are two search modes: faceted and a form-based properties. This feature becomes more useful as the number of managed vocabularies/assets grows.
The Faceted Search pane on the left lets you specify conditions for which vocabularies and assets to list in the Search Results pane on the right.
At any time, you can click on an entry in the search result to navigate to the home page of that vocabulary.
The search field at the top of the left pane let you type any search string that will be matched against the name and description text of the vocabularies. Clicking the > to the right of a property name listed in this pane displays the range of values used for this property by all the vocabularies currently managed by EDG. Selecting one will filter the search results on the right to only show those with that value for that property. Selecting additional values for any properties on the left will filter the search results to only show vocabularies that meet all of those conditions. Once a particular value has been chosen on the left, clicking the x next to it will remove it as a filter condition.
To search on a metadata property that is not displayed under Faceted Search, the drop-down Add property field lets you select another property to use.
Like the Faceted Search, the left-pane Search Form lets you specify search criteria, with the Search Results showing in the right pane. EDG vocabulary/asset 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:
text contains Search for vocabularies 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 Search for vocabularies that have this exact string in this property.
text matches regular expression Search using the regular expression entered here. 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 Search for vocabularies that have any value at all in this property.
min/max number of values Search for any vocabulary whose number of values for this property fall in the range specified by the two numbers you enter. For example, entering the values 2 and 4 for the keyword property would search for vocabularies that had more than 1 but less than 5 keywords assigned to them.
no value Search for any vocabulary that has no value set for this property.
The gear menubelow the search form gives you several options for what you can do with search results:
Export results to SPARQL CSV spreadsheet creates a comma-separated value version of the search results that includes the URI of the resource represented by each result row in the first column. See the W3C SPARQL 1.1 Query Results CSV and TSV Formats standard for more details (although there aren't many more details—it's a very simple format).
Export results to SPARQL JSON file creates a text page of results in SPARQL Query Results JSON format.
Export results to SPARQL TSV spreadsheet creates a tab-separated value version of the search results that includes the URI of the resource represented by each result row in the first column. URIs are delimited by angle brackets.
Export results to SPARQL XML file creates an XML version of the search results that conform to the W3C SPARQL Query Results XML Format.
Export results to simple TSV spreadsheet creates a tab-separated value version of the search results, showing the preferred label of each resource instead of URIs. This creates a more human-readable version of the data than the SPARQL TSV spreadsheet.
Show SPARQL query... displays a pop-up window with the query that is being generated on the server when the search form is executed. Advanced users with knowledge of the SPARQL query language can copy and paste the resulting query string into a SPARQL execution window (for example, using TopBraid Composer) or send the query to the EDG SPARQL Endpoint.
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.
Spreadsheet programs such as Excel can easily read tab-separated value files, so saving search results in a tab-separated format is a simple way to create custom reports for people with no access to this system.
This lists the tasks defined for all vocabularies and assets in EDG. Filter the list by status and/or assignee. See also: EDG Team Workflow and Change Management: Managing Tasks.
The Organizations view manages a hierarchy of organizations (e.g., departments, groups, etc.) and their members. The view has a hierarchy on the left and details of the selected organization on the right. Organizations and their members are used in configuring RACI notifications for vocabularies and assets (see the two Management operations (1) Metadata > Governance (RACI) and (2) Manage > Configure Notifications for a selected vocabulary or asset type.)
- To create organizations, in the left pane, select the parent organization (if any) then use the Create Organization... button.
- To add members to an organization , select the desired organization and Edit it. If necessary, add a new member row (using the plus '+' sign).
- For an existing member, find-and-select them using either the quick-search function (typing the name or down-arrow) in the empty row-field or use the drop-down menu at the row-end to use Select using faceted search....
- Otherwise, to create a new member, use the row-end menu item Create new. Once you have saved the organization, you can click on the new member's name and edit them to add an email address or other properties. This email will be used to send notifications if email has been enabled in the application.
- To remove a member from an organization, click the 'x' in the member's row
This allows users to document and manage software systems that use the vocabularies managed by TopBraid EDG. You can manage this component as if it's an Ontology asset. Click 'Edit Production copy' to add new software system instances. Click the + sign at the bottom of the left panel (Instances of Software System) to create new software system. You can edit the field for the system created, assign the property with the organization or people that you created in the Organizations page above. You can hit the down arrow key in the 'used by' field, it presents you five pre-defined business areas:
You can either choose from any of those or click on the small down arrow icon next to the X to create new business area as shown below.