RCG Customers Process API - Implementation Template

(0 reviews)

Data mappings

This document provides information generated from the DataWeave scripts included in the project, such as function definitions, variable definitions, and data mapping tables.

ModuleDescription
customer-date-sync-responseCustomer Sync Success Response
customer-sync-retrieve-by-last-modified-date
get-customer-ordersGet Orders of a Customer Mapping
get-list-of-customers-response
map-b2c-customer-update-requestCustomer Update Mapping for B2C Commerce
map-customer-contact-points
map-customer-create-requestCustomer Create Mapping for a System (B2C,Salesforce,SAP,HANA,OFBiz)
map-erp-prc-requestCustomer Mapping for ERP Systems (SAP ECC, HANA)
map-new-contact-points
map-ofbiz-customer-create-requestCustomer Create Mapping for OFBiz
map-ofbiz-customer-update-requestCustomer Update Mapping for OFBiz
map-salesforce-customer-create-requestCustomer Create Mapping for Salesforce
map-salesforce-customer-update-requestCustomer Update Mapping for Salesforce
map-salesforce-individual-create-requestContacts Create Mapping for Salesforce
map-salesforce-individual-update-requestContacts Update Mapping for Salesforce
map-subscriber-contact-points
map-subscriber-create-requestIndividual/Subscriber Creation Mapping for Salesforce Marketing
map-subscriber-update-requestIndividual/Subscriber Update Mapping for Salesforce Marketing
map-updated-contact-points
ping-check-dependency-sys-api-responsePing Status Response of the backend System API's
ping-response-payloadPing Status Response of the API
retrieve-customers-queryParams-request-mapping
update-external-id-objectupdate external Id using update operator

customer-date-sync-response

Customer Sync Success Response

Source: ./src/main/resources/dwl/customer-date-sync-response.dwl

(back to top)

customer-sync-retrieve-by-last-modified-date

Source: ./src/main/resources/dwl/customer-sync-retrieve-by-last-modified-date.dwl

(back to top)

get-customer-orders

Get Orders of a Customer Mapping

Source: ./src/main/resources/dwl/get-customer-orders.dwl

Mapping Tables

Maps Orders of a Customer from OMS System API as in CIM format.

OMSCustomerDescription
orderIdidThe Order Id for an Order as in OMS
orderNumberorderNumberOrder Number for an Order
filedDatefiledDateFiled Date of the the Order
promiseDatepromiseFulfillmentDateFulfillment Date for the Order
orderStartDateorderStartDateStart Date for the Order
orderEndDateorderEndDateEnd Date for the Order
customerIdsoldToCustomerCustomer associated with the Order
originalOrderIdoriginalOrderOriginalId of the Order
orderTypesalesOrderType.nameOrder Type of the Order
orderStatussalesOrderStatus.nameStatus of the order

(back to top)

get-list-of-customers-response

Source: ./src/main/resources/dwl/get-list-of-customers-response.dwl

(back to top)

map-b2c-customer-update-request

Customer Update Mapping for B2C Commerce

Source: ./src/main/resources/dwl/map-b2c-customer-update-request.dwl

Mapping Tables

Maps customer profiles of SourceSystems (SAP or Salesforce) to MDM in CIM format which is further used for creation of Customer in B2C Commerce. The object structure is same with only exception of GlobalPartyRoleId being sent as an ExternalId to be stored in B2C Commerce to uniquely identify the customer.

MDMB2C CommerceDescription
ididThe id will be GlobalPartyRoleId for updating an existing customer
partyRoleTypepartyRoleTypeThe type of party role - default as Customer
party.idnullThe id of the Party
party.partyTypeIndividualThe type of Party
party.personNamefirstName lastNameThe full name of the Party
party.firstNamefirstNameThe first name of the Party
party.lastNamelastNameThe last name of the Party
party.externalIdsexternalIdsThe GlobalPartyId of Customer as in MDM.This will not be stored in B2C Commerce
customerNumbercustomerNumberThe Customer Number to be stored in B2C Commerce
customerStatuscustomerStatusThe Status of Customer to be updated in B2C Commerce
externalIdsexternalIdsThe GlobalPartyRoleId of Customer as in MDM that will need to be stored in B2C Commerce

