MFG SAP S/4HANA Customers System 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
updateAddressUpdate Address of Customer
updateEmailUpdate Email of Customer
updatePhoneUpdate Phone details of Customer
contact-point-retrieve-responseMapping response of Contact Points
search-customer-contact-point-retrieve-responseSearch Customer Contact Points and Map
search-customers-contact-point-retrieve-responseSearch Customers Contact Points and Map
create-customer-org-requestCreate Customer Organization request and Map
create-customer-requestCreate Customer Request Mapping
retrieve-customer-by-id-responseRetrieve Customer by ID and Map
search-customer-responseSearch Customer Response and Map
search-customers-responseSearch Customers Response and Map
update-customers-requestUpdate Customers Request and Map

updateAddress

Update Address of Customer

Source: ./src/main/resources/dwl/updateAddress.dwl

Mapping Tables

Update Customer's Address request mapping.

SAP target fieldCIM Source FieldDescription of target field
AddressIDaddressInfoDetails.AddressIDAddress Id of Customer
BusinessPartnercustomerIdId of Customer
StreetNameaddressInfo.addressLine1Street Name
CityNameaddressInfo.cityNameCity Name
PostalCodeaddressInfo.postalCodeText[0 to 4]Postal Code
RegionstateProvinceNameSet to two chars state code - default value "TX"
CountrycountryNameSet to two chars state code - default value "US"
POBoxaddressInfo.postalCodeTextPostal Code Text
HouseNumberaddressInfo.addressLine2House Number
HomeCityNameaddressInfo.cityNameHome City Name

(back to top)

updateEmail

Update Email of Customer

Source: ./src/main/resources/dwl/updateEmail.dwl

Mapping Tables

Update Customer's Email Details request mapping.

SAP target fieldCIM Source FieldDescription of target field
AddressIDemailDetails.AddressIDAddress Id of Customer
PersonemailDetails.PersonPerson
OrdinalNumberemailDetails.OrdinalNumberOrdinal Number
EmailAddressemailAddressEmail Address

(back to top)

updatePhone

Update Phone details of Customer

Source: ./src/main/resources/dwl/updatePhone.dwl

Mapping Tables

Update Customer's Phone Details request mapping.

SAP target fieldCIM Source FieldDescription of target field
AddressIDphoneDetails.AddressIDAddress Id of Customer
PersonphoneDetails.PersonPerson
OrdinalNumberphoneDetails.OrdinalNumberOrdinal Number
PhoneNumberphonePhone Number

(back to top)

contact-point-retrieve-response

Mapping response of Contact Points

Source: ./src/main/resources/dwl/contactpoints/contact-point-retrieve-response.dwl

Mapping Tables

Contact Points response mapping.

Resp FieldSAP HANA source fieldDescription of source field
ContactPointAddress.contactPointType"ContactPointAddress"Contact Point Address
ContactPointAddress.idAddressIDAddress id in SAP HANA
ContactPointAddress.activeFromDateValidityStartDateSet to current date
ContactPointAddress.addressLine1StreetNameAddress street
ContactPointAddress.addressLine2HouseNumberHouse Number
ContactPointAddress.cityNameCityNameCity name
ContactPointAddress.postalCodeTextPostalCodePostal code
ContactPointAddress.stateProvinceNameRegionState Province Name
ContactPointAddress.countryNameCountryCountry
ContactPointAddress.geoLatitudeNAgeoLatitude
ContactPointAddress.geoLongitudeNAgeoLongitude
ContactPointAddress.geoAccuracyNAgeoAccuracy
ContactPointEmail.contactPointType"ContactPointEmail"Contact Point Email
ContactPointEmail.idAddressIDAddress id in SAP HANA
ContactPointEmail.activeFromDateValidityStartDateValidity start date
ContactPointEmail.emailAddressEmailAddressEmail address
ContactPointPhone.contactPointType"ContactPointPhone"Contact Point Phone
ContactPointPhone.idAddressIDAddress id in SAP HANA
ContactPointPhone.activeFromDateValidityStartDateValidity Start Date
ContactPointPhone.telephoneNumberPhoneNumberPhone number

(back to top)

search-customer-contact-point-retrieve-response

Search Customer Contact Points and Map

Source: ./src/main/resources/dwl/contactpoints/search-customer-contact-point-retrieve-response.dwl

Mapping Tables

Contact Points response mapping.

