RCG Salesforce Consumer Goods Cloud 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 |
|---|---|
| get-customer-by-id-response | Maps the individual customer and customer hierarchy data from Salesforce Consumer Goods cloud to CIM |
| get-customers-response | Maps the customers and customer hierarchy from Salesforce Consumer Goods Cloud to CIM |
| get-product-by-id-response | Maps the individual product and product hierarchy data from Salesforce Consumer Goods Cloud to CIM |
| get-products-response | Maps the product and product heirarchy data from Salesforce Consumer Goods cloud to CIM |
| post-customers-request | Maps the CIM request to customer data for Salesforce Consumer Goods Cloud |
| post-products-request | Maps the CIM request to product data for Salesforce Consumer Goods cloud |
| accountExtension | Maps the CIM request to customer extension data for Salesforce Consumer Goods Cloud |
| accountManager | Maps the CIM request to customer manager data for Salesforce Consumer Goods Cloud |
| accountOrgUnit | Maps the CIM request to customer org unit data for Salesforce Consumer Goods Cloud |
| accountRelationship | Maps the CIM request to customer relationship data for Salesforce Consumer Goods Cloud |
get-customer-by-id-response
Maps the individual customer and customer hierarchy data from Salesforce Consumer Goods cloud to CIM
Source:
./src/main/resources/dwl/get-customer-by-id-response.dwl
Mapping Tables
Maps the individual customer and customer hierarchy data from Salesforce Consumer Goods cloud to CIM.
| CIM property | CG Cloud property | Description |
|---|---|---|
| partyRoleType | cgcloud__Account_TemplateDescription\_c | Party Role Type |
| id | Id | Customer Id |
| name | Name | Customer Name |
| party.partyType | Organization | Mapped to Organization |
| contactPoints.addressLine1 | ShippingStreet | Address Line for Contact Point Address |
| contactPoints.cityName | ShippingCity | Shipping City for Contact Point Address |
| contactPoints.postalCodeText | ShippingPostalCode | Postal code for Contact Point Address |
| contactPoints.stateProvinceName | ShippingState | Shipping State for Contact Point Address |
| contactPoints.countryName | ShippingCountry | Shipping Country for Contact Point Address |
| contactPoints.emailAddress | cgcloud__AccountEmail\_c | Email Address for Contact Point Email |
| contactPoints.telephoneNumber | Phone | Phone Number for Contact Point Phone |
| externalIds.externalId | cgcloud__ExternalId__c | MDM External ID stored in CG cloud |
| originatingCustomerSource | cgcloud__AccountTemplate\_c | Account Template equivalent for source system |
| primaryAccount | ParentId | Parent Account ID |
get-customers-response
Maps the customers and customer hierarchy from Salesforce Consumer Goods Cloud to CIM
Source:
./src/main/resources/dwl/get-customers-response.dwl
Mapping Tables
Maps the customers and customer hierarchy from Salesforce Consumer Goods Cloud to CIM.
| CIM property | CG Cloud property | Description |
|---|---|---|
| partyRoleType | cgcloud__Account_TemplateDescription\_c | Party Role Type |
| id | Id | Customer Id |
| name | Name | Customer Name |
| party.partyType | Organization | Mapped to Organization |
| contactPoints.addressLine1 | ShippingStreet | Address Line for Contact Point Address |
| contactPoints.cityName | ShippingCity | Shipping City for Contact Point Address |
| contactPoints.postalCodeText | ShippingPostalCode | Postal code for Contact Point Address |
| contactPoints.stateProvinceName | ShippingState | Shipping State for Contact Point Address |
| contactPoints.countryName | ShippingCountry | Shipping Country for Contact Point Address |
| contactPoints.emailAddress | cgcloud__AccountEmail\_c | Email Address for Contact Point Email |
| contactPoints.telephoneNumber | Phone | Phone Number for Contact Point Phone |
| externalIds.externalId | cgcloud__ExternalId__c | MDM External ID stored in CG cloud |
| originatingCustomerSource | cgcloud__AccountTemplate\_c | Account Template equivalent for source system |
| primaryAccount | ParentId | Parent Account ID |
get-product-by-id-response
Maps the individual product and product hierarchy data from Salesforce Consumer Goods Cloud to CIM
Source:
./src/main/resources/dwl/get-product-by-id-response.dwl
Mapping Tables
Maps the individual product and product hierarchy data from Salesforce Consumer Goods Cloud to CIM.
| CIM property | CG Cloud property | Description |
|---|---|---|
| name | Name | Product Name |
| longDescription | Description | Product Description |
| id | Id | ID |
| productStatus | cgcloud__State__c | Status of the Product |
| description | Description | Product Description |
| productSKU | cgcloud__GTIN__c | Product's GTIn or SKU Number |
| 'type' | cgcloud__ProductType\_c | Type of the Product |
| productLevel | cgcloud__ProductTemplate\_c | Product Template in CG Cloud |
| productCode | cgcloud__Consumer_Goods_ProductCode\_c | Product Code |
| productShortCode | cgcloud__Product_ShortCode\_c | Product Short Code |
| productForm | cgcloud__ProductForm\_c | Product Form |
| size | cgcloud__Size__c | Size of the product |
| packSize | cgcloud__PackSize\_c | Pack size of the product |
| packSizeUnit | cgcloud__Pack_SizeUnit\_c | Pack size's unit for the product |
| weight | cgcloud__Weight__c | Weight of the product |
| height | cgcloud__Height__c | Height of the product |
| containerType | cgcloud__ContainerType\_c | Container Type for the Product |
| containerSizeUnit | cgcloud__Container_SizeUnit\_c | Container size unit |
| containerSize | cgcloud__ContainerSize\_c | Container size of the product |
| criterion1Product | cgcloud__Criterion_1Product\_c | Category Id of the product |
| criterion1ProductCode | cgcloud__Criterion_1_ProductCode\_c | Category Product code |
| criterion1ProductDescription | cgcloud__Criterion_1_ProductDescription\_c | Category's Product description |
| criterion2Product | cgcloud__Criterion_2Product\_c | Sub Category Id of the product |
| criterion2ProductCode | cgcloud__Criterion_2_ProductCode\_c | Sub Category Product code |
| criterion2ProductDescription | cgcloud__Criterion_2_ProductDescription\_c | Sub Category's Product description |
| criterion3Product | cgcloud__Criterion_3Product\_c | Brand Id of the product |
| criterion3ProductCode | cgcloud__Criterion_3_ProductCode\_c | Brand Product code |
| criterion3ProductDescription | cgcloud__Criterion_3_ProductDescription\_c | Brand's Product description |
| criterion4Product | cgcloud__Criterion_4Product\_c | Flavor Id of the product |
| criterion4ProductCode | cgcloud__Criterion_4_ProductCode\_c | Flavor Product code |
| criterion4ProductDescription | cgcloud__Criterion_4_ProductDescription\_c | Flavor's Product description |
| criterion5Product | cgcloud__Criterion_5Product\_c | Package Id of the product |
| criterion5ProductCode | cgcloud__Criterion_5_ProductCode\_c | Package Product code |
| criterion5ProductDescription | cgcloud__Criterion_5_ProductDescription\_c | Package's Product description |
| productCategory.parentCategory | Array of Criterion Product codes | |
| manufacturerName | cgcloud__Manufacturer__c | Name of the Manufacturer |
| manufacturerItemNumber | cgcloud__Manufacturer_ItemNumber\_c | Manufacturer's Item Number |
| competitiveProduct | cgcloud__CompetitiveProduct\_c | If the product is competitor's product (Boolean) |
| kamProduct | cgcloud__KAMProduct\_c | KAM product |
| estimatedValue | cgcloud__EstimatedValue\_c | Estimated value of the product |
get-products-response
Maps the product and product heirarchy data from Salesforce Consumer Goods cloud to CIM
Source:
./src/main/resources/dwl/get-products-response.dwl
Mapping Tables
Maps the product and product heirarchy data from Salesforce Consumer Goods cloud to CIM.
| CIM property | CG Cloud property | Description |
|---|---|---|
| name | Name | Product Name |
| longDescription | Description | Product Description |
| id | Id | ID |
| productStatus | cgcloud__State__c | Status of the Product |
| description | Description | Product Description |
| productSKU | cgcloud__GTIN__c | Product's GTIn or SKU Number |
| 'type' | cgcloud__ProductType\_c | Type of the Product |
| productLevel | cgcloud__ProductTemplate\_c | Product Template in CG Cloud |
| productCode | cgcloud__Consumer_Goods_ProductCode\_c | Product Code |
| productShortCode | cgcloud__Product_ShortCode\_c | Product Short Code |
| productForm | cgcloud__ProductForm\_c | Product Form |
| size | cgcloud__Size__c | Size of the product |
| packSize | cgcloud__PackSize\_c | Pack size of the product |
| packSizeUnit | cgcloud__Pack_SizeUnit\_c | Pack size's unit for the product |
| weight | cgcloud__Weight__c | Weight of the product |
| height | cgcloud__Height__c | Height of the product |
| containerType | cgcloud__ContainerType\_c | Container Type for the Product |
| containerSizeUnit | cgcloud__Container_SizeUnit\_c | Container size unit |
| containerSize | cgcloud__ContainerSize\_c | Container size of the product |
| criterion1Product | cgcloud__Criterion_1Product\_c | Category Id of the product |
| criterion1ProductCode | cgcloud__Criterion_1_ProductCode\_c | Category Product code |
| criterion1ProductDescription | cgcloud__Criterion_1_ProductDescription\_c | Category's Product description |
| criterion2Product | cgcloud__Criterion_2Product\_c | Sub Category Id of the product |
| criterion2ProductCode | cgcloud__Criterion_2_ProductCode\_c | Sub Category Product code |
| criterion2ProductDescription | cgcloud__Criterion_2_ProductDescription\_c | Sub Category's Product description |
| criterion3Product | cgcloud__Criterion_3Product\_c | Brand Id of the product |
| criterion3ProductCode | cgcloud__Criterion_3_ProductCode\_c | Brand Product code |
| criterion3ProductDescription | cgcloud__Criterion_3_ProductDescription\_c | Brand's Product description |
| criterion4Product | cgcloud__Criterion_4Product\_c | Flavor Id of the product |
| criterion4ProductCode | cgcloud__Criterion_4_ProductCode\_c | Flavor Product code |
| criterion4ProductDescription | cgcloud__Criterion_4_ProductDescription\_c | Flavor's Product description |
| criterion5Product | cgcloud__Criterion_5Product\_c | Package Id of the product |
| criterion5ProductCode | cgcloud__Criterion_5_ProductCode\_c | Package Product code |
| criterion5ProductDescription | cgcloud__Criterion_5_ProductDescription\_c | Package's Product description |
| productCategory.parentCategory | Array of Criterion Product codes | |
| manufacturerName | cgcloud__Manufacturer__c | Name of the Manufacturer |
| manufacturerItemNumber | cgcloud__Manufacturer_ItemNumber\_c | Manufacturer's Item Number |
| competitiveProduct | cgcloud__CompetitiveProduct\_c | If the product is competitor's product (Boolean) |
| kamProduct | cgcloud__KAMProduct\_c | KAM product |
| estimatedValue | cgcloud__EstimatedValue\_c | Estimated value of the product |
post-customers-request
Maps the CIM request to customer data for Salesforce Consumer Goods Cloud
Source:
./src/main/resources/dwl/post-customers-request.dwl
Variables
var s
Maps the CIM request to customer data for Salesforce Consumer Goods Cloud.
Mapping Tables
Maps the CIM request to customer data for Salesforce Consumer Goods Cloud.
| CG Cloud property | CIM property | Description |
|---|---|---|
| ID | id | Customer Id |
| Name | name | Customer Name |
| cgcloud__AccountNumber\_c | customerNumber | Account Number |
| cgcloud__Name2\_c | party.name | Customer Name |
| ShippingStreet | contactPoints.addressLine1 | Address Line for Contact Point Address |
| ShippingCity | contactPoints.cityName | Shipping City for Contact Point Address |
| ShippingPostalCode | contactPoints.postalCodeText | Postal code for Contact Point Address |
| ShippingState | contactPoints.stateProvinceName | Shipping State for Contact Point Address |
| ShippingCountry | contactPoints.countryName | Shipping Country for Contact Point Address |
| cgcloud__AccountEmail\_c | contactPoints.emailAddress | Email Address for Contact Point Email |
| Phone | contactPoints.telephoneNumber | Phone Number for Contact Point Phone |
| cgcloud__ExternalId__c | externalIds.externalId | MDM External ID stored in CG cloud |
| SAP_4HANAId\_c | externalIds.externalId | SAP_4HANA External Id |
| cgcloud__AccountTemplate\_c | originatingCustomerSource | Account Template equivalent for CG Cloud |
| ParentId | primaryAccount | Parent Account ID |
post-products-request
Maps the CIM request to product data for Salesforce Consumer Goods cloud
Source:
./src/main/resources/dwl/post-products-request.dwl
Variables
var s
Maps the CIM request to product data for Salesforce Consumer Goods cloud.
Mapping Tables
Maps the CIM request to product data for Salesforce Consumer Goods cloud.
| CG Cloud property | CIM property | Description |
|---|---|---|
| Name | name | Product Name |
| Description | longDescription | Product Description |
| Id | id | CG Cloud ID |
| cgcloud__State__c | productStatus | Status of the Product |
| cgcloud__GTIN__c | productSKU | Product's GTIn or SKU Number |
| cgcloud__ProductType\_c | 'type' | Type of the Product |
| cgcloud__ProductLevel\_c | productLevel | Product Level |
| cgcloud__ProductTemplate\_c | productLevel | Id of Product level |
| cgcloud__Consumer_Goods_ProductCode\_c | productCode | Product Code |
| cgcloud__Product_ShortCode\_c | productShortCode | Product Short Code |
| cgcloud__ProductForm\_c | productForm | Product Form |
| cgcloud__Consumer_Goods_External_ProductId\_c | externalIds.externalId | MDM External Id |
| SAP_4HANAId\_c | externalIds.externalId | SAP_4HANA External Id |
| cgcloud__Description_1_Language1\_c | description | Product Description |
| cgcloud__Description_2_Language1\_c | longDescription | Product Long description |
| cgcloud__Size__c | size | Size of the product |
| cgcloud__PackSize\_c | packSize | Pack size of the product |
| cgcloud__Pack_SizeUnit\_c | packSizeUnit | Pack sizes unit for the product |
| cgcloud__Weight__c | weight | Weight of the product |
| cgcloud__Height__c | height | Height of the product |
| cgcloud__ContainerType\_c | containerType | Container Type for the Product |
| cgcloud__Container_SizeUnit\_c | containerSizeUnit | Container size unit |
| cgcloud__ContainerSize\_c | containerSize | Container size of the product |
| cgcloud__Criterion_1Product\_c | criterion1Product | Category Id of the product |
| cgcloud__Criterion_2Product\_c | criterion2Product | Sub Category Id of the product |
| cgcloud__Criterion_3Product\_c | criterion3Product | Brand Id of the product |
| cgcloud__Criterion_4Product\_c | criterion4Product | Flavor Id of the product |
| cgcloud__Criterion_5Product\_c | criterion5Product | Package Id of the product |
| cgcloud__Manufacturer__c | manufacturerName | Name of the Manufacturer |
| cgcloud__Manufacturer_ItemNumber\_c | manufacturerItemNumber | Manufacturer's Item Number |
| cgcloud__CompetitiveProduct\_c | competitiveProduct | If the product is competitor's product (Boolean) |
| cgcloud__KAMProduct\_c | kamProduct | KAM product |
| cgcloud__EstimatedValue\_c | estimatedValue | Estimated value of the product |
accountExtension
Maps the CIM request to customer extension data for Salesforce Consumer Goods Cloud
Source:
./src/main/resources/dwl/accountExtension.dwl
Mapping Tables
Maps the CIM request to customer extension data for Salesforce Consumer Goods Cloud.
| CG Cloud property | CIM property | Description |
|---|---|---|
| cgcloud__Bill_To_Role_ValidFrom\_c | validFrom | BillToRole Valid From |
| cgcloud__Bill_To_Role_ValidThru\_c | validThrough | BillToRole Valid Through |
| cgcloud__Broker_Role_ValidFrom\_c | validFrom | BrokerRole Valid From |
| cgcloud__Broker_Role_ValidThru\_c | validThrough | BrokerRole Valid Through |
| cgcloud__customerId\_c | roleId | CustomerRole Id |
| cgcloud__customer_RoleNumber\_c | roleNumber | CustomerRole Number |
| cgcloud__customer_Role_Price_Listtype\_c | rolePriceListType | CustomerRole Price List Type |
| cgcloud__customer_Role_PriceType\_c | rolePriceType | CustomerRole Price Type |
| cgcloud__customer_Role_ValidFrom\_c | validFrom | CustomerRole Valid From |
| cgcloud__customer_Role_ValidThru\_c | validThrough | CustomerRole Valid Through |
| cgcloud__Delivery_Role_ValidFrom\_c | validFrom | DeliveryRole Valid From |
| cgcloud__Delivery_Role_ValidThru\_c | validThrough | DeliveryRole Valid Through |
| cgcloud__Promotion_ValidFrom\_c | validFrom | PromotionRole Valid From |
| cgcloud__Promotion_ValidThru\_c | validThrough | PromotionRole Valid Through |
| cgcloud__Payer_Role_ValidFrom\_c | validFrom | PayerRole Valid From |
| cgcloud__Payer_Role_ValidThru\_c | validThrough | PayerRole Valid Through |
| cgcloud__Payer_Role_Overall_CreditLimit\_c | creditLimit | PayerRole Credit Limit |
| cgcloud__Payer_Role_CreditRating\_c | creditRating | PayerRole Credit Rating |
| cgcloud__Payer_Role_CreditBlock\_c | creditBlock | PayerRole Credit Block |
| cgcloud__PaymentMode\_c | paymentMode | PayerRole Payment Mode |
| cgcloud__Order_Document_TransactionType\_c | orderDocumentTransactionType | PayerRole Order Document Transaction Type |
| cgcloud__Payer_Role_Document_TransactionType\_c | payerRoleDocumentTransactionType | PayerRole Payer Role Document Transaction Type |
| cgcloud__Invoice_Document_TransactionType\_c | invoiceDocumentTransactionType | PayerRole Invoice Document Transaction Type |
| cgcloud__Order_Role_ValidFrom\_c | validFrom | OrderRole Valid From |
| cgcloud__Order_Role_ValidThru\_c | validThrough | OrderRole Valid Through |
| cgcloud__Order_Role_OrdererType\_c | orderRoleOrdererType | OrderRole Orderer Type |
| cgcloud__Order_Role_Order_TemplateBlocked\_c | orderRoleOrderTemplateBlocked | OrderRole Order Template Blocked |
| cgcloud__Store_Role_ValidFrom\_c | validFrom | StoreRole Valid From |
| cgcloud__Store_Role_ValidThru\_c | validThrough | StoreRole Valid Through |
| cgcloud__considerModules\_c | considerModules | StoreRole Consider Modules |
accountManager
Maps the CIM request to customer manager data for Salesforce Consumer Goods Cloud
Source:
./src/main/resources/dwl/accountManager.dwl
Mapping Tables
Maps the CIM request to customer manager data for Salesforce Consumer Goods Cloud.
| CG Cloud property | CIM property | Description |
|---|---|---|
| cgcloud__Account__c | id | Account Id |
| cgcloud__User__c | User Id | |
| cgcloud__Active__c | activeToDate | Customer Manager Active Status |
| cgcloud__ValidFrom\_c | activeFromDate | Active From Date |
| cgcloud__ValidThru\_c | activeToDate | Active To Date |
| cgcloud__ManagementType\_c | Defaulted to Sales |
accountOrgUnit
Maps the CIM request to customer org unit data for Salesforce Consumer Goods Cloud
Source:
./src/main/resources/dwl/accountOrgUnit.dwl
Mapping Tables
Maps the CIM request to customer org unit data for Salesforce Consumer Goods Cloud.
| CG Cloud property | CIM property | Description |
|---|---|---|
| cgcloud__Account__c | id | Account Id |
| cgcloud__OrgUnit\_c | orgUnit | Org Unit Id |
| cgcloud__ValidFrom\_c | validFrom | Valid From |
| cgcloud__ValidThru\_c | validThru | Valid Through |
| cgcloud__Active__c | validThru | Customer Org Unit Active Status |
accountRelationship
Maps the CIM request to customer relationship data for Salesforce Consumer Goods Cloud
Source:
./src/main/resources/dwl/accountRelationship.dwl
Mapping Tables
Maps the CIM request to customer relationship data for Salesforce Consumer Goods Cloud.
| CG Cloud property | CIM property | Description |
|---|---|---|
| cgcloud__Account__c | id | Account Id |
| cgcloud__RelatedAccount\_c | id | Related Account Id |
| cgcloud__RelationshipType\_c | partyRelationshipType | Relationship Type |
| cgcloud__StartDate\_c | relatedFromDate | Related From Date |
| cgcloud__EndDate\_c | relatedToDate | Related To Date |