Skip to end of metadata
Go to start of metadata

Page Contents

View or Edit

If a Reference Dataset is associated with a governance area, then every user with a governance role in that same area will be able to view it (at least). For any other user to view or edit assets contained in a Reference Dataset, a manager must grant them permissions via the Reference Dataset's utilities > Users settings (see documentation).

Note that different workflows that process changes to a Reference Dataset can have their own permission-profile settings (for background, see Workflow Overview: Permissions for Production Collections ...).

Edits made directly in an asset collection are visible to all other collections that include it and to any workflows. In contrast, edits made as part of a workflow are only visible within the working copy managed by the workflow until and unless workflow changes are committed.

Search View

The editor's main view lists a Reference Dataset's assets as rows in a table. From here, users can perform the following kinds of operations on the assets.

  • Search for assets and display them in different ways.
  • View and edit the details of asset properties, both attributes and relationships.
  • Perform various actions on assets, either individually or in selected groups.

Searching for Assets

To control the subset of assets loaded at any given time, the light gray upper box contains various asset search criteria:

  • selection by asset type,
  • matching by free text (any property),
  • matching by specific properties, and
  • advanced search queries.

(For the maximum number of asset results: see Administration > Server Configuration: SWP Parameters > maximum number of table rows, default: 1000.)

Type selectors

Because a collection may have assets of various types or subtypes, users can select to load only assets of a particular type. Select an asset type either from the Type drop-down list or from the adjacent the Asset Type Selector button, which pops up a browsable hierarchical column listing of the collection's available asset types.

Free text search

The adjacent text field searches for assets based on matching the given text on any asset property.
Advanced searchAdvancedThe Advanced link opens a GraphQL query box. For a tutorial on GraphQL in EDG please go to the Export tab of a collection > GraphQL Queries > GraphQL in TopBraid Tutorial. For more information please go to
Property search filters

The Filters drop-down lists properties of the selected asset type. Each property filter supports various kinds of constraints for matching. Users can select multiple property filters and specify a constraint for each. Clicking the search button will load only assets whose properties match the specified filters (along with any other selection settings).


Loads a subset of assets from the collection based on the search settings for asset type, free text, and properties.
Reset Active Filters

This removes all current search settings, including any defaults (which remain saved).

Displaying Assets

There are a number of ways to present the loaded asset data.

Table columns

The Columns drop-down lists properties of the selected asset type, which can be selected to show as table columns.
Hierarchy view

The Switch to Properties Hierarchy View button replaces the table with a two-column view that displays assets hierarchically in the left column and the details of a selected asset in the right column. The hierarchy is structured according to a selected property relationship (e.g., "has broader") or its inverse. Users can revert the view by selecting either the Switch to Table View button  or the top menu's editor tab.


The Visualizations Actions button  provides a menu of various graphical diagrams for assets (e.g., NeighborGram, etc.). Some diagrams depend upon the type of asset to be viewed.
Refine filter

The Refine text field is similar to the free text search (above) except that it only affects the visibility of the loaded assets, without affecting which assets are loaded, i.e., their underlying search scope is unchanged. Loaded assets with any property matching the filter string will be visible in the table. Loaded assets without a match will be invisible.

Actions on Asset Results and Selections

Additional search actions

These actions pertain to current the search: either its results (current assets) or the search query itself. For the current asset results, users can either batch edit (cf. selected assets, below) or export them as a group. For the current search query, users can view its GraphQL text. They can also save the query for later use or open their list of previously saved queries. Managers can save the current query as the default one for all users, which will apply for everyone whenever the collection is first viewed.


This creates a new asset of a chosen type.

This opens the selected asset in a new tab to view or edit its properties.
This deletes all of the currently selected assets.
This creates a copy of the currently selected asset.
This provides options to export the select rows in a spreadsheet format. One can also print a browser page of one item's details.
Resource actions

For the selected asset, this reports on any active workflows or LineageGram, if applicable.
Additional asset actions

For the selected asset(s), this provides related actions such as adding related tasks, comments or workflows. Users can batch edit a group of selected assets of the same type (compare with additional search actions, above, which batch edits all of search the results).

Property matching

For each property, one can specify the type of match. Different properties can use different match types, all combining together to produce an overall search result.

Type of Match

How a search value matches instance property-values

text contains

Text DEFAULT: Search text is a substring of a property- value (case-insensitive). Example: Search text "lis" on a city-name property would match instances having city-name values such as "Lisbon", "Lisboa", and "Minneapolis".