Resp FieldSAP HANA source fieldDescription of source field
ContactPointAddress.contactPointType"ContactPointAddress"Contact Point Address
ContactPointAddress.idAddressIDAddress id in SAP HANA
ContactPointAddress.activeFromDateValidityStartDateSet to current date
ContactPointAddress.addressLine1StreetNameAddress street
ContactPointAddress.addressLine2HouseNumberHouse Number
ContactPointAddress.cityNameCityNameCity name
ContactPointAddress.postalCodeTextPostalCodePostal code
ContactPointAddress.stateProvinceNameRegionState Province Name
ContactPointAddress.countryNameCountryCountry
ContactPointAddress.geoLatitudeNAgeoLatitude
ContactPointAddress.geoLongitudeNAgeoLongitude
ContactPointAddress.geoAccuracyNAgeoAccuracy
ContactPointEmail.contactPointType"ContactPointEmail"Contact Point Email
ContactPointEmail.idAddressIDAddress id in SAP HANA
ContactPointEmail.activeFromDateValidityStartDateValidity start date
ContactPointEmail.emailAddressEmailAddressEmail address
ContactPointPhone.contactPointType"ContactPointPhone"Contact Point Phone
ContactPointPhone.idAddressIDAddress id in SAP HANA
ContactPointPhone.activeFromDateValidityStartDateValidity Start Date
ContactPointPhone.telephoneNumberPhoneNumberPhone number

(back to top)

search-customers-contact-point-retrieve-response

Search Customers Contact Points and Map

Source: ./src/main/resources/dwl/contactpoints/search-customers-contact-point-retrieve-response.dwl

Mapping Tables

Contact Points response mapping.

Resp FieldSAP HANA source fieldDescription of source field
ContactPointAddress.contactPointType"ContactPointAddress"Contact Point Address
ContactPointAddress.idAddressIDAddress id in SAP HANA
ContactPointAddress.activeFromDateValidityStartDateSet to current date
ContactPointAddress.addressLine1StreetNameAddress street
ContactPointAddress.addressLine2HouseNumberHouse Number
ContactPointAddress.cityNameCityNameCity name
ContactPointAddress.postalCodeTextPostalCodePostal code
ContactPointAddress.stateProvinceNameRegionState Province Name
ContactPointAddress.countryNameCountryCountry
ContactPointAddress.geoLatitudeNAgeoLatitude
ContactPointAddress.geoLongitudeNAgeoLongitude
ContactPointAddress.geoAccuracyNAgeoAccuracy
ContactPointEmail.contactPointType"ContactPointEmail"Contact Point Email
ContactPointEmail.idAddressIDAddress id in SAP HANA
ContactPointEmail.activeFromDateValidityStartDateValidity start date
ContactPointEmail.emailAddressEmailAddressEmail address
ContactPointPhone.contactPointType"ContactPointPhone"Contact Point Phone
ContactPointPhone.idAddressIDAddress id in SAP HANA
ContactPointPhone.activeFromDateValidityStartDateValidity Start Date
ContactPointPhone.telephoneNumberPhoneNumberPhone number

(back to top)

create-customer-org-request

Create Customer Organization request and Map

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

Mapping Tables

Search customers response mapping.

