RCG MDM 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 |
|---|---|
| accounts-get-account-response | Account Retrieve Mapping for MDM System |
| accounts-storedprocedure-request | Account Create Mapping for MDM System |
| contactpointsaddress-storedprocedure-request | ContactPointAddress Create/Update Mapping for MDM System |
| contactpointsemail-storedprocedure-request | ContactPointEmail Create/Update Mapping for MDM System |
| contactpoints-get-response | ContactPoint Retrieve Mapping for MDM System |
| contactpointsphone-storedprocedure-request | ContactPointPhone Create/Update Mapping for MDM System |
| customers-get-response | Customer Query Mapping for MDM System |
| customers-patch-payload | Customer Update Mapping for MDM System |
| customers-post-payload | Customer Create Mapping for MDM System |
| customers-search-response | Customer Search Mapping for MDM System |
| get-externalids-response | ExternalIds Query Mapping for MDM System |
| get-productcatalog-response | ProductCatalog Query Mapping for MDM System |
| get-productcategory-response | ProductCategory Query Mapping for MDM System |
| get-productpricebookentry-response | ExternalIds Query Mapping for MDM System |
| get-related-parties-response | RelatedParties Query Mapping for MDM System |
| orders-get-productitems-response | ProductItems Query Mapping for MDM System |
| orders-get-response | Order Query Mapping for MDM System |
| orders-patch-payload | Order Create Mapping for MDM System |
| orders-post-payload | Order Create Mapping for MDM System |
| orders-search-response | Order Query Mapping for MDM System |
| parties-get-response | Parties Query Mapping for MDM System |
| parties-related-parties-externalids | ExternalIds Query Mapping for MDM System |
| partyroles-get-response | PartyRoles Query Mapping for MDM System |
| post-externalids-payload | ExternalIds Upsert Mapping for MDM System |
| products-get-response | Products Query Mapping for MDM System |
| products-patch-payload | Products Update Mapping for MDM System |
| products-post-payload | Products Create Mapping for MDM System |
| products-search-response | Products Search Mapping for MDM System |
| products-upsert-pricebooks-payload | Products Create Mapping for MDM System |
| products-upsert-productcatalog-payload | Products Create Mapping for MDM System |
| put-productitems-payload | SalesOrderProduct Mapping for MDM System |
| products-upsert-productcategory-payload | Products Create Mapping for MDM System |
| put-related-parties-payload | RelatedParties Upsert Mapping for MDM System |
accounts-get-account-response
Account Retrieve Mapping for MDM System
Source:
./src/main/resources/dwl/accounts-get-account-response.dwl
Mapping Tables
Maps MDM Account to CIM Account format
| CIM | MDM | Description |
|---|---|---|
| accountType | ACCOUNT_TYPE | The type of the account |
| assignTerritoryFlag | ASSIGN_TERRITORY_FLAG | The flag indicating if territory is assigned to the account |
| autoPayEnabledFlag | AUTO_PAY_ENABLED_FLAG | The flag indicating if auto pay is enabled on the account |
| autoPaymentAmount | AUTO_PAYMENT_AMOUNT | The auto payment amount on the account |
| balanceAmount | BALANCE_AMOUNT | The balance amount on the account |
| balanceAmountLimit | BALANCE_AMOUNT_LIMIT | The balance limit on the account |
| billDeliveryMethod | BILL_DELIVERY_METHOD | The bill delivery method on the account |
| defaultFreightTerms | DEFAULT_FREIGHT_TERMS | The default freight terms |
| description | DESCRIPTION | The description of the account |
| generalLedgerAccount | GENERAL_LEDGER_ACCOUNT | The general ledger account |
| holdStatusReason | HOLD_STATUS_REASON | The reason for hold status |
| id | ID | The id of the account |
| lastActivityDate | LAST_ACTIVITY_DATE | The last activity date |
| name | NAME | The name of the account |
| ninetyDayBalanceAmount | NINETY_DAY_BALANCE_AMOUNT | The 90 day balance amount on the account |
| number | NUMBER | The number of the account |
| paymentTerm | PAYMENT_TERM | The payment terms on the account |
| sixtyDayBalanceAmount | SIXTY_DAY_BALANCE_AMOUNT | The 60 day balance amount |
| sLAExpirationDate | S_LA_EXPIRATION_DATE | The SLA expiration date |
| sLAType | S_LA_TYPE | The SLA type |
| thirtyDayBalanceAmount | THIRTY_DAY_BALANCE_AMOUNT | The thirty day balance amount |
| useAsBillingAccount | USE_AS_BILLING_ACCOUNT | The flag to indicate whether to use as a billing account |
| useAsSalesAccount | USE_AS_SALES_ACCOUNT | The flag to indicate whether to use as a sales account |
| useAsServiceAccount | USE_AS_SERVICE_ACCOUNT | The flag to indicate whether to use as a service account |
| useAsShippingAccount | USE_AS_SHIPPING_ACCOUNT | The flag to indicate whether to use as a shipping account |
| orderDeliveryMethod | ACCOUNT_ORDER_DELIVERY_METHOD_JOIN | The preferred delivery method for orders |
| auditInfo.createdBy | CREATED_BY | Identifies the system or user which created the entity |
| auditInfo.createdDate | CREATED_DATE | Timestamp of when the entity was created |
| auditInfo.updatedBy | UPDATED_BY | Identifies the system or user which last updated the entity |
| auditInfo.updatedDate | UPDATED_DATE | Timestamp of when the entity was last updated |
accounts-storedprocedure-request
Account Create Mapping for MDM System
Source:
./src/main/resources/dwl/accounts-storedprocedure-request.dwl
Mapping Tables
Maps CIM Account to MDM Account format
| MDM | CIM | Default Value | Description |
|---|---|---|---|
| id | id | The id of the account | |
| accountType | accountType | The type of the account | |
| assignTerritoryFlag | assignTerritoryFlag | false | The flag indicating if territory is assigned to the account |
| autoPayEnabledFlag | autoPayEnabledFlag | false | The flag indicating if auto pay is enabled on the account |
| autoPaymentAmount | autoPaymentAmount | 0 | The auto payment amount on the account |
| balanceAmount | balanceAmount | 0 | The balance amount on the account |
| balanceAmountLimit | balanceAmountLimit | 0 | The balance limit on the account |
| billDeliveryMethod | billDeliveryMethod | The bill delivery method on the account | |
| createdBy | auditInfo.createdBy | p('app.name') | Identifies the system or user which created the entity |
| createdDate | auditInfo.createdDate | now() | Timestamp of when the entity was created |
| defaultFreightTerms | defaultFreightTerms | The default freight terms | |
| description | description | The description of the account | |
| generalLedgerAccount | generalLedgerAccount | The general ledger account | |
| holdStatusReason | holdStatusReason | The reason for hold status | |
| lastActivityDate | lastActivityDate | The last activity date | |
| name | name | The name of the account | |
| ninetyDayBalanceAmount | ninetyDayBalanceAmount | 0 | The 90 day balance amount on the account |
| number | number | The number of the account | |
| paymentTerm | paymentTerm | The payment terms on the account | |
| sixtyDayBalanceAmount | sixtyDayBalanceAmount | 0 | The 60 day balance amount |
| sLAExpirationDate | sLAExpirationDate | The SLA expiration date | |
| sLAType | sLAType | The SLA type | |
| thirtyDayBalanceAmount | thirtyDayBalanceAmount | 0 | The thirty day balance amount |
| useAsBillingAccount | useAsBillingAccount | false | The flag to indicate whether to use as a billing account |
| useAsSalesAccount | useAsSalesAccount | false | The flag to indicate whether to use as a sales account |
| useAsServiceAccount | useAsServiceAccount | false | The flag to indicate whether to use as a service account |
| useAsShippingAccount | useAsShippingAccount | false | The flag to indicate whether to use as a shipping account |
| orderDeliveryMethod | orderDeliveryMethod | The preferred delivery method for orders | |
| autoPaymentMethod | autoPaymentMethod | The auto payment method | |
| billContactAddress | billContactAddress | The billing contact address of the account | |
| billFrequency | billFrequency | The billing frequency | |
| faxPhone | faxPhone | The fax phone number associated with the account | |
| parentAccount | parentAccount | The associated parent account | |
| party | party | The party associated with the account | |
| partyRole | partyRole | The type of party role | |
| primarySalesContactPoint | primarySalesContactPoint | The primary sales contact point | |
| salesPhone | salesPhone | The sales phone associated with the account | |
| shippingAddress | shippingAddress | The contact point address associated with the account | |
| shippingContact | shippingContact | The shipping contact of the account | |
| shippingEmail | shippingEmail | The contact point email associated with the account | |
| shippingPhoneid | shippingPhoneid | The contact point phone associated with the account | |
| updatedBy | auditInfo.updatedBy | p('app.name') | Identifies the system or user which last updated the entity |
| updatedDate | auditInfo.updatedDate | now() | Timestamp of when the entity was last updated |
contactpointsaddress-storedprocedure-request
ContactPointAddress Create/Update Mapping for MDM System
Source:
./src/main/resources/dwl/contactpointsaddress-storedprocedure-request.dwl
contactpointsemail-storedprocedure-request
ContactPointEmail Create/Update Mapping for MDM System
Source:
./src/main/resources/dwl/contactpointsemail-storedprocedure-request.dwl
Mapping Tables
Maps CIM ContactPointEmail to JSON which is used by stored procedure - sp_ContactPointEmail_Create or sp_ContactPointEmail_Update
| JSON used by the stored procedure | CIM | Default Value | Description |
|---|---|---|---|
| id | id | The id of the contactpoint | |
| contactPointType | contactPointType | The type of contact point | |
| activeFromDate | activeFromDate | now() | The date from which contactpoint is active |
| activeToDate | activeToDate | The date until which contactpoint is active | |
| bestTimeToContactEndTime | bestTimeToContactEndTime | The best time to contact end time | |
| bestTimeToContactStartTime | bestTimeToContactStartTime | The best time to contact start time | |
| createdBy | auditInfo.createdBy | p('app.name') | Identifies the system or user which created the entity |
| createdDate | auditInfo.createdDate | now() | Timestamp of when the entity was created |
| emailAddress | emailAddress | "" | The email address of the contactpoint |
| emailBouncedReason | emailBouncedReason | The reason indicating why the email bounces | |
| emailDomain | emailDomain | The domain of the email address | |
| emailLatestBounceDateTime | emailLatestBounceDateTime | Timestamp of when the email last bounced | |
| emailMailBox | emailMailBox | The email mail box to which email must be delivered | |
| forBusinessUse | forBusinessUse | Flag to indicate whether this contactpoint is used for business purpose | |
| forPersonalUse | forPersonalUse | Flag to indicate whether this contactpoint is used for personal use | |
| isUsedForBilling | isUsedForBilling | Flag to indicate whether the email address is used for billing | |
| isUsedForShipping | isUsedForShipping | Flag to indicate whether the email address is used for shipping | |
| name | name | The name of the contactpoint email address | |
| primaryFlag | primaryFlag | Flag to indicate if the email address is primary | |
| profileFirstCreatedDate | profileFirstCreatedDate | Timestamp of when the profile was first created | |
| profileLastUpdatedDate | profileLastUpdatedDate | Timestamp of when the profile was last updated | |
| profileOccurrenceCount | profileOccurrenceCount | The occurrence of profile | |
| updatedBy | auditInfo.updatedBy | p('app.name') | Identifies the system or user which last updated the entity |
| updatedDate | auditInfo.updatedDate | now() | Timestamp of when the entity was last updated |
contactpoints-get-response
ContactPoint Retrieve Mapping for MDM System
Source:
./src/main/resources/dwl/contactpoints-get-response.dwl
Mapping Tables
Maps MDM ContactPoint to CIM ContactPoint format
| CIM | MDM | Default Value | Description | |
|---|---|---|---|---|
| For each caitem in CONTACT_POINT_ADDRESS | ||||
| id | caitem.ID | The id of the contactpoint | ||
| activeFromDate | caitem.ACTIVE_FROM_DATE | The date from which contactpoint is active | ||
| activeToDate | caitem.ACTIVE_TO_DATE | The date until which contactpoint is active | ||
| addressLine1 | caitem.ADDRESS_LINE1 | The address line1 of the contactpoint address | ||
| addressLine2 | caitem.ADDRESS_LINE2 | The address line2 of the contactpoint address | ||
| addressLine3 | caitem.ADDRESS_LINE3 | The address line3 of the contactpoint address | ||
| addressLine4 | caitem.ADDRESS_LINE4 | The address line4 of the contactpoint address | ||
| bestTimeToContactEndTime | caitem.BEST_TIME_TO_CONTACT_END_TIME | The best time to contact end time | ||
| bestTimeToContactStartTime | caitem.BEST_TIME_TO_CONTACT_START_TIME | The best time to contact start time | ||
| cityName | caitem.CITY_NAME | The city name of the contactpoint address | ||
| countryName | caitem.COUNTRY_NAME | The country name of the contactpoint address | ||
| contactPointType | ["ContactPointAddress"] | The type of contactpoint type | ||
| forBusinessUse | caitem.FOR_BUSINESS_USE | Flag to indicate whether this contactpoint is used for business purpose | ||
| forPersonalUse | caitem.FOR_PERSONAL_USE | Flag to indicate whether this contactpoint is used for personal use | ||
| geoAccuracy | caitem.GEO_ACCURACY | The geo accuracy of the contactpoint address | ||
| geoLatitude | caitem.GEO_LATITUDE | The geo latitude of the contactpoint address | ||
| geoLongitude | caitem.GEO_LONGITUDE | The geo longitude of the contactpoint address | ||
| isUsedForBilling | caitem.IS_USED_FOR_BILLING | Flag to indicate whether the address is used for billing | ||
| isUsedForShipping | caitem.IS_USED_FOR_SHIPPING | Flag to indicate whether the address is used for billing | ||
| name | caitem.CONTACT_POINT_ADDRESS_NAME | The name of the contactpoint address | ||
| postalCodeText | caitem.POSTAL_CODE_TEXT | The postalcode of the contactpoint address | ||
| primaryFlag | caitem.PRIMARY_FLAG | Flag to indicate if the address is primary | ||
| profileFirstCreatedDate | caitem.PROFILE_FIRST_CREATED_DAT | Timestamp of when the profile was first created | ||
| profileLastUpdatedDate | caitem.PROFILE_LAST_UPDATED_DATE | Timestamp of when the profile was last updated | ||
| profileOccurrenceCount | caitem.PROFILE_OCCURRENCE_COUNT | The occurence of profile | ||
| stateProvinceName | caitem.STATE_PROVINCE_NAME | The state province of the contactpoint address | ||
| auditInfo.createdBy | caitem.CREATED_BY | Identifies the system or user which created the entity | ||
| auditInfo.createdDate | caitem.CREATED_DATE | Timestamp of when the entity was created | ||
| auditInfo.updatedBy | caitem.UPDATED_BY | Identifies the system or user which last updated the entity | ||
| auditInfo.updatedDate | caitem.UPDATED_DATE | Timestamp of when the entity was last updated | ||
| auditInfo.isDeleted | caitem.isDeleted | false | Indicates whether or not the entity has been soft-deleted | |
| END of foreach loop | ||||
| For each cpitem in CONTACT_POINT_PHONE | ||||
| id | cpitem.ID | The id of the contactpoint | ||
| activeFromDate | cpitem.ACTIVE_FROM_DATE | The date from which contactpoint is active | ||
| activeToDate | cpitem.ACTIVE_TO_DATE | The date until which contactpoint is active | ||
| areaCode | cpitem.AREA_CODE | The area code of the contactpoint | ||
| bestTimeToContactEndTime | cpitem.BEST_TIME_TO_CONTACT_END_TIME | The best time to contact end time | ||
| bestTimeToContactStartTime | cpitem.BEST_TIME_TO_CONTACT_START_TIME | The best time to contact start time | ||
| countryName | cpitem.COUNTRY_NAME | The country name of the contact point phone | ||
| contactPointType | ["ContactPointPhone"] | The type of contact point | ||
| extensionNumber | cpitem.EXTENSION_NUMBER | The extension number of the contactpoint phone | ||
| forBusinessUse | cpitem.FOR_BUSINESS_USE | Flag to inidicate whether this contactpoint is used for business purpose | ||
| formattedE164PhoneNumber | cpitem.FORMATTED_E164_PHONE_NUMBER | The formatted E164 phone number | ||
| formattedInternationalPhoneNumber | cpitem.FORMATTED_INTERNATIONAL_PHONE_NUMBER | The formatted international phone number | ||
| formattedNationalPhoneNumber | cpitem.FORMATTED_NATIONAL_PHONE_NUMBER | The formatted national phone number | ||
| forPersonalUse | cpitem.FOR_PERSONAL_USE | Flag to inidicate whether this contactpoint is used for personal use | ||
| isFaxCapable | cpitem.IS_FAX_CAPABLE | Flag to indicate whether the contactpoint phone is fax capable | ||
| isSMSCapable | cpitem.IS_SM_SCAPABLE | Flag to indicate whether the contactpoint phone is sms capable | ||
| name | cpitem.CONTACT_POINT_PHONE_NAME | The name of the contactpoint phone | ||
| phoneCountryCode | cpitem.PHONE_COUNTRY_CODE | The country code of the contactpoint phone | ||
| primaryFlag | cpitem.PRIMARY_FLAG | Flag to indicate if the phone is primary | ||
| primaryPhoneType | cpitem.PRIMARY_PHONE_TYPE | The type of primary phone | ||
| profileFirstCreatedDate | cpitem.PROFILE_FIRST_CREATED_DATE | Timestamp of when the profile was first created | ||
| profileLastUpdatedDate | cpitem.PROFILE_LAST_UPDATED_DATE | Timestamp of when the profile was last updated | ||
| profileOccurrenceCount | cpitem.PROFILE_OCCURRENCE_COUNT | The occurence of profile | ||
| shortCode | cpitem.SHORT_CODE | The short code of the contactpoint | ||
| telephoneNumber | cpitem.TELEPHONE_NUMBER | Telephone number of the contactpoint | ||
| auditInfo.createdBy | cpitem.CREATED_BY | Identifies the system or user which created the entity | ||
| auditInfo.createdDate | cpitem.CREATED_DATE | Timestamp of when the entity was created | ||
| auditInfo.updatedBy | cpitem.UPDATED_BY | Identifies the system or user which last updated the entity | ||
| auditInfo.updatedDate | cpitem.UPDATED_DATE | Timestamp of when the entity was last updated | ||
| auditInfo.isDeleted | cpitem.isDeleted | false | Indicates whether or not the entity has been soft-deleted | |
| end of for each loop | ||||
| For each ceitem in CONTACT_POINT_EMAIL | ||||
| id | ceitem.ID | The id of the contactpoint | ||
| activeFromDate | ceitem.ACTIVE_FROM_DATE | The date from which contactpoint is active | ||
| activeToDate | ceitem.ACTIVE_TO_DATE | The date until which contactpoint is active | ||
| bestTimeToContactEndTime | ceitem.BEST_TIME_TO_CONTACT_END_TIME | The best time to contact end time | ||
| bestTimeToContactStartTime | ceitem.BEST_TIME_TO_CONTACT_START_TIME | The best time to contact start time | ||
| contactPointType | ["ContactPointEmail"] | The type of contact point | ||
| emailAddress | ceitem.EMAIL_ADDRESS | The email address of the contactpoint | ||
| emailBouncedReason | ceitem.EMAIL_LATEST_BOUNCE_REASON_TEXT | The reason indicating why the email bounces | ||
| emailDomain | ceitem.EMAIL_DOMAIN | The domain of the email address | ||
| emailLatestBounceDateTime | ceitem.EMAIL_LATEST_BOUNCE_DATE_TIME | Timestamp of when the email last bounced | ||
| emailMailBox | ceitem.EMAIL_MAIL_BOX | The email mail box to which email must be delivered | ||
| forBusinessUse | ceitem.FOR_BUSINESS_USE | Flag to inidicate whether this contactpoint is used for business purpose | ||
| forPersonalUse | ceitem.FOR_PERSONAL_USE | Flag to inidicate whether this contactpoint is used for personal use | ||
| name | ceitem.CONTACT_POINT_EMAILADDRESS_NAME | The name of the contactpoint email address | ||
| primaryFlag | ceitem.PRIMARY_FLAG | Flag to indicate if the email address is primary | ||
| profileFirstCreatedDate | ceitem.PROFILE_FIRST_CREATED_DATE | Timestamp of when the profile was first created | ||
| profileLastUpdatedDate | ceitem.PROFILE_LAST_UPDATED_DATE | Timestamp of when the profile was last updated | ||
| profileOccurrenceCount | ceitem.PROFILE_OCCURRENCE_COUNT | The occurence of profile | ||
| auditInfo.createdBy | ceitem.CREATED_BY | Identifies the system or user which created the entity | ||
| auditInfo.createdDate | ceitem.CREATED_DATE | Timestamp of when the entity was created | ||
| auditInfo.updatedBy | ceitem.UPDATED_BY | Identifies the system or user which last updated the entity | ||
| auditInfo.updatedDate | ceitem.UPDATED_DATE | Timestamp of when the entity was last updated | ||
| auditInfo.isDeleted | ceitem.isDeleted | false | Indicates whether or not the entity has been soft-deleted | |
| END of foreach loop |
contactpointsphone-storedprocedure-request
ContactPointPhone Create/Update Mapping for MDM System
Source:
./src/main/resources/dwl/contactpointsphone-storedprocedure-request.dwl
Mapping Tables
Maps CIM ContactPointPhone to JSON which is used by stored procedure - sp_ContactPointPhone_Create or sp_ContactPointPhone_Uopdate
| JSON used by the stored procedure | CIM | Default Value | Description |
|---|---|---|---|
| id | id | The id of the contactpoint | |
| contactPointType | contactPointType | The type of contact point | |
| activeFromDate | activeFromDate | now() | The date from which contactpoint is active |
| activeToDate | activeToDate | The date until which contactpoint is active | |
| areaCode | areaCode | The area code of the contactpoint | |
| bestTimeToContactEndTime | bestTimeToContactEndTime | The best time to contact end time | |
| bestTimeToContactStartTime | bestTimeToContactStartTime | The best time to contact start time | |
| countryName | countryName | The country name of the contact point phone | |
| createdBy | auditInfo.createdBy | p('app.name') | Identifies the system or user which created the entity |
| createdDate | auditInfo.createdDate | now() | Timestamp of when the entity was created |
| extensionNumber | extensionNumber | The extension number of the contactpoint phone | |
| formattedE164PhoneNumber | formattedE164PhoneNumber | The formatted E164 phone number | |
| formattedInternationalPhoneNumber | formattedInternationalPhoneNumber | The formatted international phone number | |
| formattedNationalPhoneNumber | formattedNationalPhoneNumber | "000-000-0000" | The formatted national phone number |
| forBusinessUse | forBusinessUse | Flag to inidicate whether this contactpoint is used for business purpose | |
| forPersonalUse | forPersonalUse | Flag to inidicate whether this contactpoint is used for personal use | |
| isFaxCapable | isFaxCapable | Flag to indicate whether the contactpoint phone is fax capable | |
| isSMSCapable | isSMSCapable | Flag to indicate whether the contactpoint phone is sms capable | |
| name | name | The name of the contactpoint phone | |
| phoneCountryCode | phoneCountryCode | The country code of the contactpoint phone | |
| primaryFlag | primaryFlag | Flag to indicate if the phone is primary | |
| primaryPhoneType | primaryPhoneType | The type of primary phone | |
| profileFirstCreatedDate | profileFirstCreatedDate | Timestamp of when the profile was first created | |
| profileLastUpdatedDate | profileLastUpdatedDate | Timestamp of when the profile was last updated | |
| profileOccurrenceCount | profileOccurrenceCount | The occurence of profile | |
| shortCode | shortCode | The short code of the contactpoint | |
| telephoneNumber | telephoneNumber | "000-000-0000" | Telephone number of the contactpoint |
| updatedBy | auditInfo.updatedBy | p('app.name') | Identifies the system or user which last updated the entity |
| updatedDate | auditInfo.updatedDate | now() | Timestamp of when the entity was last updated |
customers-get-response
Customer Query Mapping for MDM System
Source:
./src/main/resources/dwl/customers-get-response.dwl
Mapping Tables
Maps MDM Customer to CIM Customer format
| CIM | MDM | Description |
|---|---|---|
| id | ID | The id of the customer in MDM system |
| churnScore | CHURN_SCORE | The churn score of the customer |
| customerNumber | CUSTOMER_NUMBER | The Customer Number in MDM |
| customerSatisfactionScore | CUSTOMER_SATISFACTION_SCORE | The customer satisfaction score |
| customerStatus | CUSTOMER_STATUS | The status of the customer in MDM system |
| last12MonthsNewRevenueAmount | LAST12_MONTHS_NEW_REVENUE_AMOUNT | The last 12 months new revenue amount of the customer |
| last12MonthsSupportCallCount | LAST12_MONTHS_SUPPORT_CALL_COUNT | The last 12 months support call count made by the customer |
| last24MonthsNewRevenueAmount | LAST24_MONTHS_NEW_REVENUE_AMOUNT | The last 24 months new revenue amount of the customer |
| marketingEmailResponseRate | MARKETING_EMAIL_RESPONSE_RATE | Marketing email response rate of the customer |
| netPromoterScore | NET_PROMOTER_SCORE | The net promoter score of the customer |
| originatingCustomerSource | ORIGINATING_CUSTOMER_SOURCE | The originating source of the customer |
| party | [ if(vars.individualRecord != null) (vars.individualRecord) else PARTY_ID ] | The id of the individual as party |
| partyRoleType | PARTY_ROLE_TYPE | The type of party role - default as Customer |
| prospectRating | PROSPECT_RATING | The prospect rating of the customer |
| totalBookingsAmount | TOTAL_BOOKINGS_AMOUNT | The total bookings amount made by the customer |
| totalContractedAmount | TOTAL_CONTRACTED_AMOUNT | The total contracted amount |
| totalLifeTimeValue | TOTAL_LIFE_TIME_VALUE | The total lifetime value of the customer |
| totalProfitContributionAmount | TOTAL_PROFIT_CONTRIBUTION_AMOUNT | The total profit contribution amount by the customer |
| externalIds | vars.customerExternalIds | The externalIds of the customer that are stored in MDM |
| auditInfo.createdBy | CREATED_BY | Identifies the system or user which created the entity |
| auditInfo.createdDate | CREATED_DATETimestamp of when the entity was created - default as current timestamp | |
| auditInfo.updatedBy | UPDATED_BY | Identifies the system or user which last updated the entity |
| auditInfo.updatedDate | UPDATED_DATE | Timestamp of when the entity was last updated |
| auditInfo.isDeleted | isDeleted | Indicates whether or not the entity has been soft-deleted - default as false |
customers-patch-payload
Customer Update Mapping for MDM System
Source:
./src/main/resources/dwl/customers-patch-payload.dwl
Variables
var payloadRecordfromDB
payloadRecordfromDB is the existing customer record in MDM system
Mapping Tables
Maps CIM Customer to MDM Customer PATCH payload is created by validating the Input Request payload with DB Record Payload.
| MDM | CIM | Description |
|---|---|---|
| id | vars.customerId | The id of the customer in MDM |
| churnScore | if(CHURN_SCORE?) CHURN_SCORE else payloadRecordfromDB.churnScore | The churn score of the customer |
| createdBy | p('app.name') | Identifies the system or user which created the entity - default as property app.name |
| createdDate | now() | Timestamp of when the entity was created - default as current timestamp |
| customerNumber | if(CUSTOMER_NUMBER?) CUSTOMER_NUMBER else payloadRecordfromDB.customerNumber | The Customer Number to be stored in MDM |
| customerSatisfactionScore | if(CUSTOMER_SATISFACTION_SCORE?) CUSTOMER_SATISFACTION_SCORE else payloadRecordfromDB.customerSatisfactionScore | The customer satisfaction score |
| customerStatus | if(CUSTOMER_STATUS?) CUSTOMER_STATUS else payloadRecordfromDB.customerStatus | The status of the customer |
| last12MonthsNewRevenueAmount | if(LAST12_MONTHS_NEW_REVENUE_AMOUNT?) LAST12_MONTHS_NEW_REVENUE_AMOUNT else payloadRecordfromDB.last12MonthsNewRevenueAmount | The last 12 months new revenue amount of the customer |
| last12MonthsSupportCallCount | if(LAST12_MONTHS_SUPPORT_CALL_COUNT?) LAST12_MONTHS_SUPPORT_CALL_COUNT else payloadRecordfromDB.last12MonthsSupportCallCount | The last 12 months support call count made by the customer |
| last24MonthsNewRevenueAmount: if(LAST24_MONTHS_NEW_REVENUE_AMOUNT?) LAST24_MONTHS_NEW_REVENUE_AMOUNT else payloadRecordfromDB.last24MonthsNewRevenueAmount | The last 24 months new revenue amount of the customer | |
| marketingEmailResponseRate | if(MARKETING_EMAIL_RESPONSE_RATE?) MARKETING_EMAIL_RESPONSE_RATE else payloadRecordfromDB.marketingEmailResponseRate | Marketing email response rate of the customer |
| netPromoterScore | if(NET_PROMOTER_SCORE?) NET_PROMOTER_SCORE else payloadRecordfromDB.netPromoterScore | The net promoter score of the customer |
| originatingCustomerSource | if(ORIGINATING_CUSTOMER_SOURCE?) ORIGINATING_CUSTOMER_SOURCE else payloadRecordfromDB.originatingCustomerSource | The originating source of the customer |
| prospectRating | if(PROSPECT_RATING?) PROSPECT_RATING else payloadRecordfromDB.prospectRating | The prospect rating of the customer |
| totalBookingsAmount | if(TOTAL_BOOKINGS_AMOUNT?) TOTAL_BOOKINGS_AMOUNT else payloadRecordfromDB.totalBookingsAmount | The total bookings amount made by the customer |
| totalContractedAmount | if(TOTAL_CONTRACTED_AMOUNT?) TOTAL_CONTRACTED_AMOUNT else payloadRecordfromDB.totalContractedAmount | The total contracted amount |
| totalLifeTimeValue | if(TOTAL_LIFE_TIME_VALUE?) TOTAL_LIFE_TIME_VALUE else payloadRecordfromDB.totalLifeTimeValue | The total lifetime value of the customer |
| totalProfitContributionAmount | if(TOTAL_PROFIT_CONTRIBUTION_AMOUNT?) TOTAL_PROFIT_CONTRIBUTION_AMOUNT else payloadRecordfromDB.totalProfitContributionAmount | The total profit contribution amount by the customer |
| updatedBy | p('app.name') | Identifies the system or user which last updated the entity - default as property app.name |
| updatedDate | now() | Timestamp of when the entity was last updated - default as current timestamp |
| partyId | if(party?) party[0] else payloadRecordfromDB.party[0] | The id of the individual as party |
| partyRoleType | if(PARTY_ROLE_TYPE?) PARTY_ROLE_TYPE else payloadRecordfromDB.partyRoleTypeThe type of party role - default as Customer |
customers-post-payload
Customer Create Mapping for MDM System
Source:
./src/main/resources/dwl/customers-post-payload.dwl
Mapping Tables
Maps CIM Customer to JSON which is used by stored procedure - sp_Customers_Create
| JSON used by the stored procedure | CIM | Description | |
|---|---|---|---|
| churnScore | churnScore | The churn score of the customer | |
| customerNumber | customerNumber | The Customer Number to be stored in MDM | |
| customerSatisfactionScore | customerSatisfactionScore | The customer satisfaction score | |
| customerStatus | customerStatus | The status of the customer | |
| id | id | The id of the customer | |
| last12MonthsNewRevenueAmount | last12MonthsNewRevenueAmount | The last 12 months new revenue amount of the customer | |
| last12MonthsSupportCallCount | last12MonthsSupportCallCount | The last 12 months support call count made by the customer | |
| last24MonthsNewRevenueAmount | last24MonthsNewRevenueAmount | The last 24 months new revenue amount of the customer | |
| marketingEmailResponseRate | marketingEmailResponseRate | Marketing email response rate of the customer | |
| netPromoterScore | netPromoterScore | The net promoter score of the customer | |
| originatingCustomerSource | originatingCustomerSource | The originating source of the customer | |
| prospectRating | prospectRating | The prospect rating of the customer | |
| totalBookingsAmount | totalBookingsAmount | The total bookings amount made by the customer | |
| totalContractedAmount | totalContractedAmount | The total contracted amount | |
| totalLifeTimeValue | totalLifeTimeValue | The total lifetime value of the customer | |
| totalProfitContributionAmount | totalProfitContributionAmount | The total profit contribution amount by the customer | |
| partyId | party[0] | The id of the individual as party | |
| partyRoleType | partyRoleType | "Customer" | The type of party role - default as Customer |
| createdDate | auditInfo.createdDate | Identifies the system or user which created the entity - default as current timestamp | |
| createdBy | auditInfo.createdBy | Timestamp of when the entity was created - default as current timestamp | |
| updatedBy | auditInfo.updatedBy | Identifies the system or user which last updated the entity - default as property app.name | |
| updatedDate | auditInfo.updatedDate | Timestamp of when the entity was last updated - default as current timestamp |
customers-search-response
Customer Search Mapping for MDM System
Source:
./src/main/resources/dwl/customers-search-response.dwl
Mapping Tables
Maps MDM Customer to CIM Customer format
| CIM | MDM | Description | |
|---|---|---|---|
| id | ID | The id of the customer in MDM system | |
| churnScore | CHURN_SCORE | The churn score of the customer | |
| customerNumber | CUSTOMER_NUMBER | The Customer Number in MDM | |
| customerSatisfactionScore | CUSTOMER_SATISFACTION_SCORE | The customer satisfaction score | |
| customerStatus | CUSTOMER_STATUS | The status of the customer in MDM system | |
| last12MonthsNewRevenueAmount | LAST12_MONTHS_NEW_REVENUE_AMOUNT | The last 12 months new revenue amount of the customer | |
| last12MonthsSupportCallCount | LAST12_MONTHS_SUPPORT_CALL_COUNT | The last 12 months support call count made by the customer | |
| last24MonthsNewRevenueAmount | LAST24_MONTHS_NEW_REVENUE_AMOUNT | The last 24 months new revenue amount of the customer | |
| marketingEmailResponseRate | MARKETING_EMAIL_RESPONSE_RATE | Marketing email response rate of the customer | |
| netPromoterScore | NET_PROMOTER_SCORE | The net promoter score of the customer | |
| originatingCustomerSource | ORIGINATING_CUSTOMER_SOURCE | The originating source of the customer | |
| party[0] | The individual information as party | ||
| id | if(vars.individualRecord != null) (vars.individualRecord) else PARTY_ID | The id of the individual | |
| partyType | PARTY_TYPE | The party type | |
| personName | PERSON_NAME | The person name of the individual | |
| contactPoints [0] | |||
| contactPointType | ['ContactPointEmail'] | The contactpoint type Email | |
| id | EMAIL_ID | The id of the contactpoint stored in MDM | |
| activeFromDate | EMAIL_ACTIVE_FROM_DATE | The date from which the email address is active | |
| emailAddress | EMAIL_ADDRESSThe emailaddress of the individual stored in MDM | ||
| contactPoints [1] | |||
| contactPointType | ['ContactPointPhone'] | The contactpoint type Phone | |
| id | PHONE_ID | The id of the contactpoint stored in MDM | |
| activeFromDate | PHONE_ACTIVE_FROM_DATE | The date from which the Phone is active | |
| formattedNationalPhoneNumber | FORMATTED_NATIONAL_PHONE_NUMBER | The formatted national phone number of the individual stored in MDM | |
| telephoneNumber | TELEPHONE_NUMBERThe telephone number of the individual stored in MDM | ||
| partyRoleType | PARTY_ROLE_TYPE | The type of party role - default as Customer | |
| prospectRating | PROSPECT_RATING | The prospect rating of the customer | |
| totalBookingsAmount | TOTAL_BOOKINGS_AMOUNT | The total bookings amount made by the customer | |
| totalContractedAmount | TOTAL_CONTRACTED_AMOUNT | The total contracted amount | |
| totalLifeTimeValue | TOTAL_LIFE_TIME_VALUE | The total lifetime value of the customer | |
| totalProfitContributionAmount | TOTAL_PROFIT_CONTRIBUTION_AMOUNT | The total profit contribution amount by the customer | |
| (externalIds | vars.customerExternalIds) if (vars.customerExternalIds !=null and !(isEmpty(vars.customerExternalIds))) | The external Ids of the customer that are stored in MDM | |
| auditInfo.createdBy | CREATED_BY | Identifies the system or user which created the entity | |
| auditInfo.createdDate | CREATED_DATE | Timestamp of when the entity was created | |
| auditInfo.updatedBy | UPDATED_BY | Identifies the system or user which last updated the entity | |
| auditInfo.updatedDate | UPDATED_DATE | Timestamp of when the entity was last updated | |
| auditInfo.isDeleted | isDeleted default false | Indicates whether or not the entity has been soft-deleted - default as false |
get-externalids-response
ExternalIds Query Mapping for MDM System
Source:
./src/main/resources/dwl/get-externalids-response.dwl
Variables
var outputPayload
outputPayload variable is the maps the result of select query on MDM EXTERNAL_ID table.
get-productcatalog-response
ProductCatalog Query Mapping for MDM System
Source:
./src/main/resources/dwl/get-productcatalog-response.dwl
get-productcategory-response
ProductCategory Query Mapping for MDM System
Source:
./src/main/resources/dwl/get-productcategory-response.dwl
get-productpricebookentry-response
ExternalIds Query Mapping for MDM System
Source:
./src/main/resources/dwl/get-productpricebookentry-response.dwl
get-related-parties-response
RelatedParties Query Mapping for MDM System
Source:
./src/main/resources/dwl/get-related-parties-response.dwl
Functions
fun formatDate (dateformats)
Maps MDM DB to CIM Json which is used by other process API's
| CIM | MDM DB | Description |
|---|---|---|
| id | ID | The id of the entry in MDM system |
| relatedFromDate | RELATED_FROM_DATE | Related From Date with the Party |
| relatedToDate | RELATED_TO_DATE | Related To Date with the Party |
| relatedParty | PARTY_RELATED_PARTY_ID | Indicates the Party that its related to |
| partyRelationshipType | PARTY_RELATION_TYPE.NAME | Pre-defined relation ship between parties |
orders-get-productitems-response
ProductItems Query Mapping for MDM System
Source:
./src/main/resources/dwl/orders-get-productitems-response.dwl
orders-get-response
Order Query Mapping for MDM System
Source:
./src/main/resources/dwl/orders-get-response.dwl
Mapping Tables
Maps MDM Order to CIM Order format
| CIM | MDM | Description |
|---|---|---|
| confirmationRecipientEmailText | CONFIRMATION_RECIPIENT_EMAIL_TEXT | Confirmation Recipient Email Text |
| description | DESCRIPTION | Description about the Order |
| developerStatusCode | DEVELOPER_STATUS_CODE | Status Code for Developer |
| id | ID | The id of the customer in MDM system |
| name | NAME | Name of the Order |
| orderNumber | ORDER_NUMBER | Order Number to Identify the Order |
| requestedStartDate | REQUESTED_START_DATE | Requested Start Date of the Order |
| totalDeliveryAmount | TOTAL_DELIVERY_AMOUNT | Total Delivery Amount for the Order |
| totalDeliveryFeeAmount | TOTAL_DELIVERY_FEE_AMOUNT | Delivery Fee for the Order |
| grandTotalAmount | GRAND_TOTAL_AMOUNT | Total Amount of Order |
| totalProductAmount | TOTAL_PRODUCT_AMOUNT | Total Product Amount of the Order |
| totalTaxAmount | TOTAL_TAX_AMOUNT | Total Tax Amount for the Order |
| salesOrderStatus | SALES_ORDER_STATUS | Status of the Order. A predefined list of Statuses |
| salesOrderType | SALES_ORDER_TYPE | Type of the Order. A predefined list of Types |
| soldToCustomer | SOLD_TO_CUSTOMER | Customer associated with the Order. |
| externalIds | vars.customerExternalIds | The externalIds of the customer that are stored in MDM |
| auditInfo.createdBy | CREATED_BY | Identifies the system or user which created the entity |
| auditInfo.createdDate | CREATED_DATE | Timestamp of when the entity was created - default as current timestamp |
| auditInfo.updatedBy | UPDATED_BY | Identifies the system or user which last updated the entity |
| auditInfo.updatedDate | UPDATED_DATE | Timestamp of when the entity was last updated |
| auditInfo.isDeleted | isDeleted | Indicates whether or not the entity has been soft-deleted - default as false |
orders-patch-payload
Order Create Mapping for MDM System
Source:
./src/main/resources/dwl/orders-patch-payload.dwl
Mapping Tables
Maps CIM SalesOrder to JSON which is used by stored procedure - sp_SalesOrder_Update
| JSON used by the stored procedure | CIM | Description |
|---|---|---|
| confirmationRecipientEmailText | confirmationRecipientEmailText | Confirmation Recipient Email Text |
| description | description | Description about the Order |
| developerStatusCode | developerStatusCode | Status Code for Developer |
| id | id | The id of the customer in MDM system |
| name | name | Name of the Order |
| orderNumber | orderNumber | Order Number to Identify the Order |
| requestedStartDate | requestedStartDate | Requested Start Date of the Order |
| totalDeliveryAmount | totalDeliveryAmount | Total Delivery Amount for the Order |
| totalDeliveryFeeAmount | totalDeliveryFeeAmount | Delivery Fee for the Order |
| grandTotalAmount | grandTotalAmount | Total Amount of Order |
| totalProductAmount | totalProductAmount | Total Product Amount of the Order |
| totalTaxAmount | totalTaxAmount | Total Tax Amount for the Oder |
| salesOrderStatus | salesOrderStatus | Status of the Order. A predefined list of Statuses |
| salesOrderType | salesOrderType | Type of the Order. A predefined list of Types |
| soldToCustomer | soldToCustomer | Customer associated with the Order. |
| externalIds | vars.customerExternalIds | The externalIds of the customer that are stored in MDM |
| createdDate | auditInfo.createdDate | Identifies the system or user which created the entity - default as current timestamp |
| createdBy | auditInfo.createdBy | Timestamp of when the entity was created - default as current timestamp |
| updatedBy | auditInfo.updatedBy | Identifies the system or user which last updated the entity - default as property app.name |
| updatedDate | auditInfo.updatedDate | Timestamp of when the entity was last updated - default as current timestamp |
orders-post-payload
Order Create Mapping for MDM System
Source:
./src/main/resources/dwl/orders-post-payload.dwl
Mapping Tables
Maps CIM SalesOrder to JSON which is used by stored procedure - sp_SalesOrder_Create
| JSON used by the stored procedure | CIM | Description |
|---|---|---|
| confirmationRecipientEmailText | confirmationRecipientEmailText | Confirmation Recipient Email Text |
| description | description | Description about the Order |
| developerStatusCode | developerStatusCode | Status Code for Developer |
| id | id | The id of the customer in MDM system |
| name | name | Name of the Order |
| orderNumber | orderNumber | Order Number to Identify the Order |
| requestedStartDate | requestedStartDate | Requested Start Date of the Order |
| totalDeliveryAmount | totalDeliveryAmount | Total Delivery Amount for the Order |
| totalDeliveryFeeAmount | totalDeliveryFeeAmount | Delivery Fee for the Order |
| grandTotalAmount | grandTotalAmount | Total Amount of Order |
| totalProductAmount | totalProductAmount | Total Product Amount of the Order |
| totalTaxAmount | totalTaxAmount | Total Tax Amount for the Oder |
| salesOrderStatus | salesOrderStatus | Status of the Order. A predefined list of Statuses |
| salesOrderType | salesOrderType | Type of the Order. A predefined list of Types |
| soldToCustomer | soldToCustomer | Customer associated with the Order. |
| externalIds | vars.customerExternalIds | The externalIds of the customer that are stored in MDM |
| createdDate | auditInfo.createdDate | Identifies the system or user which created the entity - default as current timestamp |
| createdBy | auditInfo.createdBy | Timestamp of when the entity was created - default as current timestamp |
| updatedBy | auditInfo.updatedBy | Identifies the system or user which last updated the entity - default as property app.name |
| updatedDate | auditInfo.updatedDate | Timestamp of when the entity was last updated - default as current timestamp |
orders-search-response
Order Query Mapping for MDM System
Source:
./src/main/resources/dwl/orders-search-response.dwl
Mapping Tables
Maps MDM Order to CIM Order format
| CIM | MDM | Description |
|---|---|---|
| confirmationRecipientEmailText | CONFIRMATION_RECIPIENT_EMAIL_TEXT | Confirmation Recipient Email Text |
| description | DESCRIPTION | Description about the Order |
| developerStatusCode | DEVELOPER_STATUS_CODE | Status Code for Developer |
| id | ID | The id of the customer in MDM system |
| name | NAME | Name of the Order |
| orderNumber | ORDER_NUMBER | Order Number to Identify the Order |
| requestedStartDate | REQUESTED_START_DATE | Requested Start Date of the Order |
| totalDeliveryAmount | TOTAL_DELIVERY_AMOUNT | Total Delivery Amount for the Order |
| totalDeliveryFeeAmount | TOTAL_DELIVERY_FEE_AMOUNT | Delivery Fee for the Order |
| grandTotalAmount | GRAND_TOTAL_AMOUNT | Total Amount of Order |
| totalProductAmount | TOTAL_PRODUCT_AMOUNT | Total Product Amount of the Order |
| totalTaxAmount | TOTAL_TAX_AMOUNT | Total Tax Amount for the Order |
| salesOrderStatus | SALES_ORDER_STATUS | Status of the Order. A predefined list of Statuses |
| salesOrderType | SALES_ORDER_TYPE | Type of the Order. A predefined list of Types |
| soldToCustomer | SOLD_TO_CUSTOMER | Customer associated with the Order. |
| externalIds | vars.customerExternalIds | The externalIds of the customer that are stored in MDM |
| auditInfo.createdBy | CREATED_BY | Identifies the system or user which created the entity |
| auditInfo.createdDate | CREATED_DATE | Timestamp of when the entity was created - default as current timestamp |
| auditInfo.updatedBy | UPDATED_BY | Identifies the system or user which last updated the entity |
| auditInfo.updatedDate | UPDATED_DATE | Timestamp of when the entity was last updated |
| auditInfo.isDeleted | isDeleted | Indicates whether or not the entity has been soft-deleted - default as false |
parties-get-response
Parties Query Mapping for MDM System
Source:
./src/main/resources/dwl/parties-get-response.dwl
Mapping Tables
Maps MDM PartyRole to CIM PartyRole format
| CIM - partyRole | MDM - PARTY_ROLE | Description |
|---|---|---|
| id | ID | The party identifier stored in MDM |
| partyType | PARTY_TYPE | The party type stored in MDM |
| globalParty | GLOBAL_PARTY | The global party stored in MDM |
| noMergeReason | NO_MERGE_REASON | The reason for no merge |
parties-related-parties-externalids
ExternalIds Query Mapping for MDM System
Source:
./src/main/resources/dwl/parties-related-parties-externalids.dwl
partyroles-get-response
PartyRoles Query Mapping for MDM System
Source:
./src/main/resources/dwl/partyroles-get-response.dwl
Mapping Tables
Maps MDM PartyRole to CIM PartyRole format
| CIM - partyRole | MDM - PARTY_ROLE | Description | |
|---|---|---|---|
| id | ID | The id of the customer in MDM system | |
| partyRoleType | PARTY_ROLE_TYPE | The party role type stored in MDM | |
| party.id | i | PARTY_ID | The party identifier stored in MDM |
| partyType | PARTY_TYPE | The party type stores in MDM | |
| globalParty | GLOBAL_PARTY | The global party stored in MDM | |
| noMergeReason | NO_MERGE_REASON | The reason for no merge |
post-externalids-payload
ExternalIds Upsert Mapping for MDM System
Source:
./src/main/resources/dwl/post-externalids-payload.dwl
Mapping Tables
Maps CIM to Json which is used by stored procedure - sp_Individual_ExternalIds_Upsert
| JSON used by the stored procedure | CIM | Description |
|---|---|---|
| id | id | The id of the entry in MDM system |
| externalId | externalId | A unique identifier assigned to the individual in another system |
| createdBy | application name from properties | Identifies the system or user which created the entry |
| updatedBy | application name from properties | Identifies the system or user which last updated the entry |
| externalIdType | externalIdType | Identifies the system that owns or otherwise recognises this unique identifier |
| status | status | Indicates whether this identifier is currently valid or not |
| statusLastChangedDate | statusLastChangedDate | Date and time of the last change in status |
products-get-response
Products Query Mapping for MDM System
Source:
./src/main/resources/dwl/products-get-response.dwl
Mapping Tables
Maps MDM Product to CIM Product format
| CIM | MDM | Description |
|---|---|---|
| allowCustomerReturn | ALLOW_CUSTOMER_RETURN | flag to allow customer to return a Product |
| allowPartialRefund | ALLOW_PARTIAL_REFUND | flag to allow partial refund for a Product |
| brand | BRAND.NAME | brand of a Product |
| brandGrade | BRAND_GRADE | brand grade of a Product |
| canUseQuantitySchedule | CAN_USE_QUANTITY_SCHEDULE | flag for quantity schedule |
| canUseRevenueSchedule | CAN_USE_REVENUE_SCHEDULE | flag for revenue schedule |
| description | DESCRIPTION | description of the Product |
| displayUrl | DISPLAY_URL | display URL of the Product |
| disposalType | DISPOSAL_TYPE | disposal type of the Product |
| externalSourceRecord | EXTERNAL_SOURCE_RECORD | external source record of the Product |
| glAccountCode | GL_ACCOUNT_CODE | GL Account Code of the Product |
| id | ID | unique Id of the Product |
| isAutoProvisionable | IS_AUTO_PROVISIONABLE | flag for auto provisioning |
| isBackOrdered | IS_BACK_ORDERED | flag for back ordered Product |
| isCouponRedemptionAllowed | IS_COUPON_REDEMPTION_ALLOWED | flag to allow redemption of coupon |
| isCustomerDiscountAllowed | IS_CUSTOMER_DISCOUNT_ALLOWED | flag to allow customer discount on the Product |
| isDynamicBundle | IS_DYNAMIC_BUNDLE | flag to highlight if a Product is part of a dynamic bundle |
| isFoodstampPaymentAllowed | IS_FOODSTAMP_PAYMENT_ALLOWED | flag to allow food stamp payment |
| isInstallable | IS_INSTALLABLE | flag to install a Product |
| isIntellectualPropertyProtected | IS_INTELLECTUAL_PROPERTY_PROTECTED | flag to protect the Product as intellectual property |
| isManualPriceEntryRequired | IS_MANUAL_PRICE_ENTRY_REQUIRED | flag to enter the price of Product manually |
| isMultipleCouponsAllowed | IS_MULTIPLE_COUPONS_ALLOWED | flag to allow multiple coupons on the Product |
| isPartnerDiscountAllowed | IS_PARTNER_DISCOUNT_ALLOWED | flag to allow partner discounts |
| isPreOrderable | IS_PRE_ORDERABLE | flag to preorder the Product |
| isQualityVerificationRequired | IS_QUALITY_VERIFICATION_REQUIRED | flag to mandate verification of quality of the Product |
| isQuantityEntryRequired | IS_QUANTITY_ENTRY_REQUIRED | flag to mandate entry of quantity |
| isRainCheckAllowed | IS_RAIN_CHECK_ALLOWED | flag to allow rain check |
| isReturnable | IS_RETURNABLE | flag to allow returning of Product |
| isSellable | IS_SELLABLE | flag allow a Product to be sold |
| isSellableIndependently | IS_SELLABLE_INDEPENDENTLY | flag to allow a Product to be sold independently |
| isSellableWithoutPrice | IS_SELLABLE_WITHOUT_PRICE | flag to allow a Product to be sold independently |
| isSerialized | IS_SERIALIZED | flag to serialize a Product |
| isWeightEntryRequired | IS_WEIGHT_ENTRY_REQUIRED | flag to enter weight of the Product |
| isWorkerDiscountAllowed | IS_WORKER_DISCOUNT_ALLOWED | flag to allow discount for workers |
| longDescription | LONG_DESCRIPTION | long description of the Product |
| lotIdentity | LOT_IDENTIFIER | lot to identify the Product |
| manufacturerName | MANUFACTURER_NAME | manufacturer name of the Product |
| masterProduct | PRODUCT_MASTER_PRODUCT_JOIN.PRODUCT_ID_RIGHT | master Product of the Product |
| maximumOrderQuantityCount | MAXIMUM_ORDER_QUANTITY_COUNT | max. quantity that can be ordered of that Product |
| minimumAdvertisementAmount | MINIMUM_ADVERTISEMENT_AMOUNT | min. amount of advertisement of the Product |
| minimumAdvertisementAmountStartDate | MINIMUM_ADVERTISEMENT_AMOUNT_START_DATE | min. amount to start advertisement of the Product |
| minimumOrderQuantityCount | MINIMUM_ORDER_QUANTITY_COUNT | min. amount of advertisement of the Product |
| modelNumber | MODEL_NUMBER | model number of the Product |
| modelYear | MODEL_YEAR | model year of the Product |
| mSRPAmount | MSRP_AMOUNT | MSRP amount of the Product |
| name | NAME | name of the Product |
| priceChargeType | PRICE_CHARGE_TYPE | price change type of the Product |
| primaryProductCategory | PRODUCT_CATEGORY.NAME | primary category of the Product |
| primarySalesChannel | SALES_CHANNEL.NAME | primary sales channel for the Product |
| productSKU | PRODUCT_SKU | SKU of the Product |
| productStatus | PRODUCT_STATUS | status of the Product |
| quantityInstallmentCount | QUANTITY_INSTALLMENT_COUNT | quantity installment count of the Product |
| quantityInstallmentPeriod | QUANTITY_INSTALLMENT_PERIOD | quantity installment period of the Product |
| quantityScheduleType | QUANTITY_SCHEDULE_TYPE | quantity schedule type of the Product |
| requiredDepositAmount | REQUIRED_DEPOSIT_AMOUNT | requested deposit amount for the Product |
| requiredDepositPercentage | REQUIRED_DEPOSIT_PERCENTAGE | requested deposit percentage for the Product |
| requiresInvididualUnitPricing | REQUIRES_INVIDIDUAL_UNIT_PRICING | flag to highlight that the Product requires individual unit pricing |
| revenueInstallmentCount | REVENUE_INSTALLMENT_COUNT | revenue installment count of the Product |
| revenueInstallmentPeriod | REVENUE_INSTALLMENT_PERIOD | revenue installment period of the Product |
| revenueScheduleType | REVENUE_SCHEDULE_TYPE | revenue schedule type of the Product |
| rewardProgramPointsCount | REWARD_PROGRAM_POINTS_COUNT | reward program points count of the Product |
| standardWarrantyLengthMonth | STANDARD_WARRANTY_LENGTH_MONTH | standard warranty length of the Product in months |
| stockLedgerValuationAmount | STOCK_LEDGER_VALUATION_AMOUNT | stock ledger valuation amount of the Product |
| type | TYPE | type of Product |
| validForPeriodCount | VALID_FOR_PERIOD_COUNT | valid for period count of the Product |
| validFromDate | VALID_FROM_DATE | valid from date of the Product |
| validToDate | VALID_TO_DATE | valid to date of the Product |
| versionNumber | VERSION_NUMBER | version number of the Product |
| externalIds | vars.productExternalIds | The externalIds of the products that are stored in MDM |
| auditInfo.createdBy | CREATED_BY | Identifies the system or user which created the entity |
| auditInfo.createdDate | CREATED_DATE | Timestamp of when the entity was created - default as current timestamp |
| auditInfo.updatedBy | UPDATED_BY | Identifies the system or user which last updated the entity |
| auditInfo.updatedDate | UPDATED_DATE | Timestamp of when the entity was last updated |
| auditInfo.isDeleted | isDeleted | Indicates whether or not the entity has been soft-deleted - default as false |
products-patch-payload
Products Update Mapping for MDM System
Source:
./src/main/resources/dwl/products-patch-payload.dwl
Mapping Tables
Maps CIM Product to JSON which is used by stored procedure - sp_Products_Create
| JSON used by the stored procedure | CIM | Description |
|---|---|---|
| allowCustomerReturn | allowCustomerReturn | flag to allow customer to return a Product |
| allowPartialRefund | allowPartialRefund | flag to allow partial refund for a Product |
| brand | brand | brand of a Product |
| brandGrade | brandGrade | brand grade of a Product |
| canUseQuantitySchedule | canUseQuantitySchedule | flag for quantity schedule |
| canUseRevenueSchedule | canUseRevenueSchedule | flag for revenue schedule |
| description | description | description of the Product |
| displayUrl | displayUrl | display URL of the Product |
| disposalType | disposalType | disposal type of the Product |
| externalSourceRecord | externalSourceRecord | external source record of the Product |
| glAccountCode | glAccountCode | GL Account Code of the Product |
| id | id | unique Id of the Product |
| isAutoProvisionable | isAutoProvisionable | flag for auto provisioning |
| isBackOrdered | isBackOrdered | flag for back ordered Product |
| isCouponRedemptionAllowed | isCouponRedemptionAllowed | flag to allow redemption of coupon |
| isCustomerDiscountAllowed | isCustomerDiscountAllowed | flag to allow customer discount on the Product |
| isDynamicBundle | isDynamicBundle | flag to highlight if a Product is part of a dynamic bundle |
| isFoodstampPaymentAllowed | isFoodstampPaymentAllowed | flag to allow food stamp payment |
| isInstallable | isInstallable | flag to install a Product |
| isIntellectualPropertyProtected | isIntellectualPropertyProtected | flag to protect the Product as intellectual property |
| isManualPriceEntryRequired | isManualPriceEntryRequired | flag to enter the price of Product manually |
| isMultipleCouponsAllowed | isMultipleCouponsAllowed | flag to allow multiple coupons on the Product |
| isPartnerDiscountAllowed | isPartnerDiscountAllowed | flag to allow partner discounts |
| isPreOrderable | isPreOrderable | flag to preorder the Product |
| isQualityVerificationRequired | isQualityVerificationRequired | flag to mandate verification of quality of the Product |
| isQuantityEntryRequired | isQuantityEntryRequired | flag to mandate entry of quantity |
| isRainCheckAllowed | isRainCheckAllowed | flag to allow rain check |
| isReturnable | isReturnable | flag to allow returning of Product |
| isSellable | isSellable | flag allow a Product to be sold |
| isSellableIndependently | isSellableIndependently | flag to allow a Product to be sold independently |
| isSellableWithoutPrice | isSellableWithoutPrice | flag to allow a Product to be sold independently |
| isSerialized | isSerialized | flag to serialize a Product |
| isWeightEntryRequired | isWeightEntryRequired | flag to enter weight of the Product |
| isWorkerDiscountAllowed | isWorkerDiscountAllowed | flag to allow discount for workers |
| longDescription | longDescription | long description of the Product |
| lotIdentity | lotIdentity | lot to identify the Product |
| manufacturerName | manufacturerName | manufacturer name of the Product |
| masterProduct | masterProduct | master Product of the Product |
| maximumOrderQuantityCount | maximumOrderQuantityCount | max. quantity that can be ordered of that Product |
| minimumAdvertisementAmount | minimumAdvertisementAmount | min. amount of advertisement of the Product |
| minimumAdvertisementAmountStartDate | minimumAdvertisementAmountStartDate | min. amount to start advertisement of the Product |
| minimumOrderQuantityCount | minimumOrderQuantityCount | min. amount of advertisement of the Product |
| modelNumber | modelNumber | model number of the Product |
| modelYear | modelYear | model year of the Product |
| mSRPAmount | mSRPAmount | MSRP amount of the Product |
| name | name | name of the Product |
| priceChargeType | priceChargeType | price change type of the Product |
| primaryProductCategory | primaryProductCategory | primary category of the Product |
| primarySalesChannel | primarySalesChannel | primary sales channel for the Product |
| productSKU | productSKU | SKU of the Product |
| productStatus | productStatus | status of the Product |
| quantityInstallmentCount | quantityInstallmentCount | quantity installment count of the Product |
| quantityInstallmentPeriod | quantityInstallmentPeriod | quantity installment period of the Product |
| quantityScheduleType | quantityScheduleType | quantity schedule type of the Product |
| requiredDepositAmount | requiredDepositAmount | requested deposit amount for the Product |
| requiredDepositPercentage | requiredDepositPercentage | requested deposit percentage for the Product |
| requiresInvididualUnitPricing | requiresInvididualUnitPricing | flag to highlight that the Product requires individual unit pricing |
| revenueInstallmentCount | revenueInstallmentCount | revenue installment count of the Product |
| revenueInstallmentPeriod | revenueInstallmentPeriod | revenue installment period of the Product |
| revenueScheduleType | revenueScheduleType | revenue schedule type of the Product |
| rewardProgramPointsCount | rewardProgramPointsCount | reward program points count of the Product |
| standardWarrantyLengthMonth | standardWarrantyLengthMonth | standard warranty length of the Product in months |
| stockLedgerValuationAmount | stockLedgerValuationAmount | stock ledger valuation amount of the Product |
| type | type | type of Product |
| validForPeriodCount | validForPeriodCount | valid for period count of the Product |
| validFromDate | validFromDate | valid from date of the Product |
| validToDate | validToDate | valid to date of the Product |
| versionNumber | versionNumber | version number of the Product |
| externalIds | vars.customerExternalIds | The externalIds of the product that are stored in MDM |
| createdDate | auditInfo.createdDate | Identifies the system or user which created the entity - default as current timestamp |
| createdBy | auditInfo.createdBy | Timestamp of when the entity was created - default as current timestamp |
| updatedBy | auditInfo.updatedBy | Identifies the system or user which last updated the entity - default as property app.name |
| updatedDate | auditInfo.updatedDate | Timestamp of when the entity was last updated - default as current timestamp |
products-post-payload
Products Create Mapping for MDM System
Source:
./src/main/resources/dwl/products-post-payload.dwl
Mapping Tables
Maps CIM Product to JSON which is used by stored procedure - sp_Products_Create
| JSON used by the stored procedure | CIM | Description |
|---|---|---|
| allowCustomerReturn | allowCustomerReturn | flag to allow customer to return a Product |
| allowPartialRefund | allowPartialRefund | flag to allow partial refund for a Product |
| brand | brand | brand of a Product |
| brandGrade | brandGrade | brand grade of a Product |
| canUseQuantitySchedule | canUseQuantitySchedule | flag for quantity schedule |
| canUseRevenueSchedule | canUseRevenueSchedule | flag for revenue schedule |
| description | description | description of the Product |
| displayUrl | displayUrl | display URL of the Product |
| disposalType | disposalType | disposal type of the Product |
| externalSourceRecord | externalSourceRecord | external source record of the Product |
| glAccountCode | glAccountCode | GL Account Code of the Product |
| id | id | unique Id of the Product |
| isAutoProvisionable | isAutoProvisionable | flag for auto provisioning |
| isBackOrdered | isBackOrdered | flag for back ordered Product |
| isCouponRedemptionAllowed | isCouponRedemptionAllowed | flag to allow redemption of coupon |
| isCustomerDiscountAllowed | isCustomerDiscountAllowed | flag to allow customer discount on the Product |
| isDynamicBundle | isDynamicBundle | flag to highlight if a Product is part of a dynamic bundle |
| isFoodstampPaymentAllowed | isFoodstampPaymentAllowed | flag to allow food stamp payment |
| isInstallable | isInstallable | flag to install a Product |
| isIntellectualPropertyProtected | isIntellectualPropertyProtected | flag to protect the Product as intellectual property |
| isManualPriceEntryRequired | isManualPriceEntryRequired | flag to enter the price of Product manually |
| isMultipleCouponsAllowed | isMultipleCouponsAllowed | flag to allow multiple coupons on the Product |
| isPartnerDiscountAllowed | isPartnerDiscountAllowed | flag to allow partner discounts |
| isPreOrderable | isPreOrderable | flag to preorder the Product |
| isQualityVerificationRequired | isQualityVerificationRequired | flag to mandate verification of quality of the Product |
| isQuantityEntryRequired | isQuantityEntryRequired | flag to mandate entry of quantity |
| isRainCheckAllowed | isRainCheckAllowed | flag to allow rain check |
| isReturnable | isReturnable | flag to allow returning of Product |
| isSellable | isSellable | flag allow a Product to be sold |
| isSellableIndependently | isSellableIndependently | flag to allow a Product to be sold independently |
| isSellableWithoutPrice | isSellableWithoutPrice | flag to allow a Product to be sold independently |
| isSerialized | isSerialized | flag to serialize a Product |
| isWeightEntryRequired | isWeightEntryRequired | flag to enter weight of the Product |
| isWorkerDiscountAllowed | isWorkerDiscountAllowed | flag to allow discount for workers |
| longDescription | longDescription | long description of the Product |
| lotIdentity | lotIdentity | lot to identify the Product |
| manufacturerName | manufacturerName | manufacturer name of the Product |
| masterProduct | masterProduct | master Product of the Product |
| maximumOrderQuantityCount | maximumOrderQuantityCount | max. quantity that can be ordered of that Product |
| minimumAdvertisementAmount | minimumAdvertisementAmount | min. amount of advertisement of the Product |
| minimumAdvertisementAmountStartDate | minimumAdvertisementAmountStartDate | min. amount to start advertisement of the Product |
| minimumOrderQuantityCount | minimumOrderQuantityCount | min. amount of advertisement of the Product |
| modelNumber | modelNumber | model number of the Product |
| modelYear | modelYear | model year of the Product |
| mSRPAmount | mSRPAmount | MSRP amount of the Product |
| name | name | name of the Product |
| priceChargeType | priceChargeType | price change type of the Product |
| primaryProductCategory | primaryProductCategory | primary category of the Product |
| primarySalesChannel | primarySalesChannel | primary sales channel for the Product |
| productSKU | productSKU | SKU of the Product |
| productStatus | productStatus | status of the Product |
| quantityInstallmentCount | quantityInstallmentCount | quantity installment count of the Product |
| quantityInstallmentPeriod | quantityInstallmentPeriod | quantity installment period of the Product |
| quantityScheduleType | quantityScheduleType | quantity schedule type of the Product |
| requiredDepositAmount | requiredDepositAmount | requested deposit amount for the Product |
| requiredDepositPercentage | requiredDepositPercentage | requested deposit percentage for the Product |
| requiresInvididualUnitPricing | requiresInvididualUnitPricing | flag to highlight that the Product requires individual unit pricing |
| revenueInstallmentCount | revenueInstallmentCount | revenue installment count of the Product |
| revenueInstallmentPeriod | revenueInstallmentPeriod | revenue installment period of the Product |
| revenueScheduleType | revenueScheduleType | revenue schedule type of the Product |
| rewardProgramPointsCount | rewardProgramPointsCount | reward program points count of the Product |
| standardWarrantyLengthMonth | standardWarrantyLengthMonth | standard warranty length of the Product in months |
| stockLedgerValuationAmount | stockLedgerValuationAmount | stock ledger valuation amount of the Product |
| type | type | type of Product |
| validForPeriodCount | validForPeriodCount | valid for period count of the Product |
| validFromDate | validFromDate | valid from date of the Product |
| validToDate | validToDate | valid to date of the Product |
| versionNumber | versionNumber | version number of the Product |
| externalIds | vars.customerExternalIds | The externalIds of the product that are stored in MDM |
| createdDate | auditInfo.createdDate | Identifies the system or user which created the entity - default as current timestamp |
| createdBy | auditInfo.createdBy | Timestamp of when the entity was created - default as current timestamp |
| updatedBy | auditInfo.updatedBy | Identifies the system or user which last updated the entity - default as property app.name |
| updatedDate | auditInfo.updatedDate | Timestamp of when the entity was last updated - default as current timestamp |
products-search-response
Products Search Mapping for MDM System
Source:
./src/main/resources/dwl/products-search-response.dwl
Mapping Tables
Maps MDM Product to CIM Product format
| CIM | MDM | Description |
|---|---|---|
| allowCustomerReturn | ALLOW_CUSTOMER_RETURN | flag to allow customer to return a Product |
| allowPartialRefund | ALLOW_PARTIAL_REFUND | flag to allow partial refund for a Product |
| brand | BRAND.NAME | brand of a Product |
| brandGrade | BRAND_GRADE | brand grade of a Product |
| canUseQuantitySchedule | CAN_USE_QUANTITY_SCHEDULE | flag for quantity schedule |
| canUseRevenueSchedule | CAN_USE_REVENUE_SCHEDULE | flag for revenue schedule |
| description | DESCRIPTION | description of the Product |
| displayUrl | DISPLAY_URL | display URL of the Product |
| disposalType | DISPOSAL_TYPE | disposal type of the Product |
| externalSourceRecord | EXTERNAL_SOURCE_RECORD | external source record of the Product |
| glAccountCode | GL_ACCOUNT_CODE | GL Account Code of the Product |
| id | ID | unique Id of the Product |
| isAutoProvisionable | IS_AUTO_PROVISIONABLE | flag for auto provisioning |
| isBackOrdered | IS_BACK_ORDERED | flag for back ordered Product |
| isCouponRedemptionAllowed | IS_COUPON_REDEMPTION_ALLOWED | flag to allow redemption of coupon |
| isCustomerDiscountAllowed | IS_CUSTOMER_DISCOUNT_ALLOWED | flag to allow customer discount on the Product |
| isDynamicBundle | IS_DYNAMIC_BUNDLE | flag to highlight if a Product is part of a dynamic bundle |
| isFoodstampPaymentAllowed | IS_FOODSTAMP_PAYMENT_ALLOWED | flag to allow food stamp payment |
| isInstallable | IS_INSTALLABLE | flag to install a Product |
| isIntellectualPropertyProtected | IS_INTELLECTUAL_PROPERTY_PROTECTED | flag to protect the Product as intellectual property |
| isManualPriceEntryRequired | IS_MANUAL_PRICE_ENTRY_REQUIRED | flag to enter the price of Product manually |
| isMultipleCouponsAllowed | IS_MULTIPLE_COUPONS_ALLOWED | flag to allow multiple coupons on the Product |
| isPartnerDiscountAllowed | IS_PARTNER_DISCOUNT_ALLOWED | flag to allow partner discounts |
| isPreOrderable | IS_PRE_ORDERABLE | flag to preorder the Product |
| isQualityVerificationRequired | IS_QUALITY_VERIFICATION_REQUIRED | flag to mandate verification of quality of the Product |
| isQuantityEntryRequired | IS_QUANTITY_ENTRY_REQUIRED | flag to mandate entry of quantity |
| isRainCheckAllowed | IS_RAIN_CHECK_ALLOWED | flag to allow rain check |
| isReturnable | IS_RETURNABLE | flag to allow returning of Product |
| isSellable | IS_SELLABLE | flag allow a Product to be sold |
| isSellableIndependently | IS_SELLABLE_INDEPENDENTLY | flag to allow a Product to be sold independently |
| isSellableWithoutPrice | IS_SELLABLE_WITHOUT_PRICE | flag to allow a Product to be sold independently |
| isSerialized | IS_SERIALIZED | flag to serialize a Product |
| isWeightEntryRequired | IS_WEIGHT_ENTRY_REQUIRED | flag to enter weight of the Product |
| isWorkerDiscountAllowed | IS_WORKER_DISCOUNT_ALLOWED | flag to allow discount for workers |
| longDescription | LONG_DESCRIPTION | long description of the Product |
| lotIdentity | LOT_IDENTIFIER | lot to identify the Product |
| manufacturerName | MANUFACTURER_NAME | manufacturer name of the Product |
| masterProduct | PRODUCT_MASTER_PRODUCT_JOIN.PRODUCT_ID_RIGHT | master Product of the Product |
| maximumOrderQuantityCount | MAXIMUM_ORDER_QUANTITY_COUNT | max. quantity that can be ordered of that Product |
| minimumAdvertisementAmount | MINIMUM_ADVERTISEMENT_AMOUNT | min. amount of advertisement of the Product |
| minimumAdvertisementAmountStartDate | MINIMUM_ADVERTISEMENT_AMOUNT_START_DATE | min. amount to start advertisement of the Product |
| minimumOrderQuantityCount | MINIMUM_ORDER_QUANTITY_COUNT | min. amount of advertisement of the Product |
| modelNumber | MODEL_NUMBER | model number of the Product |
| modelYear | MODEL_YEAR | model year of the Product |
| mSRPAmount | MSRP_AMOUNT | MSRP amount of the Product |
| name | NAME | name of the Product |
| priceChargeType | PRICE_CHARGE_TYPE | price change type of the Product |
| primaryProductCategory | PRODUCT_CATEGORY.NAME | primary category of the Product |
| primarySalesChannel | SALES_CHANNEL.NAME | primary sales channel for the Product |
| productSKU | PRODUCT_SKU | SKU of the Product |
| productStatus | PRODUCT_STATUS | status of the Product |
| quantityInstallmentCount | QUANTITY_INSTALLMENT_COUNT | quantity installment count of the Product |
| quantityInstallmentPeriod | QUANTITY_INSTALLMENT_PERIOD | quantity installment period of the Product |
| quantityScheduleType | QUANTITY_SCHEDULE_TYPE | quantity schedule type of the Product |
| requiredDepositAmount | REQUIRED_DEPOSIT_AMOUNT | requested deposit amount for the Product |
| requiredDepositPercentage | REQUIRED_DEPOSIT_PERCENTAGE | requested deposit percentage for the Product |
| requiresInvididualUnitPricing | REQUIRES_INVIDIDUAL_UNIT_PRICING | flag to highlight that the Product requires individual unit pricing |
| revenueInstallmentCount | REVENUE_INSTALLMENT_COUNT | revenue installment count of the Product |
| revenueInstallmentPeriod | REVENUE_INSTALLMENT_PERIOD | revenue installment period of the Product |
| revenueScheduleType | REVENUE_SCHEDULE_TYPE | revenue schedule type of the Product |
| rewardProgramPointsCount | REWARD_PROGRAM_POINTS_COUNT | reward program points count of the Product |
| standardWarrantyLengthMonth | STANDARD_WARRANTY_LENGTH_MONTH | standard warranty length of the Product in months |
| stockLedgerValuationAmount | STOCK_LEDGER_VALUATION_AMOUNT | stock ledger valuation amount of the Product |
| type | TYPE | type of Product |
| validForPeriodCount | VALID_FOR_PERIOD_COUNT | valid for period count of the Product |
| validFromDate | VALID_FROM_DATE | valid from date of the Product |
| validToDate | VALID_TO_DATE | valid to date of the Product |
| versionNumber | VERSION_NUMBER | version number of the Product |
| auditInfo.createdBy | CREATED_BY | Identifies the system or user which created the entity |
| auditInfo.createdDate | CREATED_DATE | Timestamp of when the entity was created - default as current timestamp |
| auditInfo.updatedBy | UPDATED_BY | Identifies the system or user which last updated the entity |
| auditInfo.updatedDate | UPDATED_DATE | Timestamp of when the entity was last updated |
| auditInfo.isDeleted | isDeleted | Indicates whether or not the entity has been soft-deleted - default as false |
products-upsert-pricebooks-payload
Products Create Mapping for MDM System
Source:
./src/main/resources/dwl/products-upsert-pricebooks-payload.dwl
Mapping Tables
Maps CIM Product to JSON which is used by stored procedure - sp_PriceBookEntry_upsert
| JSON used by the stored procedure | CIM | Description |
|---|---|---|
| allowCustomerReturn | allowCustomerReturn | flag to allow customer to return a Product |
| brand | brand | brand of a Product |
| description | description | description of the Product |
| externalSourceRecord | externalSourceRecord | external source record of the Product |
| id | id | unique Id of the Product |
| name | name | name of the Product |
| priceChargeType | priceChargeType | price change type of the Product |
| productSKU | productSKU | SKU of the Product |
| productStatus | productStatus | status of the Product |
| quantityInstallmentCount | quantityInstallmentCount | quantity installment count of the Product |
| externalIds | vars.customerExternalIds | The externalIds of the product that are stored in MDM |
| createdDate | auditInfo.createdDate | Identifies the system or user which created the entity - default as current timestamp |
| createdBy | auditInfo.createdBy | Timestamp of when the entity was created - default as current timestamp |
| updatedBy | auditInfo.updatedBy | Identifies the system or user which last updated the entity - default as property app.name |
| updatedDate | auditInfo.updatedDate | Timestamp of when the entity was last updated - default as current timestamp |
products-upsert-productcatalog-payload
Products Create Mapping for MDM System
Source:
./src/main/resources/dwl/products-upsert-productcatalog-payload.dwl
Mapping Tables
Maps CIM Product to JSON which is used by stored procedure - sp_ProductCatalog_upsert
| JSON used by the stored procedure | CIM | Description |
|---|---|---|
| activeFromDate | activeFromDate | activeFromDate of a Product |
| activeToDate | activeToDate | activeToDate of the Product |
| id | id | unique Id of the Product |
| name | name | name of the Product |
| createdDate | auditInfo.createdDate | Identifies the system or user which created the entity - default as current timestamp |
| createdBy | auditInfo.createdBy | Timestamp of when the entity was created - default as current timestamp |
| updatedBy | auditInfo.updatedBy | Identifies the system or user which last updated the entity - default as property app.name |
| updatedDate | auditInfo.updatedDate | Timestamp of when the entity was last updated - default as current timestamp |
put-productitems-payload
SalesOrderProduct Mapping for MDM System
Source:
./src/main/resources/dwl/put-productitems-payload.dwl
Mapping Tables
Maps CIM to Json which is used by stored procedure - sp_SalesOrderProduct_Upsert
| JSON used by the stored procedure | CIM | Description |
|---|---|---|
| id | id | The id of the entry in MDM system |
| description | DESCRIPTION | description of the Product |
| giftOrderMessageText | GIFT_ORDER_MESSAGE_TEXT | Gift order Message Text of the Product Item |
| isBonusProduct | IS_BONUS_PRODUCT | flag to highlight as Bonus Product |
| isBundleRoot | IS_BUNDLE_ROOT | flag to mark as Bundle root |
| isGift | IS_GIFT | flag to mark the item as Gift |
| orderedQuantity | ORDERED_QUANTITY | quantity of the Product Item ordered |
| product | product | product related to the Product Item |
| orderProductNumber | ORDER_PRODUCT_NUMBER | Product Number of the Product Item |
| quantityOrderedUOM | QUANTITY_ORDERED_UOM | unit of measure for quantity of the Product Items ordered |
| salesOrder | Sales_Order | sales order of the Product Item |
| segmentIndexNumber | SEGMENT_INDEX_NUMBER | segment Index Number of the Product Item |
| totalPriceAmount | TOTAL_PRICE_AMOUNT | total price amount of Product Items |
| totalTaxAmount | TOTAL_TAX_AMOUNT | total tax amount of Product Items |
| totalUnitPriceAmount | TOTAL_UNIT_PRICE_AMOUNT | total unit price amount of Product Items |
products-upsert-productcategory-payload
Products Create Mapping for MDM System
Source:
./src/main/resources/dwl/products-upsert-productcategory-payload.dwl
Mapping Tables
Maps CIM Product to JSON which is used by stored procedure - sp_ProductCategory_upsert
| JSON used by the stored procedure | CIM | Description |
|---|---|---|
| activeFromDate | activeFromDate | activeFromDate of a Product |
| activeToDate | activeToDate | activeToDate of the Product |
| parentCategory | parentCategory | parentCategory record of the Product |
| id | id | unique Id of the Product |
| name | name | name of the Product |
| productCatalog | productCatalog | Product Catalog of the Product |
| createdDate | auditInfo.createdDate | Identifies the system or user which created the entity - default as current timestamp |
| createdBy | auditInfo.createdBy | Timestamp of when the entity was created - default as current timestamp |
| updatedBy | auditInfo.updatedBy | Identifies the system or user which last updated the entity - default as property app.name |
| updatedDate | auditInfo.updatedDate | Timestamp of when the entity was last updated - default as current timestamp |
put-related-parties-payload
RelatedParties Upsert Mapping for MDM System
Source:
./src/main/resources/dwl/put-related-parties-payload.dwl
Mapping Tables
Maps CIM to Json which is used by stored procedure - Parties_RelatedParties_Upsert
| JSON used by the stored procedure | CIM | Description |
|---|---|---|
| id | id | The id of the entry in MDM system |
| createdBy | application name from properties | Identifies the system or user which created the entry |
| updatedBy | application name from properties | Identifies the system or user which last updated the entry |
| relatedFromDate | relatedFromDate | Related From Date with the Party |
| relatedToDate | relatedToDate | Related To Date with the Party |
| relatedParty | relatedParty | Indicates the Party that its related to |
| partyRelationshipType | partyRelationshipType | Pre-defined relation ship between parties |