Using Boomi APIs To Fetch Quarantine Records Of MDH
Overview:
- Master Data Management (MDM) is a collaborative data governance process involving cooperation between business and IT departments.
- Together, they cleanse, enrich, publish, and safeguard common information entities crucial for enterprise-wide use.
- MDM enables the identification of shared data across multiple applications, creating a singular, standardized version for each application to utilize. This ensures uniformity and precision in data references throughout the entire enterprise.
MDH (Master Data Hub):
- With Master Data Hub, each source communicates exclusively with the HUB for providing or receiving updates from any other source. This substantially diminishes the necessity for numerous integration processes to uphold high-quality data across all locations.
- The Hub serves as a central traffic director for data, directing changes based on the configurations established in your model.
Repositories:
- In Boomi’s HUB Cloud, repositories are as virtual containers to securely store your confirmed and reliable data.
- Once a repository is generated, an associated cloud atom with the repository’s name appears on the integration platform.
- Each repository is provided with a distinct username and token for individualized and secure access.
- Even with multiple repositories, the URLs for accessing them will stay same that of shared web server.
Models:
- The model serves to standardize and structure data elements by identifying the essential fields.
- This identical model can be utilized across various repositories for consistent application.
- The creation of a model involves specifying data fields and sources, implementing match rules, applying conditions for data quality, defining record title formats, and assigning tags.
Metrics:
- API Management Metrics services collect the metadata of API calls through the API Gateway or the Web Services Server and allows you to retrieve the data using a GraphQL client.
- Metrics services return information such as the count of calls per API, successful API requests, popular authentication types for APIs, and the quota status of a subscribed API.
- Boomi retains metrics data for 540 days.
Golden Records:
A Golden Record is the single source of truth about a business entity such as a customer or product. It contains validated data about the entity.
Quarantine Records:
Data that is considered inaccurate, unverified, outdated, or incomplete is directed to quarantine for review by the steward. These records are known as Quarantine Records.
Use-Case: How to get the Quarantine Records of MDH by using Boomi APIs.
Practical Implementation in Boomi:
Let us see by using Boomi APIs how we can get the Quarantine Records of MDH.
Step 01: Master Data Hub is one of the services provided by Boomi, click on the Services and click on Master Data Hub.
Step 02: A new tab will open as shown below.
Step 03: Click on Stewardship and select the Quarantine.
Step 04: Here we can see the two Quarantined Records present in the Quarantine. We will be Querying these details using APIs.
Step 05: Open the Build tab, First we will create a process, click on the new component select the type as Process, and click on Create.
Step 06: We need to select Start shape with No-Data and click on OK.
Step 07: Rename the process and add a message shape.
Request Payload:
Step 08: Paste the above-mentioned Request Payload into the Message Shape.
Step 09: In order to get the Source ID from the MDH, click on the Sources as shown below.
Step 10: We can get the Source-ID for our preferred source name that is MDH01_DISK. Copy the Source-ID and paste it in the Message Shape.
Step 11: Cause value we can get it from the Quarantine Records.
Step 12: Click on the Stewardship and select the Quarantine.
Step 13: Here we can see the Cause of the Quarantine Records, but we cannot mention it directly. There are some specified value we need to assign for particular type of error.
For example: If we have “Data Quality Error” then we need to specify as “ENRICH_ERROR”. And a list of types of causes are stated below.
| Types of Causes/Errors: | VALUE: |
| Data Quality Error | ENRICH_ERROR |
| Ambiguous Match | AMBIGUOUS_MATCH |
| Duplicate Collection Key | DUPLICATE_KEY |
| Field Format Error | FIELD_FORMAT_ERROR |
| Other Incorporation Error | INCORPORATE_ERROR |
| Reference Matching Error. | MATCH_REFERENCE_UNKNOWN |
| Multiple Matches | MULTIPLE_MATCHES |
| Data Integration Error | PARSE_FAILURE |
| Potential Duplicate | POSSIBLE_DUPLICATE |
| Record Already End-dated | RECORD_ALREADY_ENDDATED |
| Unknown Reference Value | REFERENCE_UNKNOWN |
| Required Field Omitted | REQUIRED_FIELD |
| Create Approval Required | REQUIRES_APPROVAL |
| End-date Approval Required | REQUIRES_END_DATE_APPROVAL |
| Update Approval Required | REQUIRES_UPDATE_APPROVAL |
Step 14: Specify the Cause as ENRICH_ERROR in message shape and click OK.
Step 15: We will add an HTTP Client connector to our process.
Step 16: We will use the connection component, here we will not pass any values, because we will extend it. And Action as sent.
Step 17: Now we will configure the Operation component, Click on the + icon as shown above.
Step 18: Select Request and Response profile type as XML, Content-Type as text/XML, HTTP method as POST, select the check boxes Return HTTP Errors and Return HTTP Error Responses. And at last save it.
Step 19: After that attach a Stop Shape at the end.
Step 20: Save it and click on Extensions, So that we can extend the URL, Username and Password.
Step 21: In the Connection setting select the HTTP Client Connection, then select the URL, Username, and Password & click OK.
Step 22: Below is the template where we need to pass the host, port and Universe ID.
URL: <a href="https://<host>:<port>/mdm/universes/https://<host>:<port>/mdm/universes/<universeID>/quarantine/query
Step 23: We will be referring to “Test Repository”, So whenever we create a repository a cloud atom will get created in our platform.
Step 24: Click on Manage and select Atom Management to get the Cloud atom details.
Step 25: Select the Test Repository Runtime & click on the Shared web Server.
Step 26: Here we can see the Base URL path copy and paste it into the notepad.
Step 27: Click on User Management to get a Username and password.
Step 28: From here we can copy the Username and paste it in Notepad. Copy the Token and paste this also in the notepad.
Step 29: Click on the model to get the UniverseID.
Step 30: Now select the Model with the name as MDH_SRK.
Step 31: Get the Universe ID from the URL. Copy and paste it into the notepad.
Step 32: These are the copied details as shown below.
Step 33: We have added the Base URL and Universe ID in the actual URL. URL after is the final URL we are going to use.
Step 34: Click on the Test button to execute the process.
Step 35: Select the atom and click on the test Extensions to provide the URL.
Step 36: Provide the copied final URL, User name and password from the notepad & click OK to execute the process.
Step 37: The process has been executed successfully, click on the Stop Shape to check the Response Payload.
Step 38: This is the Response we have got, which consist of two records.
Step 39: Let us cross-check the Quarantine Records in the MDH.