SAP target fieldCIM Source FieldDescription of target field
BusinessPartnerCategoryBusinessPartnerCategory.organizationSet to "2" for Organization
BusinessPartnerGroupingBusinessPartnerGroupingSet to "BP02"
AuthorizationGroupauthorizationGroupSet to "0001"
LegalFormlegalNameLegal Name
BusinessPartnerIsBlocked"false"Is Business Partner Blocked
BusinessPartnerTypebusinessPartnerTypeBusiness Partner Type
OrganizationFoundationDatesysDateOrganization Foundation Date
YY1_SME_MPARTYROLEID_M_busexternalIds.externalIdExternal Id
YY1_SME_ParentID_MFG_buspayload.primaryAccountPrimary Account Id
OrganizationBPName1nameName of the Organization
to_BusinessPartnerAddress.CountrycountryNameCountry Name
to_BusinessPartnerAddress.HouseNumberaddress.addressLine2House Number
to_BusinessPartnerAddress.StreetNameaddress.addressLine1Street Name
to_BusinessPartnerAddress.CityNameaddress.cityNameCity name
to_BusinessPartnerAddress.PostalCodeaddress.postalCodeTextPostal code
to_BusinessPartnerAddress.RegionstateProvinceNameRegion
to_BusinessPartnerAddress.HomeCityNameaddress.cityNameCity Name
to_BusinessPartnerAddress.POBoxaddress.postalCodeTextPostal code
to_BusinessPartnerAddress.LanguagelanguageLanguage
to_EmailAddress.IsDefaultEmailAddress"true"Is Default Email Address or not
to_EmailAddress.EmailAddressemailAddressEmail address
to_PhoneNumber.PhoneNumbertelephoneNumberPhone number
to_PhoneNumber.PhoneNumberExtensionextensionNumberPhone Number Extension
to_PhoneNumber.PhoneNumberType"1"Phone Number Type
to_AddressUsage.AddressUsageaddressUsageAddress Details
to_AddressUsage.ValidityEndDate"9999-12-31T00:00:00"End Date
to_BusinessPartnerRole.BusinessPartnerRolecustomerRoleRole to be assigned to the customer
to_BusinessPartnerRole.ValidFromNARole Valid from
to_BusinessPartnerRole.validToNARole Valid to
to_BusinessPartnerRole.BusinessPartnerRolecustomerRoleExtraRole to be assigned to the customer
to_BusinessPartnerRole.ValidFromNARole Valid from
to_BusinessPartnerRole.validToNARole Valid to
to_CustomerSalesArea.SalesOrganizationsalesOrganizationSales Organization
to_CustomerSalesArea.DistributionChanneldistributionChannelDistribution channel
to_CustomerSalesArea.DivisiondivisionDivision
to_CustomerSalesArea.CustomerPricingProcedurecustomerPricingProcedureCustomer Pricing Procedure
to_CustomerSalesArea.CurrencycurrencyCurrency
to_CustomerSalesArea.IncotermsClassificationincoTermsClassIncotermsClassification
to_CustomerSalesArea.IncotermsLocation1incoTermsLocationIncotermsLocation1
to_CustomerSalesArea.ShippingConditionshippingConditionShippingCondition
to_CustomerSalesArea.CustomerAccountAssignmentGroupcustomerAssignmentGroupCustomer Account Assignment Group
to_CustomerSalesArea.CustomerGroupcustomerGroupCustomer Group
to_CustomerSalesArea.CustomerPaymentTermscustomerPaymentTermsCustomerPaymentTerms
to_PartnerFunction.PartnerCounter"9"Partner Counter
to_PartnerFunction.PartnerFunction"SP"Partner Function
to_PartnerFunction.DefaultPartnertrueDefault Partner
to_SalesAreaTax.DepartureCountrydepartureCountryDeparture Country
to_SalesAreaTax.CustomerTaxCategorycustomerTaxCategoryCustomer Tax Category
to_SalesAreaTax.CustomerTaxClassificationcustomerTaxClassCustomer Tax Classification
to_CustomerCompany.CompanyCodesalesOrganizationCode of Sales Organization
to_CustomerCompany.PaymentTermspaymentTermsPayment Terms
to_CustomerCompany.ReconciliationAccountreconAccountReconciliationAccount

(back to top)

create-customer-request

Create Customer Request Mapping

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

Mapping Tables

Search customers response mapping.

