Table of contents

Accessing trusted master data (IBM Master Data Connect)

Use the IBM® Master Data Connect service to power your business applications with trusted master data. Provide geographically distributed users and systems with fast, scalable, and concurrent access to your organization's most trusted data source.

Visual flag: Service This service is not available by default. An administrator must install this service on the IBM Cloud Pak for Data platform.

Prerequisite: Loading master data into Master Data Connect

Manager or Writer users in your organization can populate Master Data Connect with record data from your IBM InfoSphere® Master Data Management Advanced Edition or Standard Edition instance by using the IBM® MDM Publisher capability of the IBM InfoSphere Master Data Management (IBM InfoSphere MDM) offering.

With MDM Publisher, you can complete one-time bulk loads of master data into Master Data Connect or set up ongoing data synchronization. When administrators configure Master Data Connect data subscriptions in the user interface, MDM Publisher creates, runs, and manages the resulting data load jobs.
Note: IBM InfoSphere MDM Version 11.6.0.11 or above supports publishing to Master Data Connect.

Using MDM Publisher, Manager or Writer users can configure Master Data Connect on Cloud Pak for Data as a publishing endpoint, and then set up data subscriptions. MDM Publisher enables you to set up subscriptions with different data scopes for different Master Data Connect instances. This strategy provides the flexibility to target and refine your master data catalog for different applications.

For information about installing, configuring, and using MDM Publisher, see Loading data into an operational cache using IBM MDM Publisher in the IBM InfoSphere MDM Knowledge Center collection.

Tip: Manager or Writer users can also use API commands to bulk load sample data into Master Data Connect. For information about this, see the bulk operations section of the API Reference documentation.

After your organization has loaded data into the master data catalog, Reader users or systems can use the API to run text searches and queries to quickly access the master data they need. Developers can use the API to enable your organization's business applications to access the master data catalog.

Accessing the Master Data Connect service and APIs

After installing, provisioning, and setting up the Master Data Connect service, you can access its capabilities through the provided API commands. To access the Master Data Connect API:
  1. Log into the Cloud Pak for Data web client, then go to the My Instances page.
  2. Find your service instance and click the ellipsis menu. Click View details to see information about your instance.
  3. Obtain an access token (authentication bearer token):
    1. From the View Details screen, locate the Access Information section.
    2. Optionally, click the refresh icon to generate a new access token.
    3. Click the copy icon to copy the token into your clipboard.
  4. Return to the My Instances page and click the ellipsis menu of your instance. Click Open to launch the Master Data Connect API in Swagger UI. The Swagger UI API Explorer enables you to visualize and interact with the API’s resources and run API commands.
  5. In the Swagger UI, click Authorize.
  6. Paste the access token into the field at the bottom of the page, then click Authorize and Close.
  7. Use the Swagger UI API Explorer to discover and run API commands.
Tip: All of the preceding steps can also be completed using the Cloud Pak for Data and Master Data Connect APIs directly. For detailed steps about using the API to authenticate, manage users, and retrieve platform tokens and service IDs, see the Authentication section of the API Reference documentation.

Searching in your master data catalog

After a Manager or Writer user has loaded data into your master data catalog, Reader users can use the Master Data Connect API to search for records in the master data catalog. Developers can also enable your business applications as Readers to access and search for master data using the API.

For example, the following API commands are useful to run searches and queries on the master data catalog:
  • Run a full text or property query search:
    POST /mdm/cache/v0/search
  • List all master data records:
    GET /mdm/cache/v0/records
  • Get a single master data record by providing the record ID:
    GET /mdm/cache/v0/records/{id}
  • List all relationships for a given master data record by providing the record ID:
    GET /mdm/cache/v0/records/{id}/relationships
  • Run a query on the graph database:
    POST /mdm/cache/v0/traverse
    Note: For information about running traversal queries on the Master Data Connect graph database, see Querying Master Data Connect using Gremlin in the IBM InfoSphere Master Data Management Knowledge Center collection.
For more information about these and other API commands, see the Master Data Connect for Cloud Pak for Data API Reference documentation or the Swagger UI API Explorer.
Tip: Access the Master Data Connect Swagger UI API Explorer on the Cloud Pak for Data deployment in one of two ways:
  • From the Cloud Pak for Data web client, click My instances. Click the ellipsis menu of your instance, then click Open.
  • In a browser, navigate directly to MDC-INSTANCE-HOST/api-cache/explorer.

Learn more

For information about installing Master Data Connect, see Installing Master Data Connect.

For information about administering Master Data Connect, see Administering Master Data Connect.

For more information about IBM InfoSphere MDM, see the IBM InfoSphere Master Data Management V11.6 documentation.

For more information about the MDM Publisher capability, see Publishing master data using IBM MDM Publisher in the IBM InfoSphere MDM V11.6 documentation.