(back to top)

map-customer-contact-points

Source: ./src/main/resources/dwl/map-customer-contact-points.dwl

(back to top)

map-customer-create-request

Customer Create Mapping for a System (B2C,Salesforce,SAP,HANA,OFBiz)

Source: ./src/main/resources/dwl/map-customer-create-request.dwl

Mapping Tables

Maps customer profiles of SourceSystem to MDM in CIM format which is further used for creation of Customer in other systems (B2C,Salesforce,SAP,HANA,OFBiz).The object structure is same with only exception of GlobalPartyRoleId being sent as an ExternalId with ExternalIdType as MDM. This Id will be stored in SAP ECC to uniquely identify the customer.

MDMSystemDescription
ididThe id will be null for creating a new Customer in a System
partyRoleTypepartyRoleTypeThe type of party role - usually Customer
partypartyThe Party
externalIdsexternalIdsThe GlobalPartyRoleId of Customer as in MDM that will need to be stored in SAP ECC
customerNumbercustomerNumberThe Customer Number to be stored in a System
customerStatuscustomerStatusThe Status of Customer to be updated in a System

(back to top)

map-erp-prc-request

Customer Mapping for ERP Systems (SAP ECC, HANA)

Source: ./src/main/resources/dwl/map-erp-prc-request.dwl

Mapping Tables

Maps customer profiles of SourceSystems (B2C,Salesforce,ERP Systems -SAP ECC, HANA) to MDM in CIM format which is further used for creation of Customer in B2C Commerce. The object structure is same with only exception of GlobalPartyRoleId being sent as an ExternalId to be stored in ERP Systems(SAPECC,HANA) to uniquely identify the customer.

MDMERP SystemsDescription
ididThe id will be GlobalPartyRoleId for updating an existing customer
partyRoleTypepartyRoleTypeThe type of party role - default as Customer
party.idnullThe id of the Party
party.partyTypePartyThe type of party
party.personNamefirstName lastNameThe full name of the Party
party.firstNamefirstNameThe first name of the Party
party.lastNamelastNameThe last name of the Party
party.externalIdsexternalIdsThe GlobalPartyId of Customer as in MDM.This will not be stored in ERP Systems
customerNumbercustomerNumberThe Customer Number to be stored in ERP Systems
customerStatuscustomerStatusThe Status of Customer to be updated in ERP Systems
externalIdsexternalIdsThe GlobalPartyRoleId of Customer as in MDM that will need to be stored in ERP Systems

(back to top)

map-new-contact-points

Source: ./src/main/resources/dwl/map-new-contact-points.dwl

(back to top)

map-ofbiz-customer-create-request

Customer Create Mapping for OFBiz

Source: ./src/main/resources/dwl/map-ofbiz-customer-create-request.dwl

Mapping Tables

Maps customer profiles of SourceSystem (SAP or B2C Commerce) to MDM in CIM format which is further used for creation of Customer in OFBiz.The object structure is same with only exception of GlobalPartyRoleId being sent as an ExternalId with ExternalIdType as MDM. This Id will be stored in OFBiz to uniquely identify the customer.

MDMOFBizDescription
ididThe id will be null for creating a new Customer in OFBiz
partyRoleTypepartyRoleTypeThe type of party role - usually Customer
partypartyThe Party
externalIdsexternalIdsThe GlobalPartyRoleId of Customer as in MDM that will need to be stored in OFBiz
customerNumbercustomerNumberThe Customer Number to be stored in OFBiz
customerStatuscustomerStatusThe Status of Customer to be updated in OFBiz

(back to top)

map-ofbiz-customer-update-request

Customer Update Mapping for OFBiz

