Creating Application Integration processes for data enrichment

Request format

Response format

Creating a process for data enrichment

1In Application Integration, create a folder within a project.
2Create a process object named System with the text field named groupId.
The following image shows a sample process object named System with the field named groupId:

3To define the payload for the request that MDM SaaS sends, create a process object named InputPayload.
• - Add the data provider fields that you want to display as input fields in Business 360 Console.
• - Add a field named sys, and reference the System process object that you created in step 2.
The following image shows a sample process object named InputPayload with two fields named Addresses and sys:

4To define payload for the response to MDM SaaS, create a process object named OutputPayload.
• - Add the data provider fields that you want to display as output fields in Business 360 Console.
• - To display the data from the data provider as recommendations, add a text field named confidenceScoreInPercent.
The following image shows a sample process object named OutputPayload with two fields named confidenceScoreInPercent and Addresses:

5To define the request structure, create a process object named InputPerRecord.
• - Add a field named payload, set its type to ObjectList, and select the InputPayload process object.
• - Add a text field named docId.
The following image shows a process object named InputPerRecord with two fields named payload and docId:

6To define the response structure, create a process object named OutputPerRecord.
• - Add a text field named docId.
• - Add a field named payload, set its type to ObjectList, and select the OutputPayload process object.
The following image shows a process object named OutputPerRecord with two fields named docId and payload:

7Create a process.
8In the Start Properties panel of the process, perform the following steps:
1. aClick the Start tab, and select Allow anonymous access.
2. bClick the Input Fields tab.
3. cSelect Whole Payload, add an input field named request, and set its type to List of InputPerRecord by selecting the InputPerRecord process object.
The following image shows the input field named request and its type as List of InputPerRecord:

4. dClick the Output Fields tab.
5. eSelect Whole Payload, add an output field named response, and set its type to List of OutputPerRecord by selecting the OutputPerRecord process object.
The following image shows the output field named response and its type as List of OutputPerRecord:

9Based on your enrichment requirements, add necessary process steps to the process.
• - Add a service connection.
• - Add steps to receive input fields from MDM SaaS and send output fields to MDM SaaS.

Guidelines for creating Application Integration processes

• •Ensure that the process is published.
• •Ensure that the process has anonymous or public access.
• •When you define input and output fields for a process, model them after the data model of the business entity instead of the data provider. This approach helps minimize issues related to field mappings in Business 360 Console. You can use assignment steps in the process to specify the desired request and response formats of the data provider.
For example, consider the following sample request format of a data provider:
{
"firstName": "string",
"lastName": "string",
"contacts": {
"address": {
"addressLineOne": "string",
"addressLineTwo": "string",
"city": "string",
"state": "string",
"country": "string"
},
"email": {
"usageType": "string",
"emailAddress": "string"
},
"phone": {
"usageType": "string",
"phoneNumber": "string"
}
}
}
Also, consider the following data model of the Person business entity:
{
"firstName": "string",
"lastName": "string",
"address": {
"addressLineOne": "string",
"addressLineTwo": "string",
"city": "string",
"state": "string",
"country": "string"
},
"email": {
"usageType": "string",
"emailAddress": "string"
},
"phone": {
"usageType": "string",
"phoneNumber": "string"
}
}

The sample data model of the business entity doesn't include a field group, such as contacts with nested field groups. In this case, model the input payload of the process after the business entity.
Consider the following sample input payload format of a process that replicates the data model of the business entity instead of the request format of the data provider:
[
{
"docId": "string",
"payload": [
{
"firstName": "string",
"lastName": "string",
"address": {
"addressLineOne": "string",
"addressLineTwo": "string",
"city": "string",
"state": "string",
"country": "string",
"sys": {
"groupId": "string"
}
},
"email": {
"usageType": "string",
"emailAddress": "string",
"sys": {
"groupId": "string"
}
},
"phone": {
"usageType": "string",
"phoneNumber": "string",
"sys": {
"groupId": "string"
}
},
"sys": {
"groupId": "string"
}
}
]
}
]

• •Ensure that the input payload includes the required fields. For more information about the required fields, see Request format.
• •Ensure that you include the sys > groupId fields at the root level of the input payload. If the payload includes field groups, include the sys > groupId fields for each field group.
• •Ensure that the output payload includes the required fields. For more information about the required fields, see Response format.
Note: The sys > groupId fields are optional in the output payload. Include the sys > groupId fields in the process object to enrich the field group entries. If the groupId value isn't available, a new field group entry is created.
• •If you want to enrich the existing entries of a field group, ensure that you include the field group as one of the input fields. For example, to enrich the existing Phone field group entries, include the Phone field group as an input field. When you configure a rule association in Business 360 Console, you can map the Phone field group of the business entity to the input field.
• •To display the data from the data provider as CLAIRE recommendations in the business applications, ensure that you include confidence scores for each recommendation when you send a response to MDM SaaS.
• •In the start properties of the process in Application Integration, ensure that you enable Whole Payload as the input and output formats.
• •Ensure that you set the Input Fields and Output Fields properties in the start properties of the process to a list of objects. For example, if you create a process named the InputPerRecord for the complete contents of the request, select the process object as a list of objects in the Input Fields property.
• •If you delete any fields from any process objects, configure the Input Fields and Output Fields properties again in the start properties. Ensure that you select the process objects in the Input Fields and Output Fields properties as a list of object.

Compatible data types of process fields and business entity fields

Creating an Application Integration process scenario

1. 1Create process objects to define input and output formats.
2. 2Create a process.

Step 1: Create process objects for input and output fields

1In Application Integration, create a folder within your project.
2Create a process object named System with a text field named groupId.
The following image shows a process object named System with a field named groupId:

