Search for Registered Assets

Last update: Edit

1 Introduction

Finding the right data to use in your app is made easier by the Data Hub Catalog search functionality. The metadata for a registered service is displayed in the Search Details screen to help in identifying the correct data source to use to use in your app development.

You can start searching from the Data Hub Home page or click the Data Hub Catalog tab to go to the Search pane and Search Details screen.

The Data Hub pane in Studio Pro enables search in the Data Hub Catalog to use and connect to registered entities from your Mendix app.

This page describes the search functionality of the Data Hub Catalog and the the information that is available.

2 Details of Registered Assets

The search details screen for a registered service, entity, or attribute displays information as provided in the published OData service contract that is used to register assets in the Data Hub Catalog. Registered services and the exposed entities can be curated to provide additional information such as Tags and Descriptions to ensure that they can be found by the appropriate users.

2.1 Published OData Service

The OData service document contains the data that is registered in the Data Hub Catalog. The contract of the published service (the $metadata document) contains the details of what is exposed in the service and further links to the metadata of the entities exposed in the service for attributes, associations, types, and accessibility. The published OData service that is registered is shown in search details.

For details on creating a published OData service in Studio Pro, see How to Register Data Assets.

2.2 Versions

Every published OData service has a version number, and apps consuming from a service will consume from a specific version. Updates and changes to a service will be indicated by a change in the version number. There may be several versions of a service available in the catalog. These will all be listed as separate items in the search results for a service.

The search details screen in the Data Hub Catalog will the version of the selected service.

2.3 Environments

The Data Hub Catalog is a register of apps that are deployed to a particular environment and the services published from the apps deployed to an environment. This means that the catalog registers the version of a service running in a specific environment.

The search results will show these service endpoints (where a service endpoint is the combination of a service version deployed on a specific environment). So if a version of a service is deployed on both a test and acceptance environment, a search on the service name in the Data Hub Catalog will have two hits.

The environment is therefore a major component of the definition and forms part of the URL for the endpoint being consumed. This, in combination with the OData version number, provides the link to the correct data for the entities that are exposed.

It is possible to filter search in the Data Hub Catalog to the following environments:

  • Production
  • Non-production
  • Mendix Free App environment

2.4 URLs

The service URLs provide the exact locations of the service documents. In turn, these define the endpoints for exposed entities and attributes and thereby access to the associated datasets by the consuming apps.

2.5 Discoverability

When a service is registered, by default it is “published” by being set to Discoverable in the Data Hub Catalog so that all users can find it and see details about it. Owners and curators of a registered service can set a service to be non-discoverable, which means that it can only be found and consumed by them and is not available to other users.

2.6 Tags

Tags help you to group services and entities and categorize them (for example, by department, process, or use). You can use tags to refine the search and filter search results in the Data Hub Catalog by doing the following:

  • Add tags to the service as a curate function in the Data Hub Catalog after a service is registered by service owners and Data Hub Curators
  • Add different tags to the different versions of the same service, as they will be two separate entries in the catalog (this is also a way to make different version identifiable)
  • Add tags to a service because they also apply to the entities exposed in the service
  • Add tags during the manual registration of OData services using the register new service form

2.7 Description

The description that is included as part of the published service metadata. This description can be further curated at the service, entity, and attribute level by Data Hub Curators to provide further details of the exposed entities and associated datasets.

2.8 Contacts for Registered Apps and Services

In the Data Hub Catalog, the search details for a service include a Technical Owner (for technical inquiries) and the Business Owner who is responsible for the data sets. Both of these owners can curate their registered assets.

3 Searching in the Data Hub Catalog

When searching in the Data Hub Catalog, the following fields are searched:

  • Service Endpoint: Name, Description, Tags
  • Application: Name
  • Entity: Name, Description
  • Attribute: Name, Description
  • Association: Name

On the Data Hub Home page, you can search in the Data Hub Catalog in the following ways:

  • Type a search term in the search box and click Search (search strings can only include the alphanumeric characters that are allowed for service names or entity names)
  • Click one of the tags given in the Search suggestions
  • Click one of the services under Most Popular Services
  • Click the Catalog tab

