Use Case
This use case describes how to get results from CDQ services in your data model by using the Transformation API.
Learning Goals
In this tutorial, the user will focus on:
- Creating Data Transformation Definitions
- Creating Data Transformation Configuration
- Attaching Data Transformation Configuration to the API KEY
- Using the Transformation API to transform results into your data model
Data Transformation Definition needs to be created in the same workspace where the Data Monitor was created.
Elements of the DTD you can provide:
| Element | Description |
|---|---|
name | Name of your DTD |
type | BUSINESS_PARTNER, UPDATED_BUSINESS_PARTNER, BANK_ACCOUNT. |
direction | Direction of the Data Transformation Definition - INBOUND (from customer to CDQ model)(default) or OUTBOUND (from CDQ to customer model). |
imports | Takes mappings from another, already created DTD, without the need to include these elements in the mapping. |
mappings | Declares what and how should be mapped from the input to the output structure. |
reverseMappings | Declares what and how should be mapped from the output to the input structure. |
valueMappings | Change values from input to output based on a defined rule. |
values | Defines allowed values for provided attributes. |
To create a Data Transformation Definition:
- Use the Data Transformation Definition endpoint,
The Create Data Transformation Definition example is set by default.
- Provide the required fields in the body.
Adjust your DTD to your needs. Most common issues were explained in the instruction: How to Define and Use Data Transformation Definitions (DTD) in CDQ Cloud Apps
To use the created Data Transformation Definition, you need to create a Data Transformation Configuration in the same workspace where the Data Monitor was created.
To create a Data Transformation Configuration:
- Go to the Data Transformation Configurator app.
- Click the Create New Configuration button.
- Fill in the Configuration name and click Create button.
- Search the newly created configuration and click the See Details button.
- In the details of the configuration, set the required parameters:
- Set the required value in the Business Partner field.
- Set the required value in the Updated Business Partner field.
 |
To use the created Data Transformation Configuration, you need to attach it to the API Key in the same workspace where the Data Monitor was created.
To attach the configurations to your API Key:
- Go to the API Key Management app.
- Click the See Details button of the earlier created API Key.
- Find the Data Transformation Configuration section and assign the created configuration.
- Click the Save changes button.
 |
You are ready to get results by using the Transformation API.
CDQ applies special logic to endpoints and APIs based on the attached API key. The Data Transformation Configuration returns a response or allows you to provide the input elements in the customer data model.
Dedicated endpoints supporting transformation:
- Fetch Business Partner
- Curate Business Partner
- Read Augmented Business Partner
- List Business Partner Updates
- Confirm Business Partner
Dedicated APIs supporting transformation:
To transform the response from CDQ services into the required model, use the API Key with the attached Data Transformation Configuration.
Any JSON file can be transformed with the Transform JSON endpoint.
To transform JSON with an existing DTD:
- Use the Transform JSON endpoint,
- Fill the empty JSON input.
You can transform any JSON with the provided DTD and quick adjustments.
To transform JSON with DTD:
- Use the Transform JSON with Data Transformation Definition endpoint,
- Provide the required fields in the body.
We are constantly working on providing an outstanding user experience with our products. Please share your opinion about this tutorial!