EDG User Interface Overview

 

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

 

EDG Home

The main home view provides access to top-level EDG searches and other personalized widgets. See below for customizing the EDG landing page. 

  1. Create New: Initiates creating a new EDG collection. (see more below)
  2. Global Lookup: This searches across all EDG resources by label prefix. (see more below)
  3. Workflow summary: Shortcut to the logged on users open workflows.
  4. My Tasks: This widget is a personal view of open tasks assigned to the user.
  5. What’s Happening: Lists important actions of users in the EDG system.
  6. Search the EDG: Application wide faceted searching across selected EDG resources. (see more below)
  7. Recently Viewed Collections : This widget is a personal view of the last 5 collections viewed by the user.
  8. My Governance Roles: This widget shows which Subject Areas a user is a member of and their Governance Role within that Subject Area.
  9. Asset Collection Summary: Counts of each Collection in the EDG system. Users actual count may differ depending on permission to collections.
  10. Left navigation menu: Collapse by clicking the arrow at the top. (see more below)
  11. System Announcements: Announcements can be set by Administrators. (see more below)

Left Navigation Menu

The left navigation bar has 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. As mentioned above, the availability of each collection type depends on EDG licensing (see this page for details). When you click on a collection-type link EDG will display a page (home page for a collection type) that lists all collections on selected type and lets you create new collections e.g., as shown below, 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 Asset Collection Guide for more information. The version number is also stored below this section.

Collection Type Pages

Clicking on a type of collection in the left navigation will bring you to the page listing all the asset collections of that type. The table here can be sorted and filtered.

 This page can also be accessed from the Asset Collection Home pages by clicking in the header on the icon located directly to the left of the name of a collection.

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 aka editor. The horizontal menu bar on top of the page gives you access to various operations and configurations you can perform for the collection as a whole.

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. This is the tab that gives you access to the editor application.

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

In addition to searching within each asset collection, EDG also lets you search across all collections. Options are detailed below.

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.

 

Search the EDG

Available from the home page, this searches across all EDG resources that EDG administrator and/or manager of a specific collection elected to include in the index. More details for Search the EDG can be found in the User Guide:Search the EDG.

Left-Nav Searches

There are two search functions in the left-navigation menu‘s DASHBOARD section, Find Code and Find Tasks. More details for these can be found in the User Guide.

Create New Collections

To create a new asset collection such as taxonomy, you can use the plus icon in the EDG application header bar or navigate to the type of collection you want to create and use the button at the top of the page. A system administrator or any user with editor access profile for the Governance Model can also create a new collection by using a Create link in the Governance areas page. This will automatically place a collection into the chosen subject area and assign the user permissions for that subject area. See Governance Model for more information on this feature.

Note: Nobody will have a link for creating any asset collection until an administrator configures EDG’s persistence technology as documented in Server Administration . Additionally, a user will not have the ability to create asset collections unless the user or their role has a Create permission for the EDG Repositories project as documented in  EDG Rights Management .

 

The Create dialog box options are as follows:

  • Label: Required.
  • Default namespace: Required for all asset collections except Crosswalks and Content Tagsets where it is not available
  • Description: Optional
  • Search the EDG: Optional. Check this option if you want this collection to be included in the globally available “Search the EDG” feature of the application.
  • URI rules:Optional, not available forCrosswalks and Content Tagsets. URI construction rules for assets in a collection can be set in the server administration area as described in the EDG Configuration Parameters section of Server Administration guide. If you want to override server-wide settings for a specific collection, make your selections here. The rules will not apply if an asset type has a primary key. Then, URIs will be based on a value of a primary key.
  • Data Platform: If data platform is enabled for your organization and not selected as the default then you can opt to include the collection in data platform to be replicated across all servers. This option cannot be added or changed later.
  • Ontology include: Required and is available only for Data Graphs and Reference Datasets. Used to specify an Ontology that defines data model for a collection.
  • Data source: This option will be available if you are creating a Corpus. It lets you select a connector to use for harvesting documents.
  • From Graph and To Graph: Required and is available only for Crosswalks. Identifies asset collections that will be connected by a Crosswalk.
  • From Entity Type and To Entity Type: Required and is available only for Crosswalks. Identifies the type of asset to be connected by a Crosswalk. Will appear when from and to graphs are selected.
  • From Graph and To Graph: Required and is available only for Crosswalks. Identifies asset collections that will be connected by a Crosswalk.
  • Content Graph and Tagging Vocabulary: Required and is available only for Content Tagsets. Identifies an asset collection containing content to be tagged and an asset collection containing tagging vocabulary – Taxonomy or Ontology.

The user creating the new collection will be assigned as the manager of that collection.

For Reference Datasets and Data Graphs additional setup will be needed after creation. Users will need to identify a main entity. Main entity is an asset type for assets that will be contained in a collection.

For Content Tagsets the Create page is a two step wizard. After making selections on the first page, users will be asked to make additional selections on the second page.

Announcements

The default installation of EDG will have a prebuilt welcome banner and announcement on the home page. These can be modified and controlled through the Governance model.

Navigate to Governance model, other governance assets tab at the top.

Select the “TopBraid Enterprise Data Governance” resource to bring up the form for the current default announcment.

Here you can add new announcements along the order of display and start and stop dates.  Select New button from the Governance Viewpoint Search panel. Then edit the description and other properties.

 Change the welcome banner by selecting this resource and the editing the text in the form:

Customizing the EDG home page

The landing page for EDG can be customized per EDG instances by an administrator or per user.

Administrators can turn off or on widgets through Server Admininstration -> EDG Configuration page. These settings apply to all users.

Users can apply the same settings through their user page. Note: anything turned off by an administrator cannot be turned on by a user.

To customize the EDG logo and other personalization see the developer guide