Source: ./src/main/resources/dwl/map-ofbiz-customer-update-request.dwl

Mapping Tables

Maps customer profiles of SourceSystem (SAP or B2C Commerce) to MDM in CIM format which is further used for creation of Customer in OFBiz. The object structure is same with only exception of GlobalPartyRoleId being sent as an ExternalId with ExternalIdType as MDM. This Id will be stored in OFBiz to uniquely identify the customer.

MDMOFBizDescription
ididThe id will be GlobalPartyRoleId to update an existing Customer in OFBiz
partyRoleTypepartyRoleTypeThe type of party role - usually Customer
party.idnullThe id of the Party
party.partyTypePartyThe type of Party
party.personNamefirstName lastNameThe full name of the Party
party.firstNamefirstNameThe first name of the Party
party.lastNamelastNameThe last name of the Party
party.externalIdsexternalIdsThe GlobalPartyId of Customer as in MDM.This will not be stored in OFBiz
externalIdsexternalIdsThe GlobalPartyRoleId of Customer as in MDM that will need to be stored in OFBiz
customerNumbercustomerNumberThe Customer Number to be stored in OFBiz
customerStatuscustomerStatusThe Status of Customer to be updated in OFBiz

(back to top)

map-salesforce-customer-create-request

Customer Create Mapping for Salesforce

Source: ./src/main/resources/dwl/map-salesforce-customer-create-request.dwl

Mapping Tables

Maps customer profiles of SourceSystem (SAP or B2C Commerce) to MDM in CIM format which is further used for creation of Customer in Salesforce.The object structure is same with only exception of GlobalPartyRoleId being sent as an ExternalId with ExternalIdType as MDM. This Id will be stored in Salesforce to uniquely identify the customer.

MDMSalesforceDescription
ididThe id will be null for creating a new Customer in Salesforce
partyRoleTypepartyRoleTypeThe type of party role - usually Customer
partypartyThe Party
externalIdsexternalIdsThe GlobalPartyRoleId of Customer as in MDM that will need to be stored in Salesforce
customerNumbercustomerNumberThe Customer Number to be stored in Salesforce
customerStatuscustomerStatusThe Status of Customer to be updated in Salesforce

(back to top)

map-salesforce-customer-update-request

Customer Update Mapping for Salesforce

Source: ./src/main/resources/dwl/map-salesforce-customer-update-request.dwl

Mapping Tables

Maps customer profiles of SourceSystem (SAP or B2C Commerce) to MDM in CIM format which is further used for creation of Customer in Salesforce. The object structure is same with only exception of GlobalPartyRoleId being sent as an ExternalId with ExternalIdType as MDM. This Id will be stored in Salesforce to uniquely identify the customer.

MDMSalesforceDescription
ididThe id will be GlobalPartyRoleId to update an existing Customer in Salesforce
partyRoleTypepartyRoleTypeThe type of party role - usually Customer
party.idnullThe id of the Party
party.partyTypePartyThe type of Party
party.personNamefirstName lastNameThe full name of the Party
party.firstNamefirstNameThe first name of the Party
party.lastNamelastNameThe last name of the Party
party.externalIdsexternalIdsThe GlobalPartyId of Customer as in MDM.This will not be stored in Salesforce
externalIdsexternalIdsThe GlobalPartyRoleId of Customer as in MDM that will need to be stored in Salesforce
customerNumbercustomerNumberThe Customer Number to be stored in Salesforce
customerStatuscustomerStatusThe Status of Customer to be updated in Salesforce

(back to top)

map-salesforce-individual-create-request

Contacts Create Mapping for Salesforce

Source: ./src/main/resources/dwl/map-salesforce-individual-create-request.dwl

(back to top)

map-salesforce-individual-update-request

Contacts Update Mapping for Salesforce

Source: ./src/main/resources/dwl/map-salesforce-individual-update-request.dwl

(back to top)

map-subscriber-contact-points