Any of the above actions will take you to the Search screen, which is described below.

4 Search Screen

The Search screen is divided into the Search pane, the Search Details page, and the Service Metadata panel.

4.1 Search Pane

The collapsable Search pane is used to search for registered assets in the Data Hub Catalog. A search can be refined by using filters.

4.1.1 Search Area

Enter a search term in the Search area comprising alpha-numeric characters.

4.1.2 Filters

To refine search results, you can click Add Filter:

In the Add Filters dialog box, select the Environment Type that you want to confine your search to and click Apply Filters. The search results will only display hits for the specified search string in the checked environments.

4.1.3 Search Results

The number of items satisfying the search criteria (search string plus filters) are shown at the top of the search results. Search results will include all registered services, entities, attributes, tags, and descriptions satisfying the search string and filters. Search results are listed in the following order:

  • Closest match to the search string
  • Popularity of the service (number of connections)

If no search string is specified, all registered services will be listed in the search results in the above order showing the first five entities for each service.

When an item in the search results is selected, the Catalog tab will show the Search details and the Landscape tab will show the network of connections and dependencies of the selected item in the Data Hub Landscape.

4.2 Search Details

The Search Details displays the details of the selected item in the search results.

4.2.1 Search Details for a Selected Service

When a service is selected, the full details of the service are displayed:

  • The name of the Service
  • The name of the environment to the app is deployed
  • The Version number of the service
  • The number of connections (Used in)
  • A description of the entity as given in the service metadata or curated in the Data Hub Catalog
  • Clicking Share Service will copy the link to the service to the clipboard
  • Each Entity that is exposed in the service (you can expand an entity to see details of the attributes and associations for the entity, as described below)

4.2.2 Search Details for Selected Entity

When an Entity is selected in the search results, details for the entity are displayed in the Search Details window:

  • The name of the Service
  • Part of contains a link that will take you to the Search Details of the service in which the entity is exposed
  • The **Version ** number of the service
  • The number of connections (Used in)
  • A description of the entity as given in the service metadata or curated in the Data Hub Catalog
  • Clicking Share Datasource will copy the deep link of the entity (meaning, the entity endpoint) to the clipboard
  • Entity Information

For every entity, the attributes exposed in the service are listed showing the attribute types and description.

Under the Associations tab for each entity, the associations are shown:

  • Name – the name of the association that is exposed in the service
  • Navigates to – the deep link of the entity to that the current entity is assocated with. Click to see the entity details of the associated entity.
  • Multiplicity – the type of association

4.3 Service Metadata Panel

The service metadata panel at the right of the search details page displays details of the registered service from the OData metadata files and values that have been curated in the Data Hub Catalog:

  • Classification – the classification of the data for the service; end-users of the data associated with the entities exposed in the service must have the appropriate user role to have access to the data:

    • Public – data is available to users inside and outside the company
    • Internal – data is restricted to the members of the organization
  • Discoverability – if the service is published for use by other users:

    • Discoverable – all users of Data Hub Catalog and Studio Pro can see and consume the service
    • Non-Discoverable – the service is not visible and only owners of the service, Data Hub Curators, and Data Hub Admins can find and use the service
  • Environment Type – specifies if the environment is a Production or Non-Production environment and therefore indicates the status of the dataset associated with the exposed entities

  • Application – link to the app from which the OData service was published in the given environment

  • Business Owner – links to the business owner of the data that the service connects to; this is curated in the Data Hub Catalog

  • Technical Owner – technical owner of the app; by default this is the owner who registered the service, but this can be changed in the Data Hub Catalog

  • Tags – tags that have been assigned to the service

5 Viewing Search Results in the Data Hub Landscape

When an item is selected in the search results pane, you can click the Landscape tab to see the network of connections and dependencies for the selected asset. This enables you to graphically see the context and relevance for a selected item and the data for the exposed entities.