SAP target fieldCIM Source FieldDescription of target field
BusinessPartnerCategorybusinessPartnerCategory.personSet to "1" for Persons
CorrespondenceLanguagecorrespondenceLanguageSet to "EN"
BusinessPartnerGroupingbusinessPartnerGroupingSet to "BP02"
FirstNamecustomerToCreate.firstNameCustomer's first name
LastNamecustomerToCreate.lastNameCustomer's last name
MiddleNamecustomerToCreate.middleNameCustomer's middle name
LanguagelanguageLanguage
BirthDatecustomerToCreate.birthDateCustomer's DOB
YY1_SME_MPARTYROLEID_M_busexternalIds.externalIdExternal Id
YY1_SME_ParentID_MFG_buspayload.primaryAccountPrimary Account Id
PersonFullNamecustomerToCreate.personName)Person's full name
NameCountryNAName Country
NameFormatNAName Format
to_BusinessPartnerAddress.ValidityEndDateNAValidity End Date
to_BusinessPartnerAddress.CareOfNameNACareOfName
to_BusinessPartnerAddress.CityCodeNACity code
to_BusinessPartnerAddress.CityNameaddress.cityNameCity name
to_BusinessPartnerAddress.CountrycountryNameCountry name
to_BusinessPartnerAddress.Countyaddress.countycounty
to_BusinessPartnerAddress.Districtaddress.districtDistrict
to_BusinessPartnerAddress.FullNameaddress.personNameFull Name of Person
to_BusinessPartnerAddress.HomeCityNameaddress.cityNameCity Name
to_BusinessPartnerAddress.HouseNumberaddress.addressLine2House Number
to_BusinessPartnerAddress.LanguagelanguageLanguage
to_BusinessPartnerAddress.PostalCodeaddress.postalCodeTextPostal Code
to_BusinessPartnerAddress.RegionstateProvinceNameRegion
to_BusinessPartnerAddress.StreetNameaddress.addressLine1Street Name
to_BusinessPartnerAddress.POBoxaddress.postalCodeTextPostal Code
to_BusinessPartnerAddress.TaxJurisdictionNATax Jurisdiction
to_BusinessPartnerAddress.AddressIDByExternalSystemNAAddress ID By External System
to_EmailAddress.IsDefaultEmailAddress"true"Is Default Email Address or not
to_EmailAddress.EmailAddressemailAddressEmail address
to_PhoneNumber.PhoneNumbertelephoneNumberPhone number
to_PhoneNumber.PhoneNumberExtensionextensionNumberPhone Number Extension
to_PhoneNumber.PhoneNumberType"1"Phone Number Type
to_AddressUsage.AddressUsageaddressUsageAddress Details
to_AddressUsage.ValidityEndDate"9999-12-31T00:00:00"End Date
to_BusinessPartnerRole.BusinessPartnerRolecustomerRoleRole to be assigned to the customer
to_BusinessPartnerRole.ValidFromNARole Valid from
to_BusinessPartnerRole.validToNARole Valid to
to_BusinessPartnerRole.BusinessPartnerRolecustomerRoleExtraRole to be assigned to the customer
to_BusinessPartnerRole.ValidFromNARole Valid from
to_BusinessPartnerRole.validToNARole Valid to
to_CustomerSalesArea.SalesOrganizationsalesOrganizationSales Organization
to_CustomerSalesArea.DistributionChanneldistributionChannelDistribution channel
to_CustomerSalesArea.DivisiondivisionDivision
to_CustomerSalesArea.CustomerPricingProcedurecustomerPricingProcedureCustomer Pricing Procedure
to_CustomerSalesArea.CurrencycurrencyCurrency
to_CustomerSalesArea.IncotermsClassificationincoTermsClassIncotermsClassification
to_CustomerSalesArea.IncotermsLocation1incoTermsLocationIncotermsLocation1
to_CustomerSalesArea.ShippingConditionshippingConditionShippingCondition
to_CustomerSalesArea.CustomerAccountAssignmentGroupcustomerAssignmentGroupCustomer Account Assignment Group
to_CustomerSalesArea.CustomerGroupcustomerGroupCustomer Group
to_CustomerSalesArea.CustomerPaymentTermscustomerPaymentTermsCustomerPaymentTerms
to_PartnerFunction.PartnerCounter"9"Partner Counter
to_PartnerFunction.PartnerFunction"SP"Partner Function
to_PartnerFunction.DefaultPartnertrueDefault Partner
to_SalesAreaTax.DepartureCountrydepartureCountryDeparture Country
to_SalesAreaTax.CustomerTaxCategorycustomerTaxCategoryCustomer Tax Category
to_SalesAreaTax.CustomerTaxClassificationcustomerTaxClassCustomer Tax Classification
to_CustomerCompany.CompanyCodesalesOrganizationCode of Sales Organization
to_CustomerCompany.PaymentTermspaymentTermsPayment Terms
to_CustomerCompany.ReconciliationAccountreconAccountReconciliationAccount

(back to top)

retrieve-customer-by-id-response

Retrieve Customer by ID and Map

Source: ./src/main/resources/dwl/customers/retrieve-customer-by-id-response.dwl

Mapping Tables

Retrieve customer by id response mapping.

Resp FieldSAP HANA source fieldDescription of source field
partyRoleType"Customer"Party role type
idCustomerCustomer id
party.idCustomerCustomer id
party.nameOrganizationBPName1name of the organization
party.salutationNACustomer salutation
party.personNameFirstName and LastNameCustomers full name
party.firstNameFirstNameCustomers first name
party.lastNameLastNameCustomers last name
party.birthDateBirthDateCustomers DOB
party.partyTypeBusinessPartnerCategoryset to "Individual" or "Organization"
party.contactPointscontactPointsCustomer's address details
externalIds.ididexternalId id - set default as empty string
externalIds.externalIdYY1_SME_MPARTYROLEID_M_busExternal Id
externalIds.externalIdType"MDM"External Id Type
externalIds.status"VALID"Status of Customer
externalIds.ididexternalId id - set default as empty string
externalIds.externalIdCustomerExternal Id
externalIds.externalIdType"SAP_4HANA"External Id Type
externalIds.status"VALID"Status of Customer
auditInfo.createdDateCreationDate and CreationTimeCustomer creation date time in SAP
auditInfo.createdByCreatedByUserCustomer created by
auditInfo.updatedDateLastChangeDate and LastChangeTimeCustomer last modified datetime
auditInfo.updatedByLastChangedUserLast modified by
auditInfo.isDeleted"false"Is customer deleted
customerNumberBusinessPartnerCustomer id
customerStatus"ACTIVE"Status of Customer
primaryAccountparentCustomerParent Id's of the customer