3To define a set of fields that you want to accept as input fields from MDM SaaS, create a process object named InputAddress with the following fields:

Field	Label	Type
addressline1	addressline1	Text
postalcode	postalcode	Text
sys	sys	Reference Note: Reference the System process object that you created in step 2.

Note: Even though the request to AddressMaster requires a flat structure, you need a field group in this scenario because addressline1 and postalcode are child attributes of the Address field group in the Person business entity.
The following image shows a process object named InputAddress with the fields named addressline1, postalcode, and sys:

4To define a set of fields that you want to send back to MDM SaaS, create a process object named OutputAddress with the following fields:

Field	Label	Type
addressline1	addressline1	Text
addressline2	addressline2	Text
city	city	Text
state	state	Text
postalcode	postalcode	Text
country	country	Text
sys	sys	Reference Note: Reference the System process object that you created in step 2. If you include this parameter, the original field group entry is updated. Otherwise, a new field group entry is added to the record when a user accepts a CLAIRE recommendation.

The following image shows a process object named OutputAddress with the fields named addressline1, addressline2, city, state, postalcode, country, and sys:

5To define the payload for the request from MDM SaaS, create a process object named InputPayload with the following fields:

Field	Label	Type
Addresses	Addresses	ObjectList Note: Select the InputAddress process object that you created in step 3.
sys	sys	Reference Note: Reference the System process object that you created in step 2.

The following image shows a process object named InputPayload with the fields named Addresses and sys:

6To define payload for the response to MDM SaaS, create a process object named OutputPayload with the following fields:

Field	Label	Type
Addresses	Addresses	ObjectList Note: Select the OutputAddress process object that you created in step 4.
confidenceScoreInPercent	confidenceScoreInPercent	Text

The following image shows a process object named OutputPayload with the fields named confidenceScoreInPercent and Addresses:

7To define the request structure, create a process object named InputPerRecord with the following fields:

Field	Label	Type
payload	payload	ObjectList Note: Select the InputPayload process object that you created in step 5.
docId	docId	Text Note: docId is a required parameter in the response.

The following image shows a process object named InputPerRecord with the fields named payload and docId:

8To define the response structure, create a process object named OutputPerRecord with the following fields:

Field	Label	Type
docId	docId	Text
payload	payload	ObjectList Note: Select the OutputPayload process object that you created in step 6.

The following image shows a process object named OutputPerRecord with the fields named docId and payload:

Step 2: Create a process

1In Application Integration, create a process.
2In the Start Properties panel of the process, perform the following steps:
1. aClick the Start tab, and select Allow anonymous access.
2. bClick the Input Fields tab.
3. cSelect Whole Payload, add an input field named request, and set its type to List of InputPerRecord by selecting the InputPerRecord process object.
The following image shows the input field named request and its type as List of InputPerRecord:

4. dClick the Output Fields tab.
5. eSelect Whole Payload, and add an output field named response and set its type to List of OutputPerRecord by selecting the OutputPerRecord process object.
The following image shows the output field named response and its type as List of OutputPerRecord:

3Create a temp field named temp_recordId, and set its type to Text.
4Add an assignment step to the process.
5In the Properties panel of the assignment step, click the Assignment tab, and set the temp_recordId field to the $input.request[1]/docId formula.
Note: Additionally, you can create a process object that represents the request to the data provider. You can then assign the process input fields to the AddressMaster request fields. This sample process doesn't connect to a real data provider.
The following image shows that the $input.request[1]/docId formula is assigned to the temp_recordId field:

6Add an assignment step to the process.
7In the Properties panel of the assignment step, click the Assignment tab and perform the following assignment tasks:
1. aAdd a field named response.
2. bIn the Assigned Using field, select Formula.
3. cAdd the response that you want to send to MDM SaaS, such as the following sample response:
let $items :=
<Items>
<Item>
<Id>IN|LP|A|19635268|_ENG</Id>
<Type>Address</Type>
<Line1>Prakash 1;</Line1>
<Line2>Prakash Building 1 BG Kher Road</Line2>
<City></City>
<State></State>
<Country>United Kingdon</Country>
<PostCode></PostCode>
<Highlight>8-9,27-28,29-31;</Highlight>
<Description>Mumbai 400006</Description>
</Item>
<Item>
<Id>IN|LP|A|19637698|_ENG</Id>
<Type>Address</Type>
<Line1>Building 1;</Line1>
<Line2>BG Kher Road</Line2>
<City></City>
<State></State>
<Country>United Kingdon</Country>
<PostCode></PostCode>
<Highlight>8-9,27-28,29-31;</Highlight>
<Description>Mumbai 400006</Description>
</Item>
</Items>

return (
<OutputPerRecord>
<docId> {$temp.temp_recordId }</docId>
{
for $item in $items/Item
return (
<payload>
<confidenceScoreInPercent>70</confidenceScoreInPercent>
<Addresses>
<id>{$item/Id/text() }</id>
<addressline1>{$item/Line1/text()}</addressline1>
<addressline2>{$item/Line2/text()}</addressline2>
<city>{$item/City/text()}</city>
<state>{$item/State/text()}</state>
<postalcode>{$item/PostCode/text()}</postalcode>
<country>{$item/Country/text()}</country>
<sys>
<groupId> { $input.request[1]/payload[1]/Addresses[1]/sys[1]/groupId }</groupId>
</sys>
</Addresses>
</payload>
)
}
</OutputPerRecord>
)
$items represents a sample response from AddressMaster. In the return block, you can loop through the fields in the AddressMaster response and assign the required fields to the fields in the OutputPayload process object.
The following image shows that the response variable is assigned to a formula: