MFG SAP S/4HANA Customers System API - Implementation Template
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.
| Module | Description |
|---|---|
| updateAddress | Update Address of Customer |
| updateEmail | Update Email of Customer |
| updatePhone | Update Phone details of Customer |
| contact-point-retrieve-response | Mapping response of Contact Points |
| search-customer-contact-point-retrieve-response | Search Customer Contact Points and Map |
| search-customers-contact-point-retrieve-response | Search Customers Contact Points and Map |
| create-customer-org-request | Create Customer Organization request and Map |
| create-customer-request | Create Customer Request Mapping |
| retrieve-customer-by-id-response | Retrieve Customer by ID and Map |
| search-customer-response | Search Customer Response and Map |
| search-customers-response | Search Customers Response and Map |
| update-customers-request | Update 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 field | CIM Source Field | Description of target field |
|---|---|---|
| AddressID | addressInfoDetails.AddressID | Address Id of Customer |
| BusinessPartner | customerId | Id of Customer |
| StreetName | addressInfo.addressLine1 | Street Name |
| CityName | addressInfo.cityName | City Name |
| PostalCode | addressInfo.postalCodeText[0 to 4] | Postal Code |
| Region | stateProvinceName | Set to two chars state code - default value "TX" |
| Country | countryName | Set to two chars state code - default value "US" |
| POBox | addressInfo.postalCodeText | Postal Code Text |
| HouseNumber | addressInfo.addressLine2 | House Number |
| HomeCityName | addressInfo.cityName | Home City Name |
updateEmail
Update Email of Customer
Source:
./src/main/resources/dwl/updateEmail.dwl
Mapping Tables
Update Customer's Email Details request mapping.
| SAP target field | CIM Source Field | Description of target field |
|---|---|---|
| AddressID | emailDetails.AddressID | Address Id of Customer |
| Person | emailDetails.Person | Person |
| OrdinalNumber | emailDetails.OrdinalNumber | Ordinal Number |
| EmailAddress | emailAddress | Email Address |
updatePhone
Update Phone details of Customer
Source:
./src/main/resources/dwl/updatePhone.dwl
Mapping Tables
Update Customer's Phone Details request mapping.
| SAP target field | CIM Source Field | Description of target field |
|---|---|---|
| AddressID | phoneDetails.AddressID | Address Id of Customer |
| Person | phoneDetails.Person | Person |
| OrdinalNumber | phoneDetails.OrdinalNumber | Ordinal Number |
| PhoneNumber | phone | Phone Number |
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 Field | SAP HANA source field | Description of source field |
|---|---|---|
| ContactPointAddress.contactPointType | "ContactPointAddress" | Contact Point Address |
| ContactPointAddress.id | AddressID | Address id in SAP HANA |
| ContactPointAddress.activeFromDate | ValidityStartDate | Set to current date |
| ContactPointAddress.addressLine1 | StreetName | Address street |
| ContactPointAddress.addressLine2 | HouseNumber | House Number |
| ContactPointAddress.cityName | CityName | City name |
| ContactPointAddress.postalCodeText | PostalCode | Postal code |
| ContactPointAddress.stateProvinceName | Region | State Province Name |
| ContactPointAddress.countryName | Country | Country |
| ContactPointAddress.geoLatitude | NA | geoLatitude |
| ContactPointAddress.geoLongitude | NA | geoLongitude |
| ContactPointAddress.geoAccuracy | NA | geoAccuracy |
| ContactPointEmail.contactPointType | "ContactPointEmail" | Contact Point Email |
| ContactPointEmail.id | AddressID | Address id in SAP HANA |
| ContactPointEmail.activeFromDate | ValidityStartDate | Validity start date |
| ContactPointEmail.emailAddress | EmailAddress | Email address |
| ContactPointPhone.contactPointType | "ContactPointPhone" | Contact Point Phone |
| ContactPointPhone.id | AddressID | Address id in SAP HANA |
| ContactPointPhone.activeFromDate | ValidityStartDate | Validity Start Date |
| ContactPointPhone.telephoneNumber | PhoneNumber | Phone number |
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 Field | SAP HANA source field | Description of source field |
|---|---|---|
| ContactPointAddress.contactPointType | "ContactPointAddress" | Contact Point Address |
| ContactPointAddress.id | AddressID | Address id in SAP HANA |
| ContactPointAddress.activeFromDate | ValidityStartDate | Set to current date |
| ContactPointAddress.addressLine1 | StreetName | Address street |
| ContactPointAddress.addressLine2 | HouseNumber | House Number |
| ContactPointAddress.cityName | CityName | City name |
| ContactPointAddress.postalCodeText | PostalCode | Postal code |
| ContactPointAddress.stateProvinceName | Region | State Province Name |
| ContactPointAddress.countryName | Country | Country |
| ContactPointAddress.geoLatitude | NA | geoLatitude |
| ContactPointAddress.geoLongitude | NA | geoLongitude |
| ContactPointAddress.geoAccuracy | NA | geoAccuracy |
| ContactPointEmail.contactPointType | "ContactPointEmail" | Contact Point Email |
| ContactPointEmail.id | AddressID | Address id in SAP HANA |
| ContactPointEmail.activeFromDate | ValidityStartDate | Validity start date |
| ContactPointEmail.emailAddress | EmailAddress | Email address |
| ContactPointPhone.contactPointType | "ContactPointPhone" | Contact Point Phone |
| ContactPointPhone.id | AddressID | Address id in SAP HANA |
| ContactPointPhone.activeFromDate | ValidityStartDate | Validity Start Date |
| ContactPointPhone.telephoneNumber | PhoneNumber | Phone number |
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 Field | SAP HANA source field | Description of source field |
|---|---|---|
| ContactPointAddress.contactPointType | "ContactPointAddress" | Contact Point Address |
| ContactPointAddress.id | AddressID | Address id in SAP HANA |
| ContactPointAddress.activeFromDate | ValidityStartDate | Set to current date |
| ContactPointAddress.addressLine1 | StreetName | Address street |
| ContactPointAddress.addressLine2 | HouseNumber | House Number |
| ContactPointAddress.cityName | CityName | City name |
| ContactPointAddress.postalCodeText | PostalCode | Postal code |
| ContactPointAddress.stateProvinceName | Region | State Province Name |
| ContactPointAddress.countryName | Country | Country |
| ContactPointAddress.geoLatitude | NA | geoLatitude |
| ContactPointAddress.geoLongitude | NA | geoLongitude |
| ContactPointAddress.geoAccuracy | NA | geoAccuracy |
| ContactPointEmail.contactPointType | "ContactPointEmail" | Contact Point Email |
| ContactPointEmail.id | AddressID | Address id in SAP HANA |
| ContactPointEmail.activeFromDate | ValidityStartDate | Validity start date |
| ContactPointEmail.emailAddress | EmailAddress | Email address |
| ContactPointPhone.contactPointType | "ContactPointPhone" | Contact Point Phone |
| ContactPointPhone.id | AddressID | Address id in SAP HANA |
| ContactPointPhone.activeFromDate | ValidityStartDate | Validity Start Date |
| ContactPointPhone.telephoneNumber | PhoneNumber | Phone number |
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 field | CIM Source Field | Description of target field | |
|---|---|---|---|
| BusinessPartnerCategory | BusinessPartnerCategory.organization | Set to "2" for Organization | |
| BusinessPartnerGrouping | BusinessPartnerGrouping | Set to "BP02" | |
| AuthorizationGroup | authorizationGroup | Set to "0001" | |
| LegalForm | legalName | Legal Name | |
| BusinessPartnerIsBlocked | "false" | Is Business Partner Blocked | |
| BusinessPartnerType | businessPartnerType | Business Partner Type | |
| OrganizationFoundationDate | sysDate | Organization Foundation Date | |
| YY1_SME_MPARTYROLEID_M_bus | externalIds.externalId | External Id | |
| YY1_SME_ParentID_MFG_bus | payload.primaryAccount | Primary Account Id | |
| OrganizationBPName1 | name | Name of the Organization | |
| to_BusinessPartnerAddress.Country | countryName | Country Name | |
| to_BusinessPartnerAddress.HouseNumber | address.addressLine2 | House Number | |
| to_BusinessPartnerAddress.StreetName | address.addressLine1 | Street Name | |
| to_BusinessPartnerAddress.CityName | address.cityName | City name | |
| to_BusinessPartnerAddress.PostalCode | address.postalCodeText | Postal code | |
| to_BusinessPartnerAddress.Region | stateProvinceName | Region | |
| to_BusinessPartnerAddress.HomeCityName | address.cityName | City Name | |
| to_BusinessPartnerAddress.POBox | address.postalCodeText | Postal code | |
| to_BusinessPartnerAddress.Language | language | Language | |
| to_EmailAddress.IsDefaultEmailAddress | "true" | Is Default Email Address or not | |
| to_EmailAddress.EmailAddress | emailAddress | Email address | |
| to_PhoneNumber.PhoneNumber | telephoneNumber | Phone number | |
| to_PhoneNumber.PhoneNumberExtension | extensionNumber | Phone Number Extension | |
| to_PhoneNumber.PhoneNumberType | "1" | Phone Number Type | |
| to_AddressUsage.AddressUsage | addressUsage | Address Details | |
| to_AddressUsage.ValidityEndDate | "9999-12-31T00:00:00" | End Date | |
| to_BusinessPartnerRole.BusinessPartnerRole | customerRole | Role to be assigned to the customer | |
| to_BusinessPartnerRole.ValidFrom | NA | Role Valid from | |
| to_BusinessPartnerRole.validTo | NA | Role Valid to | |
| to_BusinessPartnerRole.BusinessPartnerRole | customerRoleExtra | Role to be assigned to the customer | |
| to_BusinessPartnerRole.ValidFrom | NA | Role Valid from | |
| to_BusinessPartnerRole.validTo | NA | Role Valid to | |
| to_CustomerSalesArea.SalesOrganization | salesOrganization | Sales Organization | |
| to_CustomerSalesArea.DistributionChannel | distributionChannel | Distribution channel | |
| to_CustomerSalesArea.Division | division | Division | |
| to_CustomerSalesArea.CustomerPricingProcedure | customerPricingProcedure | Customer Pricing Procedure | |
| to_CustomerSalesArea.Currency | currency | Currency | |
| to_CustomerSalesArea.IncotermsClassification | incoTermsClass | IncotermsClassification | |
| to_CustomerSalesArea.IncotermsLocation1 | incoTermsLocation | IncotermsLocation1 | |
| to_CustomerSalesArea.ShippingCondition | shippingCondition | ShippingCondition | |
| to_CustomerSalesArea.CustomerAccountAssignmentGroup | customerAssignmentGroup | Customer Account Assignment Group | |
| to_CustomerSalesArea.CustomerGroup | customerGroup | Customer Group | |
| to_CustomerSalesArea.CustomerPaymentTerms | customerPaymentTerms | CustomerPaymentTerms | |
| to_PartnerFunction.PartnerCounter | "9" | Partner Counter | |
| to_PartnerFunction.PartnerFunction | "SP" | Partner Function | |
| to_PartnerFunction.DefaultPartner | true | Default Partner | |
| to_SalesAreaTax.DepartureCountry | departureCountry | Departure Country | |
| to_SalesAreaTax.CustomerTaxCategory | customerTaxCategory | Customer Tax Category | |
| to_SalesAreaTax.CustomerTaxClassification | customerTaxClass | Customer Tax Classification | |
| to_CustomerCompany.CompanyCode | salesOrganization | Code of Sales Organization | |
| to_CustomerCompany.PaymentTerms | paymentTerms | Payment Terms | |
| to_CustomerCompany.ReconciliationAccount | reconAccount | ReconciliationAccount |
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 field | CIM Source Field | Description of target field | |
|---|---|---|---|
| BusinessPartnerCategory | businessPartnerCategory.person | Set to "1" for Persons | |
| CorrespondenceLanguage | correspondenceLanguage | Set to "EN" | |
| BusinessPartnerGrouping | businessPartnerGrouping | Set to "BP02" | |
| FirstName | customerToCreate.firstName | Customer's first name | |
| LastName | customerToCreate.lastName | Customer's last name | |
| MiddleName | customerToCreate.middleName | Customer's middle name | |
| Language | language | Language | |
| BirthDate | customerToCreate.birthDate | Customer's DOB | |
| YY1_SME_MPARTYROLEID_M_bus | externalIds.externalId | External Id | |
| YY1_SME_ParentID_MFG_bus | payload.primaryAccount | Primary Account Id | |
| PersonFullName | customerToCreate.personName) | Person's full name | |
| NameCountry | NA | Name Country | |
| NameFormat | NA | Name Format | |
| to_BusinessPartnerAddress.ValidityEndDate | NA | Validity End Date | |
| to_BusinessPartnerAddress.CareOfName | NA | CareOfName | |
| to_BusinessPartnerAddress.CityCode | NA | City code | |
| to_BusinessPartnerAddress.CityName | address.cityName | City name | |
| to_BusinessPartnerAddress.Country | countryName | Country name | |
| to_BusinessPartnerAddress.County | address.county | county | |
| to_BusinessPartnerAddress.District | address.district | District | |
| to_BusinessPartnerAddress.FullName | address.personName | Full Name of Person | |
| to_BusinessPartnerAddress.HomeCityName | address.cityName | City Name | |
| to_BusinessPartnerAddress.HouseNumber | address.addressLine2 | House Number | |
| to_BusinessPartnerAddress.Language | language | Language | |
| to_BusinessPartnerAddress.PostalCode | address.postalCodeText | Postal Code | |
| to_BusinessPartnerAddress.Region | stateProvinceName | Region | |
| to_BusinessPartnerAddress.StreetName | address.addressLine1 | Street Name | |
| to_BusinessPartnerAddress.POBox | address.postalCodeText | Postal Code | |
| to_BusinessPartnerAddress.TaxJurisdiction | NA | Tax Jurisdiction | |
| to_BusinessPartnerAddress.AddressIDByExternalSystem | NA | Address ID By External System | |
| to_EmailAddress.IsDefaultEmailAddress | "true" | Is Default Email Address or not | |
| to_EmailAddress.EmailAddress | emailAddress | Email address | |
| to_PhoneNumber.PhoneNumber | telephoneNumber | Phone number | |
| to_PhoneNumber.PhoneNumberExtension | extensionNumber | Phone Number Extension | |
| to_PhoneNumber.PhoneNumberType | "1" | Phone Number Type | |
| to_AddressUsage.AddressUsage | addressUsage | Address Details | |
| to_AddressUsage.ValidityEndDate | "9999-12-31T00:00:00" | End Date | |
| to_BusinessPartnerRole.BusinessPartnerRole | customerRole | Role to be assigned to the customer | |
| to_BusinessPartnerRole.ValidFrom | NA | Role Valid from | |
| to_BusinessPartnerRole.validTo | NA | Role Valid to | |
| to_BusinessPartnerRole.BusinessPartnerRole | customerRoleExtra | Role to be assigned to the customer | |
| to_BusinessPartnerRole.ValidFrom | NA | Role Valid from | |
| to_BusinessPartnerRole.validTo | NA | Role Valid to | |
| to_CustomerSalesArea.SalesOrganization | salesOrganization | Sales Organization | |
| to_CustomerSalesArea.DistributionChannel | distributionChannel | Distribution channel | |
| to_CustomerSalesArea.Division | division | Division | |
| to_CustomerSalesArea.CustomerPricingProcedure | customerPricingProcedure | Customer Pricing Procedure | |
| to_CustomerSalesArea.Currency | currency | Currency | |
| to_CustomerSalesArea.IncotermsClassification | incoTermsClass | IncotermsClassification | |
| to_CustomerSalesArea.IncotermsLocation1 | incoTermsLocation | IncotermsLocation1 | |
| to_CustomerSalesArea.ShippingCondition | shippingCondition | ShippingCondition | |
| to_CustomerSalesArea.CustomerAccountAssignmentGroup | customerAssignmentGroup | Customer Account Assignment Group | |
| to_CustomerSalesArea.CustomerGroup | customerGroup | Customer Group | |
| to_CustomerSalesArea.CustomerPaymentTerms | customerPaymentTerms | CustomerPaymentTerms | |
| to_PartnerFunction.PartnerCounter | "9" | Partner Counter | |
| to_PartnerFunction.PartnerFunction | "SP" | Partner Function | |
| to_PartnerFunction.DefaultPartner | true | Default Partner | |
| to_SalesAreaTax.DepartureCountry | departureCountry | Departure Country | |
| to_SalesAreaTax.CustomerTaxCategory | customerTaxCategory | Customer Tax Category | |
| to_SalesAreaTax.CustomerTaxClassification | customerTaxClass | Customer Tax Classification | |
| to_CustomerCompany.CompanyCode | salesOrganization | Code of Sales Organization | |
| to_CustomerCompany.PaymentTerms | paymentTerms | Payment Terms | |
| to_CustomerCompany.ReconciliationAccount | reconAccount | ReconciliationAccount |
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 Field | SAP HANA source field | Description of source field |
|---|---|---|
| partyRoleType | "Customer" | Party role type |
| id | Customer | Customer id |
| party.id | Customer | Customer id |
| party.name | OrganizationBPName1 | name of the organization |
| party.salutation | NA | Customer salutation |
| party.personName | FirstName and LastName | Customers full name |
| party.firstName | FirstName | Customers first name |
| party.lastName | LastName | Customers last name |
| party.birthDate | BirthDate | Customers DOB |
| party.partyType | BusinessPartnerCategory | set to "Individual" or "Organization" |
| party.contactPoints | contactPoints | Customer's address details |
| externalIds.id | id | externalId id - set default as empty string |
| externalIds.externalId | YY1_SME_MPARTYROLEID_M_bus | External Id |
| externalIds.externalIdType | "MDM" | External Id Type |
| externalIds.status | "VALID" | Status of Customer |
| externalIds.id | id | externalId id - set default as empty string |
| externalIds.externalId | Customer | External Id |
| externalIds.externalIdType | "SAP_4HANA" | External Id Type |
| externalIds.status | "VALID" | Status of Customer |
| auditInfo.createdDate | CreationDate and CreationTime | Customer creation date time in SAP |
| auditInfo.createdBy | CreatedByUser | Customer created by |
| auditInfo.updatedDate | LastChangeDate and LastChangeTime | Customer last modified datetime |
| auditInfo.updatedBy | LastChangedUser | Last modified by |
| auditInfo.isDeleted | "false" | Is customer deleted |
| customerNumber | BusinessPartner | Customer id |
| customerStatus | "ACTIVE" | Status of Customer |
| primaryAccount | parentCustomer | Parent Id's of the customer |
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 Field | SAP HANA source field | Description of source field |
|---|---|---|
| partyRoleType | "Customer" | Party role type |
| id | Customer | Customer id |
| party.id | Customer | Customer id |
| party.name | OrganizationBPName1 | name of the organization |
| party.salutation | NA | Customer salutation |
| party.personName | FirstName and LastName | Customers full name |
| party.firstName | FirstName | Customers first name |
| party.lastName | LastName | Customers last name |
| party.birthDate | BirthDate | Customers DOB |
| party.partyType | BusinessPartnerCategory | set to "Individual" or "Organization" |
| party.contactPoints | contactPoints | Customer's address details |
| externalIds.id | id | externalId id - set default as empty string |
| externalIds.externalId | YY1_SME_MPARTYROLEID_M_bus | External Id |
| externalIds.externalIdType | "MDM" | External Id Type |
| externalIds.status | "VALID" | Status of Customer |
| externalIds.id | id | externalId id - set default as empty string |
| externalIds.externalId | Customer | External Id |
| externalIds.externalIdType | "SAP_4HANA" | External Id Type |
| externalIds.status | "VALID" | Status of Customer |
| auditInfo.createdDate | CreationDate and CreationTime | Customer creation date time in SAP |
| auditInfo.createdBy | CreatedByUser | Customer created by |
| auditInfo.updatedDate | LastChangeDate and LastChangeTime | Customer last modified datetime |
| auditInfo.updatedBy | LastChangedUser | Last modified by |
| auditInfo.isDeleted | "false" | Is customer deleted |
| customerNumber | BusinessPartner | Customer id |
| customerStatus | "ACTIVE" | Status of customer |
| primaryAccount | parentCustomer | Parent Id's of the customer |
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 Field | SAP HANA source field | Description of source field |
|---|---|---|
| partyRoleType | "Customer" | Party role type |
| id | Customer | Customer id |
| party.id | Customer | Customer id |
| party.name | OrganizationBPName1 | name of the organization |
| party.salutation | NA | Customer salutation |
| party.personName | FirstName and LastName | Customers full name |
| party.firstName | FirstName | Customers first name |
| party.lastName | LastName | Customers last name |
| party.birthDate | BirthDate | Customers DOB |
| party.partyType | BusinessPartnerCategory | set to "Individual" or "Organization" |
| party.contactPoints | contactPoints | Customer's address details |
| externalIds.id | id | externalId id - set default as empty string |
| externalIds.externalId | YY1_SME_MPARTYROLEID_M_bus | External Id |
| externalIds.externalIdType | "MDM" | External Id Type |
| externalIds.status | "VALID" | Status of Customer |
| externalIds.id | id | externalId id - set default as empty string |
| externalIds.externalId | Customer | External Id |
| externalIds.externalIdType | "SAP_4HANA" | External Id Type |
| externalIds.status | "VALID" | Status of Customer |
| auditInfo.createdDate | CreationDate and CreationTime | Customer creation date time in SAP |
| auditInfo.createdBy | CreatedByUser | Customer created by |
| auditInfo.updatedDate | LastChangeDate and LastChangeTime | Customer last modified datetime |
| auditInfo.updatedBy | LastChangedUser | Last modified by |
| auditInfo.isDeleted | "false" | Is customer deleted |
| customerNumber | BusinessPartner | Customer id |
| customerStatus | "ACTIVE" | Status of customer |
| primaryAccount | parentCustomer | Parent Id's of the customer |
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 field | CIM Source Field | Description of target field |
|---|---|---|
| BusinessPartner | customerId | Set Customer's ID |
| YY1_SME_MPARTYROLEID_M_bus | externalIds[0].externalId | Set externalIds if externalIdType contains "MDM" |
| YY1_SME_ParentID_MFG_bus | payload.primaryAccount | Primary Account Id |
| Salutation | salutation | Set Customer's Salutation |
| FirstName | firstName | Set Customer's FirstName |
| LastName | lastName | Set Customer's LastName |
| BirthDate | birthDate | Set Customer's BirthDate |
| OrganizationBPName1 | name | Set name |