(back to top)

search-customer-response

Search Customer Response and Map

Source: ./src/main/resources/dwl/customers/search-customer-response.dwl

Mapping Tables

Retrieve customer by id response mapping.

Resp FieldSAP HANA source fieldDescription of source field
partyRoleType"Customer"Party role type
idCustomerCustomer id
party.idCustomerCustomer id
party.nameOrganizationBPName1name of the organization
party.salutationNACustomer salutation
party.personNameFirstName and LastNameCustomers full name
party.firstNameFirstNameCustomers first name
party.lastNameLastNameCustomers last name
party.birthDateBirthDateCustomers DOB
party.partyTypeBusinessPartnerCategoryset to "Individual" or "Organization"
party.contactPointscontactPointsCustomer's address details
externalIds.ididexternalId id - set default as empty string
externalIds.externalIdYY1_SME_MPARTYROLEID_M_busExternal Id
externalIds.externalIdType"MDM"External Id Type
externalIds.status"VALID"Status of Customer
externalIds.ididexternalId id - set default as empty string
externalIds.externalIdCustomerExternal Id
externalIds.externalIdType"SAP_4HANA"External Id Type
externalIds.status"VALID"Status of Customer
auditInfo.createdDateCreationDate and CreationTimeCustomer creation date time in SAP
auditInfo.createdByCreatedByUserCustomer created by
auditInfo.updatedDateLastChangeDate and LastChangeTimeCustomer last modified datetime
auditInfo.updatedByLastChangedUserLast modified by
auditInfo.isDeleted"false"Is customer deleted
customerNumberBusinessPartnerCustomer id
customerStatus"ACTIVE"Status of customer
primaryAccountparentCustomerParent Id's of the customer

(back to top)

search-customers-response

Search Customers Response and Map

Source: ./src/main/resources/dwl/customers/search-customers-response.dwl

Mapping Tables

Retrieve customer by id response mapping.

Resp FieldSAP HANA source fieldDescription of source field
partyRoleType"Customer"Party role type
idCustomerCustomer id
party.idCustomerCustomer id
party.nameOrganizationBPName1name of the organization
party.salutationNACustomer salutation
party.personNameFirstName and LastNameCustomers full name
party.firstNameFirstNameCustomers first name
party.lastNameLastNameCustomers last name
party.birthDateBirthDateCustomers DOB
party.partyTypeBusinessPartnerCategoryset to "Individual" or "Organization"
party.contactPointscontactPointsCustomer's address details
externalIds.ididexternalId id - set default as empty string
externalIds.externalIdYY1_SME_MPARTYROLEID_M_busExternal Id
externalIds.externalIdType"MDM"External Id Type
externalIds.status"VALID"Status of Customer
externalIds.ididexternalId id - set default as empty string
externalIds.externalIdCustomerExternal Id
externalIds.externalIdType"SAP_4HANA"External Id Type
externalIds.status"VALID"Status of Customer
auditInfo.createdDateCreationDate and CreationTimeCustomer creation date time in SAP
auditInfo.createdByCreatedByUserCustomer created by
auditInfo.updatedDateLastChangeDate and LastChangeTimeCustomer last modified datetime
auditInfo.updatedByLastChangedUserLast modified by
auditInfo.isDeleted"false"Is customer deleted
customerNumberBusinessPartnerCustomer id
customerStatus"ACTIVE"Status of customer
primaryAccountparentCustomerParent Id's of the customer

(back to top)

update-customers-request

Update Customers Request and Map

Source: ./src/main/resources/dwl/customers/update-customers-request.dwl

Mapping Tables

Search customers response mapping.

SAP target fieldCIM Source FieldDescription of target field
BusinessPartnercustomerIdSet Customer's ID
YY1_SME_MPARTYROLEID_M_busexternalIds[0].externalIdSet externalIds if externalIdType contains "MDM"
YY1_SME_ParentID_MFG_buspayload.primaryAccountPrimary Account Id
SalutationsalutationSet Customer's Salutation
FirstNamefirstNameSet Customer's FirstName
LastNamelastNameSet Customer's LastName
BirthDatebirthDateSet Customer's BirthDate
OrganizationBPName1nameSet name

(back to top)


Reviews

TypeTemplate
OrganizationMulesoft Inc.
Published by
MuleSoft Solutions
Published onOct 27, 2023
Asset overview

Asset versions for 2.3.x

Asset versions
VersionActions
2.3.1