/
Starting out using the Metadata Exchange - Overview

Starting out using the Metadata Exchange - Overview

Owned by Charlotte Reynolds
Feb 08, 2024
4 min read

The Landing Page

The Landing page is the first view of the Metadata Exchange where you will be met with some getting started and troubleshooting options shown in the figure below.

The numbers in the figure correspond to the following:

  1. Login: Allows you to login to the Exchange using your administrator-provided details

  2. Reset Password: Reset the password to your account by entering your email or username

  3. User Guide: Points you to the support documentation

  4. Service Desk: Takes you to the service desk page which points you towards FAQs and gives you the option to raise request to the service desk team

Dashboard/Control Panel

Overview

This is the page you will be directed to after logging in. You will be able to see any data models your account has access to.

The image below has the key areas of the dashboard highlighted and is described by the following:

  1. User Menu. The following describe the icons from left to right:

    1. Create a new data model 

    2. Import menu - import data models in a variety of formats

    3. Admin menu - available if you are a supervisor

    4. User menu - favourites, API key for REST calls etc,

  2. Search – defaulted to search catalogue model, but can be used to search all catalogue elements using the filter options

  3. Results list - defaulted to show all available data models

    1. Name: Data model name - click on the data model to navigate to the data model itself

    2. Data Model Type: Type of data model - either Conceptual, Logical or Physical

    3. Semantic Version: The current version of the model

    4. Status: Data model status - Draft is editable, Final is not editable

    5. Last Updated: Date of the last change to the data model

    6. Asset: View the published assets associated with a data model i.e. appendices, release notes, exports

Search

The ‘filter’ button opens the advanced search popup shown below. This allows the user to search on different Exchange objects and filter out results by status or data model etc.

For example I have chosen to search for data elements containing the word ‘date’ in all data models and the results are displayed below.

Data Model Advanced View

The advanced data model view is where you will spend most of your time editing data models.

  1. Management tools:

    1. Left: Drop-down edit menu for modifying an object in the Exchange

    2. Right: Export the current object to various formats

  2. Search: Data model search which will search on any object that is within the current data model and optionally in any of the data models which have been imported into the current one

  3. Data model navigation panel: From here you can explore the different components and structure of the data model

  4. Attributes: These are the attributes of the currently selected object which contains change-logs and other relational metadata

  5. Object header: Contains from left to right:

    1. Object name

    2. Object Id and data model version in the form <id>@<version number>

    3. Type of data model

    4. Favourite button

    5. Edit object button

    6. Get get object permalink button

  6. Object metadata: Contains various metadata

Data Model Basic View

A basic view of the data model and its components. In the above example you can see from the Highways England data model the Bollard class has been selected. The Bollard class is a parent of the Construction class which contains three data elements; each of those elements has as an associated data type.

 

Related content