Skip to end of metadata
Go to start of metadata

Page Contents

Overview of Requirements Assets

Requirements contain specifications such as data requirements, regulatory requirements and security requirements and support traceability for other EDG-managed assets.

Licensing

The availability of different collection types, including Requirements Assets 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.

Requirements Assets Home

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

Create New Requirements Collection

The Requirements Assets > Create New Requirements Collection link opens a form with fields used to define the new Requirements Collection. Note that you can also create a Requirements 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 Requirements Collection's Label (name), its Default namespace and, optionally, a Description. The default namespace will be used to construct URIs (unique identifiers) for the resources in the Requirements Collection. EDG will automatically pre-populate the default namespace based on the system-wide, configurable settings. Creator can change it. Recommended practice for all collection types is to use a '/' (slash) at the end of the default namespace. For ontologies, it is typical to use '#' (pound sign). However, '/' can be used as well. 

Creator is automatically granted Manager's permission for the new Requirements Collection. When Requirements Collection creation starts from the Governance Areas page, new Requirements Collection is automatically associated with the selected area. When Requirements Collection creation starts from the Requirements Assets home page, new Requirements Collection is not connected to any governance area. To change this after creation, update in utilities: Settings > Metadata > Edit > subject area

Create New Requirements Collection

This creates a new Requirements 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 Requirements Assets by Manage, Edit, or View

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

  • Requirements Assets that you manage
  • Requirements Assets that you can edit
  • Requirements Assets that you can view

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

This page provides a focused, permission level oriented view on Requirements Assets. 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 Requirements 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 Requirements Collection.  A manager of the Requirements 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