text equalsSearch text is exactly the same as a property- value (case-sensitive)
text matches regular expressionSearch text is a regular expression that matches a property-value (case-insensitive). Example: Search text "^lis" as a regular expression matches city-name values that begin with "lis", e.g., "Lisbon" and "Lisboa" but not "Minneapolis". Conversely, "lis$" would match only at the name's end.
any valueAt least one value exists for the search property (count >= 1). Example: See how extensively a property is used.
min/max number of valuesThe number (count) of property-values (occurrences) is within the search range, inclusive. Example: If most instances in a Reference Dataset have labels in three languages, entering a label search with values-range 0 to 2 would return those instances with fewer.
no valueNo values exist for the search property (count = 0). Example: Use to clean up a Reference Dataset and check for remaining work.
booleanBoolean DEFAULT: Search values restricted to true/false instead of free-text
equalsClass DEFAULT: Quick-search field for finding an instance of the property (object)
nested formAdds an embedded search form for properties whose type is another class
label matches regular expressionSearch text is a regular expression that matches the label of a property-instance (object)

Searching by relationship values

As you start typing a value in a relationship field, you will get a list of autocomplete options that match the text you've typed so far—a list of the names (labels) of any entities that begin with the typed letters.

The triangle next to each relationship field displays a menu that gives you several options for how EDG uses the value you enter in that field to search your reference data. The options are similar to the ones described above with a couple of exceptions: regular expression search is not available, but there is a nested form search option:

  • nested form displays a form denoted in dark gray where you can describe specific details about the items with the specified relationship to the data you're searching for.

  • label contains indicates that you want to search for codes that have the entered string anywhere in the label value for this resource. For example, if you search market identifier codes whose mic Country property has "land" in it, EDG will return resources with values such as Thailand, The Netherlands, and Switzerland.

  • any value indicates that you want to search for codes that have any value at all for this property.

  • min/max number of values search for any code whose number of values for this property fall in the range specified by the one or two numbers you enter.

  • no value indicates that you want to search for resources that do not have a value set for this property.

Viewing and Editing Information about an Asset

Information about selected asset is shown in a form, with fields organized organized into groups. To get to the details form, double click a row or select a row and click the details button. 

Checking data quality via Problems and Suggestions

When the Show Problems and Suggestions button  at the top of the form is selected, form will display any issues that are found with the selected resource together with suggestions on how to fix them. It will also display some additional facts TopBraid EDG finds with some degree of certainty - for example it may suggest a connection between a data element and a business term. You can then accept the suggestion or ignore it. When the Show Problems and Suggestions button  is de-selected, checking of values and making suggestions will happen only when information is modified and saved or when a user decides to run Problems and Suggestions report for the entire collection. This setting acts across all of the user's collections.

Editing Information about an Asset

The default viewing mode shows only the properties of an Asset that currently have values.


Users with sufficient permissions can edit information in two ways: (1) per individual property via the pencil icon  that pops up as the cursor moves over a property; (2) all information on the form by pressing the Edit button  at the top of the page. 

Clicking a property's popup pencil icon  lets you edit "inline" values of that property. Note that inline editing is only for direct properties, not nested ones.

The Edit-button  opens all available properties for editing. Showing fields that have values and those that do not yet have values.

  click to enlarge

The Edit-button mode also lets you log a message with the saved changes. The log message is saved with the history of the change and can be seen from the change history report as a comment and also at the inline change when selecting show history in the form.

NOTE: When finished with Edit mode, be sure to click either the Save Changes or the Cancel button.

Show History

The Show History checkbox at the top of the page toggles the display of all saved changes made to the asset since it was first created. It lets you to undo or "revert" the changes back to what they were previously.


Displaying Relationships with NeighborGram and Class Diagrams

One can visually browse a resource's relationships to other resources (classes and instances) in an interactive graphical view called a NeighborGramTM. To launch this view from a resource's details pane, select the gear button  and select the Display NeighborGramTM... item. The views opens in a new browser tab.



When a resource node has many relationships, they will be shown in disjoint groups that are "pageable" via a selector with arrows and a counter. Selecting a node shows popup controls for making it the central resource, configuring links, or expanding links.

The form in the right pane shows details of the central resource. When that resource is a class, the form shows a Class Diagram section. Selecting that section link opens a nested form showing the class's associations in a UML-like diagram.

JIRA Launch-in-Context

If the JIRA LiC feature has been configured by an administrator, then for each asset collection, a manager can set an associated project-key string via Manage > JIRA Project Key (see documentation). Then, when the collection's editors are simultaneously logged into JIRA, they can launch from editor resources into related JIRA searches and new items in the collection's corresponding JIRA project. On a selected resource, use the gear button  in the details pane to select any of the following: Create JIRA Issue, Search URI on JIRA, or Search label on JIRA. The two searches will open (as browser popups) JIRA pages that search on the indicated resource string (URI or label). The create option will open the start of a new JIRA item. Note that if the browser is not logged into JIRA (or if the administered JIRA settings fail), then the launches can result in a Server Interaction Error.

  • No labels