Skip to end of metadata
Go to start of metadata


Page Contents

Overview of Enumerations

An EDG Enumeration is a lightweight form of reference data or datatype, similar to a list of codes or labels. Each enumeration is a (sub-) class that has a finite (and typically small and closed) set of value instances, for example: days of the week, colors of the rainbow, states of an entity or process, or levels of a rating/ranking scale. The values can have properties such as text labels, numeric codes, ordinal values, etc. Enumerations can serve in numerous modeling contexts, such as providing pick-lists or code-lists.

Users can create enumeration collections that contain:

  1. custom enumeration classes and their values,
  2. EDG Product Enumerations with their imported values (optionally customized), or
  3. custom Property Value Selectors, which obtain their values from other collections as described below.

EDG Product Enumerations

EDG provides dozens of predefined enumeration classes, whose values can be customized per installation. Although these classes are predefined in EDG, their values are not preloaded. To load them, create or select one or more Enumeration collections and then in each one import selected EDG Product Enumerations and their values as described in: utilities > Import... > Enumerations Batch Importer . Once imported, the product values can be customized per installation.

EDG Product Enumerations should be maintained as singletons, with unique (non-duplicated) imports and value sets.

Property Value Selectors

A Property Value Selector (PVS) provides another way to specify a set of values. Using one property of a particular class, a PVS all of the corresponding (unique) values from all instances in a particular graph. (This is analogous—in relational database terms—to the set of unique (row) values from one column of a particular table.) A PVS thus determines its values indirectly: from instances of a class based on the designated property.

A typical use of a PVS would be to express permitted values on an imported data element. For example the permitted values for a country code might be the ISO 2 character or 3 character country codes from a reference dataset. In this case, the PVS's graph of instances would be a reference dataset and the PVS's class would be the dataset's main entity class.

Licensing

The availability of different collection types, including Enumerations and customer-defined types, is determined by what you have licensed and configured. The TopQuadrant website describes the TopBraid products and the  data governance packages that determine which collection types are available.

Enumerations Home

Selecting the Enumerations link in the left-navigation pane of TopBraid EDG (Home) lists all of the Enumerations Collection collections currently accessible to the user and, it allows authorized users to create new ones.

Create New Enumerations Collection

The Enumerations > Create New Enumerations Collection link opens a form with fields used to define the new Enumerations Collection. Note that you can also create a Enumerations Collection by using a Create link in the Governance Areas page. 

Nobody will have a link for creating any asset collection until an administrator configures EDG's persistence technology as documented in Server Administration: Teamwork Platform Parameters: Application data storage . Additionally, each user will not have a create link unless the user or their role has a Create permission for the EDG Repositories project as documented in  EDG Rights Management .

Note: Required and Permitted Includes

Collections often have natural relationships to other collections, e.g., a Reference Dataset references an Ontology class as its main entity. In order to do this, collection with resources to be referenced needs to be included. Some inclusions might be required while others might merely be permitted. For example, Taxonomies always include SKOS ontology and can include other taxonomies. A Reference Dataset is always required to include at least one Ontology as it is needed to define the entities in the dataset. Glossaries with always include pre-defined EDG ontology that describes business glossary terms. Catalogs of Data Assets will always include pre-defined EDG ontology describing data assets and are expected to include definitions of relevant physical Datatypes. These requirements can be further configured.

When creating a collection, any required reference to another type of collection will either be handled automatically or be presented for selection. If any required inclusion is omitted at its creation, then the resulting collection will show red warnings about the missing relationship(s). After creation, included collections can be changed using utilities view: Settings > Includes. When changing collection's includes, selection options are restricted to required and permitted types.

The Create dialog box asks for the Enumerations Collection's Label (name), an optional Description, and either a Schema or an Ontology that will define the class of enumeration instances (values). The default namespace will be used to construct URIs (unique identifiers) for the classes, properties and other resources in the ontology.

Create New Enumerations Collection

This creates a new Enumerations Collection with yourself as the manager.

If using Search the EDG with Lucene indexing (the default option), an option exists on create to add this collection to the index. This is the same as selecting it in Search the EDG configurations with the default property selectors. 


Listing of Enumerations by Manage, Edit, or View

This home view lists all Enumerations that you can access in some way. Which ones you can see and what you can do with them depend on each Enumerations Collection's permissions settings for your user identity or security role. The listing groups the Enumerations according to your assigned permissions as either a manager, an editor, or a viewer:

  • Enumerations that you manage
  • Enumerations that you can edit
  • Enumerations that you can view

You will only see relevant categories. For example, if you do not have manager permissions to any Enumerations, you will only see "Enumerations that you can edit" and "Enumerations that you can view" groupings.

This page provides a focused, permission level oriented view on Enumerations. To see a view of all asset collections, irrespective of their type, that you have a governance role for click on your User Name in the upper right corner of the page.

If a Enumerations Collection is either missing or it is lacking expected features in your views, you or your security role(s) may lack proper permissions for the Enumerations Collection.  A manager of the Enumerations Collection can give you the needed permissions via its utilities' Users settings. For background information, see Asset Collection Permissions: Viewer, Editor, and Manager.

Another possible cause of a missing feature is that it requires administrative setup to become active. See EDG Administration for relevant within-application settings and/or see other EDG Administrator Guide documents for relevant external installation and integration setup

For each collection on the home page some brief metadata is available including information about workflows available to the user. In the image below the user has an action on the workflow that they have permission for. An action means they are in a role that is allowed to transition the workflow to the next state, such as "committed". If the user does not have an action, but they have permission for the workflow they will be presented a read-only view when accessing that workflow. 

  • No labels