Source: ./src/main/resources/dwl/map-subscriber-contact-points.dwl

(back to top)

map-subscriber-create-request

Individual/Subscriber Creation Mapping for Salesforce Marketing

Source: ./src/main/resources/dwl/map-subscriber-create-request.dwl

Mapping Tables

Maps Individual associated with Customer Profile of SourceSystem (SAP or B2C Commerce) to MDM in CIM format which is further used for creation of Subscriber in Salesforce Marketing.The object structure is same with only exception of GlobalPartyRoleId being sent as an ExternalId with ExternalIdType as MDM. This Id will be stored in Salesforce Marketing to uniquely identify an Individual.

MDMSalesforce MarketingDescription
ididThe id will be null for creating a new Subscriber in Salesforce Marketing
partyTypeIndividualThe type of party - default as Individual
personNamefirstName lastNameThe full name of the individual
firstNamefirstNameThe first name of the individual
lastNamelastNameThe last name of the individual
externalIdsexternalIdsThe GlobalPartyId of an Individual as in MDM.This will not be stored in Salesforce Marketing
contactPointscontactPointsThe ContactPoints of an Individual used for creating a Subscriber in Salesforce Marketing Cloud. ContactPointEmailAddress is only used by Salesforce Marketing Cloud

(back to top)

map-subscriber-update-request

Individual/Subscriber Update Mapping for Salesforce Marketing

Source: ./src/main/resources/dwl/map-subscriber-update-request.dwl

Mapping Tables

Maps Individual associated with Customer Profile of SourceSystem (SAP or B2C Commerce) to MDM in CIM format which is further used for creation of Subscriber in Salesforce Marketing. The object structure is same with only exception of GlobalPartyId being sent as an ExternalId to be stored in Salesforce Marketing to uniquely identify an Individual.

MDMSalesforce MarketingDescription
ididThe id will be GlobalPartyId for updating an existing Subscriber in Salesforce Marketing
partyTypeIndividualThe type of party - default as Individual
personNamefirstName lastNameThe full name of the individual
firstNamefirstNameThe first name of the individual
lastNamelastNameThe last name of the individual
externalIdsexternalIdsThe GlobalPartyId of an Individual as in MDM.This will not be stored in Salesforce Marketing
contactPointscontactPointsThe ContactPoints of an Individual used for creating a Subscriber in Salesforce Marketing Cloud. ContactPointEmailAddress is only used by Salesforce Marketing Cloud

(back to top)

map-updated-contact-points

Source: ./src/main/resources/dwl/map-updated-contact-points.dwl

(back to top)

ping-check-dependency-sys-api-response

Ping Status Response of the backend System API's

Source: ./src/main/resources/dwl/ping-check-dependency-sys-api-response.dwl

(back to top)

ping-response-payload

Ping Status Response of the API

Source: ./src/main/resources/dwl/ping-response-payload.dwl

(back to top)

retrieve-customers-queryParams-request-mapping

Source: ./src/main/resources/dwl/retrieve-customers-queryParams-request-mapping.dwl

(back to top)

update-external-id-object

update external Id using update operator

Source: ./src/main/resources/dwl/update-external-id-object.dwl

Mapping Tables

using update operator we can modify particular field in an payload. To update particular key in an object we can use this syntax field("keyNametoupdate") with "ValueToKey" To update particular key in an Array we can use this syntax ["ArrayKeyName","keyNametoUpdate"] with "ValueToKey".

CIM - CustomerAnypointMQDescription
idexternalIds.IdThe Master Id of that MDM
externalIds.IdCustomerNumberThe SAPECC customer number
externalIds.externalIdTypeSAP_ECCHardcoded to SAP_ECC

(back to top)


Reviews

TypeTemplate
OrganizationMuleSoft
Published by
MuleSoft Solutions
Published onSep 17, 2022
Asset overview

Asset versions for 2.6.x

Asset versions
VersionActions
2.6.1
2.6.0