FINS MDM Customers System API - Implementation Template

(0 reviews)

Data mappings

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

ModuleDescription
contactpointsaddress-storedprocedure-requestContactPointAddress Create/Update Mapping for MDM System
contactpointsemail-storedprocedure-requestContactPointEmail Create/Update Mapping for MDM System
contactpointsphone-storedprocedure-requestContactPointPhone Create/Update Mapping for MDM System
contactpoints-get-responseContactPoint Retrieve Mapping for MDM System
get-contactpoints-externalids-responseExternalIds Query Mapping for MDM System
customers-post-payloadCustomer Create Mapping for MDM System
customers-patch-payloadCustomer Update Mapping for MDM System. Checks are done to see if the value exists in DB, and only updated is the incoming request has a not null value. Some of the fields cannot be updated and they are ignored.
customers-get-responseCustomer Retrieve Mapping for MDM System
customers-search-responseCustomer Search Mapping for MDM System
post-externalids-payloadExternalIds Upsert Mapping for MDM System
get-externalids-responseExternalIds Query Mapping for MDM System
partyroles-get-responsePartyRoles Retrieve Mapping for MDM System
get-related-parties-responseRelatedParties Retrieve Mapping for MDM System
put-related-parties-payloadRelatedParties Upsert Mapping for MDM System
parties-get-responseParties Query Mapping for MDM System
parties-related-parties-externalidsExternalIds Query Mapping for MDM System
individuals-post-payloadCreate Individual Mapping for MDM System. Maps CIM Individual to JSON which is used by stored procedure sp_Individuals_Create. The fields in both CIM and JSON are identical.
individuals-patch-payloadUpdate Individual Mapping for MDM System. Maps CIM Indiviudal to payload which is used as input parameter in the update query of INDIVIDUAL table. The fields in both CIM and MDM are identical. PATCH payload is created by validating the Input Request payload with DB Record Payload. Few of the DB fields will not be updated as they are not allowed.
individuals-get-responseSearch and Retrieve of Individual Mappings for MDM System
organizations-post-payloadCreate organization Mapping for MDM System. Maps CIM organization to JSON which is used by stored procedure sp_Organizations_Create. The fields in both CIM and JSON are identical.
organizations-patch-payloadCreate Organization Mapping for MDM System Maps CIM Organization to payload which is used as input parameter in the update query of ORGANIZATION table. The fields in both CIM and MDM are identical. PATCH payload is created by validating the Input Request payload with DB Record Payload.
organizations-get-responseRetrieve Organization Mapping for MDM System
households-post-payloadCreate Household Mapping for MDM System. Maps CIM Household to payload which is used as input parameter to insert into Household table. The fields in both CIM and MDM are identical.
households-patch-payloadMapping for MDM System to Update Household. Maps CIM Household to payload which is used as input parameter in the update Household table. The fields in both CIM and MDM are identical. PATCH payload is created by validating the Input Request payload with DB Record Payload.
households-get-responseRetrieve and Search Household Mapping for MDM System

contactpointsaddress-storedprocedure-request

ContactPointAddress Create/Update Mapping for MDM System

Source: ./src/main/resources/dwl/contactpointsaddress-storedprocedure-request.dwl

(back to top)

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 procedureCIMDefault ValueDescription
ididThe id of the contactpoint
contactPointTypecontactPointTypeThe type of contact point
activeFromDateactiveFromDatenow()The date from which contactpoint is active
activeToDateactiveToDateThe date until which contactpoint is active
bestTimeToContactEndTimebestTimeToContactEndTimeThe best time to contact end time
bestTimeToContactStartTimebestTimeToContactStartTimeThe best time to contact start time
createdByauditInfo.createdByp('app.name')Identifies the system or user which created the entity
createdDateauditInfo.createdDatenow()Timestamp of when the entity was created
emailAddressemailAddress""The email address of the contactpoint
emailBouncedReasonemailBouncedReasonThe reason indicating why the email bounces
emailDomainemailDomainThe domain of the email address
emailLatestBounceDateTimeemailLatestBounceDateTimeTimestamp of when the email last bounced
emailMailBoxemailMailBoxThe email mail box to which email must be delivered
forBusinessUseforBusinessUseFlag to indicate whether this contactpoint is used for business purpose
forPersonalUseforPersonalUseFlag to indicate whether this contactpoint is used for personal use
isUsedForBillingisUsedForBillingFlag to indicate whether the email address is used for billing
isUsedForShippingisUsedForShippingFlag to indicate whether the email address is used for shipping
namenameThe name of the contactpoint email address
primaryFlagprimaryFlagFlag to indicate if the email address is primary
profileFirstCreatedDateprofileFirstCreatedDateTimestamp of when the profile was first created
profileLastUpdatedDateprofileLastUpdatedDateTimestamp of when the profile was last updated
profileOccurrenceCountprofileOccurrenceCountThe occurrence of profile
updatedByauditInfo.updatedByp('app.name')Identifies the system or user which last updated the entity
updatedDateauditInfo.updatedDatenow()Timestamp of when the entity was last updated

(back to top)

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 procedureCIMDefault ValueDescription
ididThe id of the contactpoint
contactPointTypecontactPointTypeThe type of contact point
activeFromDateactiveFromDatenow()The date from which contactpoint is active
activeToDateactiveToDateThe date until which contactpoint is active
areaCodeareaCodeThe area code of the contactpoint
bestTimeToContactEndTimebestTimeToContactEndTimeThe best time to contact end time
bestTimeToContactStartTimebestTimeToContactStartTimeThe best time to contact start time
countryNamecountryNameThe country name of the contact point phone
createdByauditInfo.createdByp('app.name')Identifies the system or user which created the entity
createdDateauditInfo.createdDatenow()Timestamp of when the entity was created
extensionNumberextensionNumberThe extension number of the contactpoint phone
formattedE164PhoneNumberformattedE164PhoneNumberThe formatted E164 phone number
formattedInternationalPhoneNumberformattedInternationalPhoneNumberThe formatted international phone number
formattedNationalPhoneNumberformattedNationalPhoneNumber"000-000-0000"The formatted national phone number
forBusinessUseforBusinessUseFlag to inidicate whether this contactpoint is used for business purpose
forPersonalUseforPersonalUseFlag to inidicate whether this contactpoint is used for personal use
isFaxCapableisFaxCapableFlag to indicate whether the contactpoint phone is fax capable
isSMSCapableisSMSCapableFlag to indicate whether the contactpoint phone is sms capable
namenameThe name of the contactpoint phone
phoneCountryCodephoneCountryCodeThe country code of the contactpoint phone
primaryFlagprimaryFlagFlag to indicate if the phone is primary
primaryPhoneTypeprimaryPhoneTypeThe type of primary phone
profileFirstCreatedDateprofileFirstCreatedDateTimestamp of when the profile was first created
profileLastUpdatedDateprofileLastUpdatedDateTimestamp of when the profile was last updated
profileOccurrenceCountprofileOccurrenceCountThe occurence of profile
shortCodeshortCodeThe short code of the contactpoint
telephoneNumbertelephoneNumber"000-000-0000"Telephone number of the contactpoint
updatedByauditInfo.updatedByp('app.name')Identifies the system or user which last updated the entity
updatedDateauditInfo.updatedDatenow()Timestamp of when the entity was last updated

(back to top)

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

CIMMDMDefault ValueDescription
For each caitem in CONTACT_POINT_ADDRESS
idcaitem.IDThe id of the contactpoint
activeFromDatecaitem.ACTIVE_FROM_DATEThe date from which contactpoint is active
activeToDatecaitem.ACTIVE_TO_DATEThe date until which contactpoint is active
addressLine1caitem.ADDRESS_LINE1The address line1 of the contactpoint address
addressLine2caitem.ADDRESS_LINE2The address line2 of the contactpoint address
addressLine3caitem.ADDRESS_LINE3The address line3 of the contactpoint address
addressLine4caitem.ADDRESS_LINE4The address line4 of the contactpoint address
bestTimeToContactEndTimecaitem.BEST_TIME_TO_CONTACT_END_TIMEThe best time to contact end time
bestTimeToContactStartTimecaitem.BEST_TIME_TO_CONTACT_START_TIMEThe best time to contact start time
cityNamecaitem.CITY_NAMEThe city name of the contactpoint address
countryNamecaitem.COUNTRY_NAMEThe country name of the contactpoint address
contactPointType"ContactPointAddress"The type of contactpoint type
forBusinessUsecaitem.FOR_BUSINESS_USEFlag to indicate whether this contactpoint is used for business purpose
forPersonalUsecaitem.FOR_PERSONAL_USEFlag to indicate whether this contactpoint is used for personal use
geoAccuracycaitem.GEO_ACCURACYThe geo accuracy of the contactpoint address
geoLatitudecaitem.GEO_LATITUDEThe geo latitude of the contactpoint address
geoLongitudecaitem.GEO_LONGITUDEThe geo longitude of the contactpoint address
isUsedForBillingcaitem.IS_USED_FOR_BILLINGFlag to indicate whether the address is used for billing
isUsedForShippingcaitem.IS_USED_FOR_SHIPPINGFlag to indicate whether the address is used for billing
namecaitem.CONTACT_POINT_ADDRESS_NAMEThe name of the contactpoint address
postalCodeTextcaitem.POSTAL_CODE_TEXTThe postalcode of the contactpoint address
primaryFlagcaitem.PRIMARY_FLAGFlag to indicate if the address is primary
profileFirstCreatedDatecaitem.PROFILE_FIRST_CREATED_DATTimestamp of when the profile was first created
profileLastUpdatedDatecaitem.PROFILE_LAST_UPDATED_DATETimestamp of when the profile was last updated
profileOccurrenceCountcaitem.PROFILE_OCCURRENCE_COUNTThe occurence of profile
stateProvinceNamecaitem.STATE_PROVINCE_NAMEThe state province of the contactpoint address
auditInfo.createdBycaitem.CREATED_BYIdentifies the system or user which created the entity
auditInfo.createdDatecaitem.CREATED_DATETimestamp of when the entity was created
auditInfo.updatedBycaitem.UPDATED_BYIdentifies the system or user which last updated the entity
auditInfo.updatedDatecaitem.UPDATED_DATETimestamp of when the entity was last updated
auditInfo.isDeletedcaitem.isDeletedfalseIndicates whether or not the entity has been soft-deleted
END of foreach loop
For each cpitem in CONTACT_POINT_PHONE
idcpitem.IDThe id of the contactpoint
activeFromDatecpitem.ACTIVE_FROM_DATEThe date from which contactpoint is active
activeToDatecpitem.ACTIVE_TO_DATEThe date until which contactpoint is active
areaCodecpitem.AREA_CODEThe area code of the contactpoint
bestTimeToContactEndTimecpitem.BEST_TIME_TO_CONTACT_END_TIMEThe best time to contact end time
bestTimeToContactStartTimecpitem.BEST_TIME_TO_CONTACT_START_TIMEThe best time to contact start time
countryNamecpitem.COUNTRY_NAMEThe country name of the contact point phone
contactPointType"ContactPointPhone"The type of contact point
extensionNumbercpitem.EXTENSION_NUMBERThe extension number of the contactpoint phone
forBusinessUsecpitem.FOR_BUSINESS_USEFlag to inidicate whether this contactpoint is used for business purpose
formattedE164PhoneNumbercpitem.FORMATTED_E164_PHONE_NUMBERThe formatted E164 phone number
formattedInternationalPhoneNumbercpitem.FORMATTED_INTERNATIONAL_PHONE_NUMBERThe formatted international phone number
formattedNationalPhoneNumbercpitem.FORMATTED_NATIONAL_PHONE_NUMBERThe formatted national phone number
forPersonalUsecpitem.FOR_PERSONAL_USEFlag to inidicate whether this contactpoint is used for personal use
isFaxCapablecpitem.IS_FAX_CAPABLEFlag to indicate whether the contactpoint phone is fax capable
isSMSCapablecpitem.IS_SM_SCAPABLEFlag to indicate whether the contactpoint phone is sms capable
namecpitem.CONTACT_POINT_PHONE_NAMEThe name of the contactpoint phone
phoneCountryCodecpitem.PHONE_COUNTRY_CODEThe country code of the contactpoint phone
primaryFlagcpitem.PRIMARY_FLAGFlag to indicate if the phone is primary
primaryPhoneTypecpitem.PRIMARY_PHONE_TYPEThe type of primary phone
profileFirstCreatedDatecpitem.PROFILE_FIRST_CREATED_DATETimestamp of when the profile was first created
profileLastUpdatedDatecpitem.PROFILE_LAST_UPDATED_DATETimestamp of when the profile was last updated
profileOccurrenceCountcpitem.PROFILE_OCCURRENCE_COUNTThe occurence of profile
shortCodecpitem.SHORT_CODEThe short code of the contactpoint
telephoneNumbercpitem.TELEPHONE_NUMBERTelephone number of the contactpoint
auditInfo.createdBycpitem.CREATED_BYIdentifies the system or user which created the entity
auditInfo.createdDatecpitem.CREATED_DATETimestamp of when the entity was created
auditInfo.updatedBycpitem.UPDATED_BYIdentifies the system or user which last updated the entity
auditInfo.updatedDatecpitem.UPDATED_DATETimestamp of when the entity was last updated
auditInfo.isDeletedcpitem.isDeletedfalseIndicates whether or not the entity has been soft-deleted
end of for each loop
For each ceitem in CONTACT_POINT_EMAIL
idceitem.IDThe id of the contactpoint
activeFromDateceitem.ACTIVE_FROM_DATEThe date from which contactpoint is active
activeToDateceitem.ACTIVE_TO_DATEThe date until which contactpoint is active
bestTimeToContactEndTimeceitem.BEST_TIME_TO_CONTACT_END_TIMEThe best time to contact end time
bestTimeToContactStartTimeceitem.BEST_TIME_TO_CONTACT_START_TIMEThe best time to contact start time
contactPointType"ContactPointEmail"The type of contact point
emailAddressceitem.EMAIL_ADDRESSThe email address of the contactpoint
emailBouncedReasonceitem.EMAIL_LATEST_BOUNCE_REASON_TEXTThe reason indicating why the email bounces
emailDomainceitem.EMAIL_DOMAINThe domain of the email address
emailLatestBounceDateTimeceitem.EMAIL_LATEST_BOUNCE_DATE_TIMETimestamp of when the email last bounced
emailMailBoxceitem.EMAIL_MAIL_BOXThe email mail box to which email must be delivered
forBusinessUseceitem.FOR_BUSINESS_USEFlag to indicate whether this contactpoint is used for business purpose
forPersonalUseceitem.FOR_PERSONAL_USEFlag to indicate whether this contactpoint is used for personal use
nameceitem.CONTACT_POINT_EMAILADDRESS_NAMEThe name of the contactpoint email address
primaryFlagceitem.PRIMARY_FLAGFlag to indicate if the email address is primary
profileFirstCreatedDateceitem.PROFILE_FIRST_CREATED_DATETimestamp of when the profile was first created
profileLastUpdatedDateceitem.PROFILE_LAST_UPDATED_DATETimestamp of when the profile was last updated
profileOccurrenceCountceitem.PROFILE_OCCURRENCE_COUNTThe occurence of profile
auditInfo.createdByceitem.CREATED_BYIdentifies the system or user which created the entity
auditInfo.createdDateceitem.CREATED_DATETimestamp of when the entity was created
auditInfo.updatedByceitem.UPDATED_BYIdentifies the system or user which last updated the entity
auditInfo.updatedDateceitem.UPDATED_DATETimestamp of when the entity was last updated
auditInfo.isDeletedceitem.IS_DELETEDfalseIndicates whether or not the entity has been soft-deleted
END of foreach loop

(back to top)

get-contactpoints-externalids-response

ExternalIds Query Mapping for MDM System

Source: ./src/main/resources/dwl/get-contactpoints-externalids-response.dwl

Variables

var outputPayload

outputPayload variable is the maps the result of select query on MDM EXTERNAL_ID table.

(back to top)

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 procedureCIMDescription
churnScorechurnScoreThe churn score of the customer
customerNumbercustomerNumberThe Customer Number to be stored in MDM
customerSatisfactionScorecustomerSatisfactionScoreThe customer satisfaction score
customerStatuscustomerStatusThe status of the customer
ididThe id of the customer
last12MonthsNewRevenueAmountlast12MonthsNewRevenueAmountThe last 12 months new revenue amount of the customer
last12MonthsSupportCallCountlast12MonthsSupportCallCountThe last 12 months support call count made by the customer
last24MonthsNewRevenueAmountlast24MonthsNewRevenueAmountThe last 24 months new revenue amount of the customer
marketingEmailResponseRatemarketingEmailResponseRateMarketing email response rate of the customer
netPromoterScorenetPromoterScoreThe net promoter score of the customer
originatingCustomerSourceoriginatingCustomerSourceThe originating source of the customer
prospectRatingprospectRatingThe prospect rating of the customer
totalBookingsAmounttotalBookingsAmountThe total bookings amount made by the customer
totalContractedAmounttotalContractedAmountThe total contracted amount
totalLifeTimeValuetotalLifeTimeValueThe total lifetime value of the customer
totalProfitContributionAmounttotalProfitContributionAmountThe total profit contribution amount by the customer
partyIdparty[0]The id of the individual as party
partyRoleTypepartyRoleType"Customer"The type of party role - default as Customer
createdDateauditInfo.createdDateIdentifies the system or user which created the entity - default as current timestamp
createdByauditInfo.createdByTimestamp of when the entity was created - default as current timestamp
updatedByauditInfo.updatedByIdentifies the system or user which last updated the entity - default as property app.name
updatedDateauditInfo.updatedDateTimestamp of when the entity was last updated - default as current timestamp

(back to top)

customers-patch-payload

Customer Update Mapping for MDM System. Checks are done to see if the value
exists in DB, and only updated is the incoming request has a not null value.
Some of the fields cannot be updated and they are ignored.

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 JSON used to update MDM PATCH payload is created by validating the Input Request payload with DB Record Payload.

MDMCIMDescription
idvars.customerIdThe id of the customer in MDM
churnScoreif(CHURN_SCORE?) CHURN_SCORE else payloadRecordfromDB.churnScoreThe churn score of the customer
createdByp('app.name')Identifies the system or user which created the entity - default as property app.name
createdDatenow()Timestamp of when the entity was created - default as current timestamp
customerNumberif(CUSTOMER_NUMBER?) CUSTOMER_NUMBER else payloadRecordfromDB.customerNumberThe Customer Number to be stored in MDM
customerSatisfactionScoreif(CUSTOMER_SATISFACTION_SCORE?) CUSTOMER_SATISFACTION_SCORE else payloadRecordfromDB.customerSatisfactionScoreThe customer satisfaction score
customerStatusif(CUSTOMER_STATUS?) CUSTOMER_STATUS else payloadRecordfromDB.customerStatusThe status of the customer
last12MonthsNewRevenueAmountif(LAST12_MONTHS_NEW_REVENUE_AMOUNT?) LAST12_MONTHS_NEW_REVENUE_AMOUNT else payloadRecordfromDB.last12MonthsNewRevenueAmountThe last 12 months new revenue amount of the customer
last12MonthsSupportCallCountif(LAST12_MONTHS_SUPPORT_CALL_COUNT?) LAST12_MONTHS_SUPPORT_CALL_COUNT else payloadRecordfromDB.last12MonthsSupportCallCountThe last 12 months support call count made by the customer
last24MonthsNewRevenueAmount: if(LAST24_MONTHS_NEW_REVENUE_AMOUNT?) LAST24_MONTHS_NEW_REVENUE_AMOUNT else payloadRecordfromDB.last24MonthsNewRevenueAmountThe last 24 months new revenue amount of the customer
marketingEmailResponseRateif(MARKETING_EMAIL_RESPONSE_RATE?) MARKETING_EMAIL_RESPONSE_RATE else payloadRecordfromDB.marketingEmailResponseRateMarketing email response rate of the customer
netPromoterScoreif(NET_PROMOTER_SCORE?) NET_PROMOTER_SCORE else payloadRecordfromDB.netPromoterScoreThe net promoter score of the customer
originatingCustomerSourceif(ORIGINATING_CUSTOMER_SOURCE?) ORIGINATING_CUSTOMER_SOURCE else payloadRecordfromDB.originatingCustomerSourceThe originating source of the customer
prospectRatingif(PROSPECT_RATING?) PROSPECT_RATING else payloadRecordfromDB.prospectRatingThe prospect rating of the customer
totalBookingsAmountif(TOTAL_BOOKINGS_AMOUNT?) TOTAL_BOOKINGS_AMOUNT else payloadRecordfromDB.totalBookingsAmountThe total bookings amount made by the customer
totalContractedAmountif(TOTAL_CONTRACTED_AMOUNT?) TOTAL_CONTRACTED_AMOUNT else payloadRecordfromDB.totalContractedAmountThe total contracted amount
totalLifeTimeValueif(TOTAL_LIFE_TIME_VALUE?) TOTAL_LIFE_TIME_VALUE else payloadRecordfromDB.totalLifeTimeValueThe total lifetime value of the customer
totalProfitContributionAmountif(TOTAL_PROFIT_CONTRIBUTION_AMOUNT?) TOTAL_PROFIT_CONTRIBUTION_AMOUNT else payloadRecordfromDB.totalProfitContributionAmountThe total profit contribution amount by the customer
updatedByp('app.name')Identifies the system or user which last updated the entity - default as property app.name
updatedDatenow()Timestamp of when the entity was last updated - default as current timestamp
partyIdif(party?) party[0] else payloadRecordfromDB.party[0]The id of the individual as party
partyRoleTypeif(PARTY_ROLE_TYPE?) PARTY_ROLE_TYPE else payloadRecordfromDB.partyRoleTypeThe type of party role - default as Customer

(back to top)

customers-get-response

Customer Retrieve Mapping for MDM System

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

Mapping Tables

Maps MDM Customer to CIM Customer format

CIMMDMDescription
idIDThe id of the customer in MDM system
churnScoreCHURN_SCOREThe churn score of the customer
customerNumberCUSTOMER_NUMBERThe Customer Number in MDM
customerSatisfactionScoreCUSTOMER_SATISFACTION_SCOREThe customer satisfaction score
customerStatusCUSTOMER_STATUSThe status of the customer in MDM system
last12MonthsNewRevenueAmountLAST12_MONTHS_NEW_REVENUE_AMOUNTThe last 12 months new revenue amount of the customer
last12MonthsSupportCallCountLAST12_MONTHS_SUPPORT_CALL_COUNTThe last 12 months support call count made by the customer
last24MonthsNewRevenueAmountLAST24_MONTHS_NEW_REVENUE_AMOUNTThe last 24 months new revenue amount of the customer
marketingEmailResponseRateMARKETING_EMAIL_RESPONSE_RATEMarketing email response rate of the customer
netPromoterScoreNET_PROMOTER_SCOREThe net promoter score of the customer
originatingCustomerSourceORIGINATING_CUSTOMER_SOURCEThe originating source of the customer
party[ if(vars.individualRecord != null) (vars.individualRecord) else PARTY_ID ]The id of the individual as party
partyRoleTypePARTY_ROLE_TYPEThe type of party role - default as Customer
prospectRatingPROSPECT_RATINGThe prospect rating of the customer
totalBookingsAmountTOTAL_BOOKINGS_AMOUNTThe total bookings amount made by the customer
totalContractedAmountTOTAL_CONTRACTED_AMOUNTThe total contracted amount
totalLifeTimeValueTOTAL_LIFE_TIME_VALUEThe total lifetime value of the customer
totalProfitContributionAmountTOTAL_PROFIT_CONTRIBUTION_AMOUNTThe total profit contribution amount by the customer
externalIdsvars.customerExternalIdsThe externalIds of the customer that are stored in MDM
auditInfo.createdByCREATED_BYIdentifies the system or user which created the customer
auditInfo.createdDateCREATED_DATETimestamp of when the customer was created - default as current timestamp
auditInfo.updatedByUPDATED_BYIdentifies the system or user which last updated the customer
auditInfo.updatedDateUPDATED_DATETimestamp of when the entity was last updated
auditInfo.isDeletedisDeletedIndicates whether or not the customer has been soft-deleted - default as false

(back to top)

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

CIMMDMDescription
idIDThe id of the customer in MDM system
churnScoreCHURN_SCOREThe churn score of the customer
customerNumberCUSTOMER_NUMBERThe Customer Number in MDM
customerSatisfactionScoreCUSTOMER_SATISFACTION_SCOREThe customer satisfaction score
customerStatusCUSTOMER_STATUSThe status of the customer in MDM system
last12MonthsNewRevenueAmountLAST12_MONTHS_NEW_REVENUE_AMOUNTThe last 12 months new revenue amount of the customer
last12MonthsSupportCallCountLAST12_MONTHS_SUPPORT_CALL_COUNTThe last 12 months support call count made by the customer
last24MonthsNewRevenueAmountLAST24_MONTHS_NEW_REVENUE_AMOUNTThe last 24 months new revenue amount of the customer
marketingEmailResponseRateMARKETING_EMAIL_RESPONSE_RATEMarketing email response rate of the customer
netPromoterScoreNET_PROMOTER_SCOREThe net promoter score of the customer
originatingCustomerSourceORIGINATING_CUSTOMER_SOURCEThe originating source of the customer
party[0]The individual information as party
idif(vars.individualRecord != null) (vars.individualRecord) else PARTY_IDThe id of the individual
partyTypePARTY_TYPEThe party type
personNamePERSON_NAMEThe person name of the individual
contactPoints [0]
contactPointType['ContactPointEmail']The contactpoint type Email
idEMAIL_IDThe id of the contactpoint stored in MDM
activeFromDateEMAIL_ACTIVE_FROM_DATEThe date from which the email address is active
emailAddressEMAIL_ADDRESSThe emailaddress of the individual stored in MDM
contactPoints [1]
contactPointType['ContactPointPhone']The contactpoint type Phone
idPHONE_IDThe id of the contactpoint stored in MDM
activeFromDatePHONE_ACTIVE_FROM_DATEThe date from which the Phone is active
formattedNationalPhoneNumberFORMATTED_NATIONAL_PHONE_NUMBERThe formatted national phone number of the individual stored in MDM
telephoneNumberTELEPHONE_NUMBERThe telephone number of the individual stored in MDM
partyRoleTypePARTY_ROLE_TYPEThe type of party role - default as Customer
prospectRatingPROSPECT_RATINGThe prospect rating of the customer
totalBookingsAmountTOTAL_BOOKINGS_AMOUNTThe total bookings amount made by the customer
totalContractedAmountTOTAL_CONTRACTED_AMOUNTThe total contracted amount
totalLifeTimeValueTOTAL_LIFE_TIME_VALUEThe total lifetime value of the customer
totalProfitContributionAmountTOTAL_PROFIT_CONTRIBUTION_AMOUNTThe total profit contribution amount by the customer
(externalIdsvars.customerExternalIds) if (vars.customerExternalIds !=null and !(isEmpty(vars.customerExternalIds)))The external Ids of the customer that are stored in MDM
auditInfo.createdByCREATED_BYIdentifies the system or user which created the entity
auditInfo.createdDateCREATED_DATETimestamp of when the entity was created
auditInfo.updatedByUPDATED_BYIdentifies the system or user which last updated the entity
auditInfo.updatedDateUPDATED_DATETimestamp of when the entity was last updated
auditInfo.isDeletedisDeleted default falseIndicates whether or not the entity has been soft-deleted - default as false

(back to top)

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 procedureCIMDescription
ididThe id of the entry in MDM system
externalIdexternalIdA unique identifier assigned to the individual in another system
createdByapplication name from propertiesIdentifies the system or user which created the entry
updatedByapplication name from propertiesIdentifies the system or user which last updated the entry
externalIdTypeexternalIdTypeIdentifies the system that owns or otherwise recognises this unique identifier
statusstatusIndicates whether this identifier is currently valid or not
statusLastChangedDatestatusLastChangedDateDate and time of the last change in status

(back to top)

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.

(back to top)

partyroles-get-response

PartyRoles Retrieve Mapping for MDM System

Source: ./src/main/resources/dwl/partyroles-get-response.dwl

Mapping Tables

Maps MDM PartyRole to CIM PartyRole format

CIM - partyRoleMDM - PARTY_ROLEDescription
idIDThe id of the customer in MDM system
partyRoleTypePARTY_ROLE_TYPEThe party role type stored in MDM
party.idPARTY_IDThe party identifier stored in MDM
partyTypePARTY_TYPEThe party type stores in MDM
globalPartyGLOBAL_PARTYThe global party stored in MDM
noMergeReasonNO_MERGE_REASONThe reason for no merge

(back to top)

RelatedParties Retrieve 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

CIMMDM DBDescription
idIDThe id of the entry in MDM system
relatedFromDateRELATED_FROM_DATERelated From Date with the Party
relatedToDateRELATED_TO_DATERelated To Date with the Party
relatedPartyPARTY_RELATED_PARTY_IDIndicates the Party that its related to
partyRelationshipTypePARTY_RELATION_TYPE.NAMEPre-defined relation ship between parties

(back to top)

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 procedureCIMDescription
ididThe id of the entry in MDM system
createdByapplication name from propertiesIdentifies the system or user which created the entry
updatedByapplication name from propertiesIdentifies the system or user which last updated the entry
relatedFromDaterelatedFromDateRelated From Date with the Party
relatedToDaterelatedToDateRelated To Date with the Party
relatedPartyrelatedPartyIndicates the Party that its related to
partyRelationshipTypepartyRelationshipTypePre-defined relation ship between parties

(back to top)

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 - partyRoleMDM - PARTY_ROLEDescription
idIDThe party identifier stored in MDM
partyTypePARTY_TYPEThe party type stored in MDM
globalPartyGLOBAL_PARTYThe global party stored in MDM
noMergeReasonNO_MERGE_REASONThe reason for no merge

(back to top)

ExternalIds Query Mapping for MDM System

Source: ./src/main/resources/dwl/parties-related-parties-externalids.dwl

(back to top)

individuals-post-payload

Create Individual Mapping for MDM System. Maps CIM Individual to JSON which
is used by stored procedure sp_Individuals_Create.
The fields in both CIM and JSON are identical.

Source: ./src/main/resources/dwl/individuals-post-payload.dwl

Mapping Tables

Maps CIM Individual to MDM Individual as in DB

CIMMDM DBDescription
birthDateBIRTH_DATEBirth date of the individual
birthPlaceBIRTH_PLACEBirth place of the individual
childrenCountCHILDREN_COUNTNo. of children for the individual
consumerCreditScoreCONSUMER_CREDIT_SCOREConsumer credit score of the individual
consumerCreditScoreProviderNameCONSUMER_CREDIT_SCORE_PROVIDER_NAMEConsumer credit score Provider related to the individual
convictionsCountCONVICTIONS_COUNTCount of convictions related to the individual
createdByCREATED_BYIdentifies the system or user which created the individual - default as property app.name
createdOnCREATED_ONIdentifies the date on which the individual was created - default as sysdate
currentEmployerNameCURRENT_EMPLOYER_NAMECurrent employer name of the individual
deathDateDEATH_DATEDeath date of the individual (if applicable)
deathPlaceDEATH_PLACEDeath place of the individual
dependentCountDEPENDENT_COUNTNo. of dependents related to the individual
doExtractMyDataUpdateDateDO_EXTRACT_MY_DATA_UPDATE_DATEUpdate date to extract data related to the individual
doForgetMeFromUpdateDateDO_FORGET_ME_FROM_UPDATE_DATEUpdate date to forget the individual
doNotMarketFromUpdateDateDO_NOT_MARKET_FROM_UPDATE_DATEUpdate date to market the individual
doNotProcessFromUpdateDateDO_NOT_PROCESS_FROM_UPDATE_DATEUpdate date to not process the individual
doNotProcessReasonDO_NOT_PROCESS_REASONReason to not process the individual
doNotProfileFromUpdateDateDO_NOT_PROFILE_FROM_UPDATE_DATEUpdate date to not profile the individual
doNotTrackLocationUpdateDateDO_NOT_TRACK_LOCATION_UPDATE_DATEUpdate date to not track the location of the individual
doNotTrackUpdateDateDO_NOT_TRACK_UPDATE_DATEUpdate date to not track the individual
employedSinceDateEMPLOYED_SINCE_DATEEmployed since date of the individual
ethnicityETHNICITYEthnicity of the individual
firstNameFIRST_NAMEFirst name of the individual
genderGENDERGender of the individual
globalPartyGLOBAL_PARTYGlobal Party of the the individual
hasAlcoholAbuseHistoryHAS_ALCOHOL_ABUSE_HISTORYFlag to mark alcohol abuse history
hasDrugAbuseHistoryHAS_DRUG_ABUSE_HISTORYFlag to mark drug abuse history
highestEducationLevelHIGHEST_EDUCATION_LEVELHighest education level of the individual
hospitalizationsLast5YearsCountHOSPITALIZATIONS_LAST5_YEARS_COUNTNo. of hospitalization in last 5 years
idIDUnique Id to identify the individual
influencerRatingINFLUENCER_RATINGInfluence rating of the individual
isAlcoholConsumerIS_ALCOHOL_CONSUMERFlag to mark as alcohol consumer
isDrugConsumerIS_DRUG_CONSUMERFlag to mark as drug consumer
isGoodDriverIS_GOOD_DRIVERFlag to mark as a good driver
isGoodStudentIS_GOOD_STUDENTFlag to mark as a good student
isHighRiskHobbyIS_HIGH_RISK_HOBBYFlag to highlight individual has high risk hobby
isHighRiskOccupationIS_HIGH_RISK_OCCUPATIONFlag to highlight individual has high risk occupation
isHomeOwnerIS_HOME_OWNERFlag to mark as a home owner
isTobaccoConsumeIS_TOBACCO_CONSUMEFlag to mark individual consumes tobacco
lastNameLAST_NAMELast name of the individual
mailingNameMAILING_NAMEMailing name of the individual
mainDietaryHabitTypeMAIN_DIETARY_HABIT_TYPEMain dietary habit type of the individual
mainDisabilityTypeMAIN_DISABILITY_TYPEMain disability habit type of the individual
mainLifeAttitudeTypeMAIN_LIFE_ATTITUDE_TYPEMain life attitude type of the individual
mainLifeStyleTypeMAIN_LIFE_STYLE_TYPEMain life style type of the individual
mainPersonalityTypeMAIN_PERSONAL_VALUE_TYPEMain personality type of the individual
mainPersonalValueTypeMAIN_PERSONALITY_TYPEMain personal value type of the individual
majorCitationCountMAJOR_CITATION_COUNTNo. of citations related to the individual
maritalStatusMARITAL_STATUSMarital status of the individual
middleNameMIDDLE_NAMEMiddle name of the individual
militaryServiceMILITARY_SERVICEMilitary service of the individual
militaryStatusMILITARY_STATUSMilitary status of the individual
minorCitationCountMINOR_CITATION_COUNTNo. of minor citations related to the individual
mothersMaidenNameMOTHERS_MAIDEN_NAMEMothers maiden name of the individual
nameSuffixNAME_SUFFIXName suffix of the individual
netWorthNET_WORTHNetworth of the individual
noMergeReasonNO_MERGE_REASONReason to not merge the individual
occupationOCCUPATIONOccupation of the individual
occupationTypeOCCUPATION_TYPEOccupation type of the individual
officialNameOFFICIAL_NAMEOfficial name of the individual
orderingNameORDERING_NAMEOrdering name of the individual
overAgeNumberOVER_AGE_NUMBEROverage number of the individual
partyTypePARTY_TYPEParty type of the individual
personHeightPERSON_HEIGHTPerson height of the individual
personHeightUnitOfMeasurePERSON_HEIGHT_UNIT_OF_MEASUREUnit of measure used to measure person height of the individual
personLifeStagePERSON_LIFE_STAGEPerson life stage of the individual
personNamePERSON_NAMEPerson name of the individual
personWeightPERSON_WEIGHTPerson weight of the individual
personWeightUnitOfMeasurePERSON_WEIGHT_UNIT_OF_MEASUREUnit of measure used to measure person weight of the individual
photoURLPHOTO_URLURL to the photo of the individual
preferredNamePREFERRED_NAMEPreferred name of the individual
primaryHobbyPRIMARY_HOBBYPrimary hobby of the individual
religionRELIGIONReligion of the individual
residenceCaptureMethodRESIDENCE_CAPTURE_METHODResidence capture method of the individual
residenceCountryNameRESIDENCE_COUNTRY_NAMECountry of residence of the individual
salutationSALUTATIONSalutation of the individual
secondLastNameSECOND_LAST_NAMESecond last name of the individual
sendIndividualDataSEND_INDIVIDUAL_DATAFlag to mark if individual data can be sent related to the individual
shouldForgetSHOULD_FORGETFlag to forget the individual
surgeriesLast5YearsCountSURGERIES_LAST5_YEARS_COUNTNo. of surgeries in last 5 years related to the individual
taxBracketRangeTAX_BRACKET_RANGETax bracket range of the individual
updatedByUPDATED_BYIdentifies the system or user which updated the individual - default as property app.name
updatedOnUPDATED_ONIdentifies the date on which the individual was updated - default as sysdate
webSiteURLWEB_SITE_URLURL of the website related to the individual
weddingAnniversaryDateWEDDING_ANNIVERSARY_DATEWedding anniversary date of the individual
yearlyIncomeYEARLY_INCOMEYearly income of the individual
yearlyIncomeRangeYEARLY_INCOME_RANGEYearly income range of the individual

(back to top)

individuals-patch-payload

Update Individual Mapping for MDM System. Maps CIM Indiviudal to payload
which is used as input parameter in the update query of INDIVIDUAL table.
The fields in both CIM and MDM are identical.
PATCH payload is created by validating the Input Request payload with DB Record Payload.
Few of the DB fields will not be updated as they are not allowed.

Source: ./src/main/resources/dwl/individuals-patch-payload.dwl

Variables

var payloadRecordfromDB

payloadRecordfromDB is the existing customer record in MDM system

(back to top)

individuals-get-response

Search and Retrieve of Individual Mappings for MDM System

Source: ./src/main/resources/dwl/individuals-get-response.dwl

Mapping Tables

Maps MDM Individual as in DB to CIM Individual

CIMMDM DBDescription
birthDateBIRTH_DATEBirth date of the individual
birthPlaceBIRTH_PLACEBirth place of the individual
childrenCountCHILDREN_COUNTNo. of children for the individual
consumerCreditScoreCONSUMER_CREDIT_SCOREConsumer credit score of the individual
consumerCreditScoreProviderNameCONSUMER_CREDIT_SCORE_PROVIDER_NAMEConsumer credit score Provider related to the individual
convictionsCountCONVICTIONS_COUNTCount of convictions related to the individual
createdByCREATED_BYIdentifies the system or user which created the individual - default as property app.name
createdOnCREATED_ONIdentifies the date on which the individual was created - default as sysdate
currentEmployerNameCURRENT_EMPLOYER_NAMECurrent employer name of the individual
deathDateDEATH_DATEDeath date of the individual (if applicable)
deathPlaceDEATH_PLACEDeath place of the individual
dependentCountDEPENDENT_COUNTNo. of dependents related to the individual
doExtractMyDataUpdateDateDO_EXTRACT_MY_DATA_UPDATE_DATEUpdate date to extract data related to the individual
doForgetMeFromUpdateDateDO_FORGET_ME_FROM_UPDATE_DATEUpdate date to forget the individual
doNotMarketFromUpdateDateDO_NOT_MARKET_FROM_UPDATE_DATEUpdate date to market the individual
doNotProcessFromUpdateDateDO_NOT_PROCESS_FROM_UPDATE_DATEUpdate date to not process the individual
doNotProcessReasonDO_NOT_PROCESS_REASONReason to not process the individual
doNotProfileFromUpdateDateDO_NOT_PROFILE_FROM_UPDATE_DATEUpdate date to not profile the individual
doNotTrackLocationUpdateDateDO_NOT_TRACK_LOCATION_UPDATE_DATEUpdate date to not track the location of the individual
doNotTrackUpdateDateDO_NOT_TRACK_UPDATE_DATEUpdate date to not track the individual
employedSinceDateEMPLOYED_SINCE_DATEEmployed since date of the individual
ethnicityETHNICITYEthnicity of the individual
firstNameFIRST_NAMEFirst name of the individual
genderGENDERGender of the individual
globalPartyGLOBAL_PARTYGlobal Party of the the individual
hasAlcoholAbuseHistoryHAS_ALCOHOL_ABUSE_HISTORYFlag to mark alcohol abuse history
hasDrugAbuseHistoryHAS_DRUG_ABUSE_HISTORYFlag to mark drug abuse history
highestEducationLevelHIGHEST_EDUCATION_LEVELHighest education level of the individual
hospitalizationsLast5YearsCountHOSPITALIZATIONS_LAST5_YEARS_COUNTNo. of hospitalization in last 5 years
idIDUnique Id to identify the individual
influencerRatingINFLUENCER_RATINGInfluence rating of the individual
isAlcoholConsumerIS_ALCOHOL_CONSUMERFlag to mark as alcohol consumer
isDrugConsumerIS_DRUG_CONSUMERFlag to mark as drug consumer
isGoodDriverIS_GOOD_DRIVERFlag to mark as a good driver
isGoodStudentIS_GOOD_STUDENTFlag to mark as a good student
isHighRiskHobbyIS_HIGH_RISK_HOBBYFlag to highlight individual has high risk hobby
isHighRiskOccupationIS_HIGH_RISK_OCCUPATIONFlag to highlight individual has high risk occupation
isHomeOwnerIS_HOME_OWNERFlag to mark as a home owner
isTobaccoConsumeIS_TOBACCO_CONSUMEFlag to mark individual consumes tobacco
lastNameLAST_NAMELast name of the individual
mailingNameMAILING_NAMEMailing name of the individual
mainDietaryHabitTypeMAIN_DIETARY_HABIT_TYPEMain dietary habit type of the individual
mainDisabilityTypeMAIN_DISABILITY_TYPEMain disability habit type of the individual
mainLifeAttitudeTypeMAIN_LIFE_ATTITUDE_TYPEMain life attitude type of the individual
mainLifeStyleTypeMAIN_LIFE_STYLE_TYPEMain life style type of the individual
mainPersonalityTypeMAIN_PERSONAL_VALUE_TYPEMain personality type of the individual
mainPersonalValueTypeMAIN_PERSONALITY_TYPEMain personal value type of the individual
majorCitationCountMAJOR_CITATION_COUNTNo. of citations related to the individual
maritalStatusMARITAL_STATUSMarital status of the individual
middleNameMIDDLE_NAMEMiddle name of the individual
militaryServiceMILITARY_SERVICEMilitary service of the individual
militaryStatusMILITARY_STATUSMilitary status of the individual
minorCitationCountMINOR_CITATION_COUNTNo. of minor citations related to the individual
mothersMaidenNameMOTHERS_MAIDEN_NAMEMothers maiden name of the individual
nameSuffixNAME_SUFFIXName suffix of the individual
netWorthNET_WORTHNetworth of the individual
noMergeReasonNO_MERGE_REASONReason to not merge the individual
occupationOCCUPATIONOccupation of the individual
occupationTypeOCCUPATION_TYPEOccupation type of the individual
officialNameOFFICIAL_NAMEOfficial name of the individual
orderingNameORDERING_NAMEOrdering name of the individual
overAgeNumberOVER_AGE_NUMBEROverage number of the individual
partyTypePARTY_TYPEParty type of the individual
personHeightPERSON_HEIGHTPerson height of the individual
personHeightUnitOfMeasurePERSON_HEIGHT_UNIT_OF_MEASUREUnit of measure used to measure person height of the individual
personLifeStagePERSON_LIFE_STAGEPerson life stage of the individual
personNamePERSON_NAMEPerson name of the individual
personWeightPERSON_WEIGHTPerson weight of the individual
personWeightUnitOfMeasurePERSON_WEIGHT_UNIT_OF_MEASUREUnit of measure used to measure person weight of the individual
photoURLPHOTO_URLURL to the photo of the individual
preferredNamePREFERRED_NAMEPreferred name of the individual
primaryHobbyPRIMARY_HOBBYPrimary hobby of the individual
religionRELIGIONReligion of the individual
residenceCaptureMethodRESIDENCE_CAPTURE_METHODResidence capture method of the individual
residenceCountryNameRESIDENCE_COUNTRY_NAMECountry of residence of the individual
salutationSALUTATIONSalutation of the individual
secondLastNameSECOND_LAST_NAMESecond last name of the individual
sendIndividualDataSEND_INDIVIDUAL_DATAFlag to mark if individual data can be sent related to the individual
shouldForgetSHOULD_FORGETFlag to forget the individual
surgeriesLast5YearsCountSURGERIES_LAST5_YEARS_COUNTNo. of surgeries in last 5 years related to the individual
taxBracketRangeTAX_BRACKET_RANGETax bracket range of the individual
updatedByUPDATED_BYIdentifies the system or user which updated the individual - default as property app.name
updatedOnUPDATED_ONIdentifies the date on which the individual was updated - default as sysdate
webSiteURLWEB_SITE_URLURL of the website related to the individual
weddingAnniversaryDateWEDDING_ANNIVERSARY_DATEWedding anniversary date of the individual
yearlyIncomeYEARLY_INCOMEYearly income of the individual
yearlyIncomeRangeYEARLY_INCOME_RANGEYearly income range of the individual

(back to top)

organizations-post-payload

Create organization Mapping for MDM System.
Maps CIM organization to JSON which is used by stored procedure sp_Organizations_Create.
The fields in both CIM and JSON are identical.

Source: ./src/main/resources/dwl/organizations-post-payload.dwl

Mapping Tables

Maps CIM Organization to MDM Organization as in DB

CIMMDM DBDescription
nameNAMEName of the organization
createdByCREATED_BYIdentifies the system or user which created the organization - default as property app.name
createdOnCREATED_ONIdentifies the date on which the organization was created - default as sysdate
globalPartyGLOBAL_PARTYGlobal Party of the the organization
idIDUnique Id to identify the organization
legalNameLEGAL_NAMELegal name of the organization
noMergeReasonNO_MERGE_REASONReason to not merge the organization
partyTypePARTY_TYPEParty type of the organization
updatedByUPDATED_BYIdentifies the system or user which updated the organization - default as property app.name
updatedOnUPDATED_ONIdentifies the date on which the organization was updated - default as sysdate

(back to top)

organizations-patch-payload

Create Organization Mapping for MDM System
Maps CIM Organization to payload which is used as input parameter in the update query of ORGANIZATION table.
The fields in both CIM and MDM are identical.
PATCH payload is created by validating the Input Request payload with DB Record Payload.

Source: ./src/main/resources/dwl/organizations-patch-payload.dwl

Variables

var payloadRecordfromDB

payloadRecordfromDB is the existing customer record in MDM system

Mapping Tables

Maps CIM Organization to MDM Organization as in DB

CIMMDM DBDescription
nameNAMEName of the organization
createdByCREATED_BYIdentifies the system or user which created the organization - default as property app.name
createdOnCREATED_ONIdentifies the date on which the organization was created - default as sysdate
globalPartyGLOBAL_PARTYGlobal Party of the the organization
idIDUnique Id to identify the organization
legalNameLEGAL_NAMELegal name of the organization
noMergeReasonNO_MERGE_REASONReason to not merge the organization
partyTypePARTY_TYPEParty type of the organization
updatedByUPDATED_BYIdentifies the system or user which updated the organization - default as property app.name
updatedOnUPDATED_ONIdentifies the date on which the organization was updated - default as sysdate

(back to top)

organizations-get-response

Retrieve Organization Mapping for MDM System

Source: ./src/main/resources/dwl/organizations-get-response.dwl

Mapping Tables

Maps CIM Organization to MDM Organization as in DB

CIMMDM DBDescription
nameNAMEName of the organization
createdByCREATED_BYIdentifies the system or user which created the organization - default as property app.name
createdOnCREATED_ONIdentifies the date on which the organization was created - default as sysdate
globalPartyGLOBAL_PARTYGlobal Party of the the organization
idIDUnique Id to identify the organization
legalNameLEGAL_NAMELegal name of the organization
noMergeReasonNO_MERGE_REASONReason to not merge the organization
partyTypePARTY_TYPEParty type of the organization
updatedByUPDATED_BYIdentifies the system or user which updated the organization - default as property app.name
updatedOnUPDATED_ONIdentifies the date on which the organization was updated - default as sysdate

(back to top)

households-post-payload

Create Household Mapping for MDM System. Maps CIM Household to payload which
is used as input parameter to insert into Household table. The fields in both
CIM and MDM are identical.

Source: ./src/main/resources/dwl/households-post-payload.dwl

Mapping Tables

Maps CIM Household to JSON which is used by stored procedure - sp_Households_Upsert

JSON used by the stored procedureCIMDescription
householdDissolvedDatehouseholdDissolvedDateDissolvedDate of HouseHold
householdFormedDatehouseholdFormedDateHousehold Formed Date
householdMemberCounthouseholdMemberCountCount of people in a Household
globalPartyglobalPartyGlobal Party Id for Household
ididThe id of the customer
namenameA name given for a Household
partyType"Household"The type of party - default as Household
createdDateauditInfo.createdDateIdentifies the system or user which created the entity - default as current timestamp
createdByauditInfo.createdByTimestamp of when the entity was created - default as current timestamp
updatedByauditInfo.updatedByIdentifies the system or user which last updated the entity - default as property app.name
updatedDateauditInfo.updatedDateTimestamp of when the entity was last updated - default as current timestamp

(back to top)

households-patch-payload

Mapping for MDM System to Update Household. Maps CIM Household to payload
which is used as input parameter in the update Household table. The fields in
both CIM and MDM are identical. PATCH payload is created by validating the
Input Request payload with DB Record Payload.

Source: ./src/main/resources/dwl/households-patch-payload.dwl

Variables

var payloadRecordfromDB

payloadRecordfromDB is the existing customer record in MDM system

Mapping Tables

Maps CIM Household to JSON which is used by stored procedure - sp_Households_Upsert

JSON used by the stored procedureCIMDescription
householdDissolvedDatehouseholdDissolvedDateDissolvedDate of HouseHold
householdFormedDatehouseholdFormedDateHousehold Formed Date
householdMemberCounthouseholdMemberCountCount of people in a Household
globalPartyglobalPartyGlobal Party Id for Household
ididThe id of the customer
namenameA name given for a Household
partyType"Household"The type of party - default as Household
createdDateauditInfo.createdDateIdentifies the system or user which created the entity - default as current timestamp
createdByauditInfo.createdByTimestamp of when the entity was created - default as current timestamp
updatedByauditInfo.updatedByIdentifies the system or user which last updated the entity - default as property app.name
updatedDateauditInfo.updatedDateTimestamp of when the entity was last updated - default as current timestamp

(back to top)

households-get-response

Retrieve and Search Household Mapping for MDM System

Source: ./src/main/resources/dwl/households-get-response.dwl

Mapping Tables

Maps Database table Household to CIM JSON

CIMMDM DBDescription
householdDissolvedDateHOUSEHOLD_DISSOLVED_DATEDissolvedDate of HouseHold
householdFormedDateHOUSEHOLD_FORMED_DATEHousehold Formed Date
householdMemberCountHOUSEHOLD_MEMBER_COUNTCount of people in a Household
globalPartyGLOBAL_PARTYGlobal Party Id for Household
ididThe id of the customer
namenameA name given for a Household
partyTypePARTY_TYPEThe type of party - default as Household
(externalIdsvars.customerExternalIds) if (vars.customerExternalIds !=null and !(isEmpty(vars.customerExternalIds)))The external Ids of the customer that are stored in Core Banking System
auditInfo.createdDateCREATED_DATEIdentifies the system or user which created the entity - default as current timestamp
auditInfo.createdByCREATED_BYTimestamp of when the entity was created - default as current timestamp
auditInfo.updatedByUPDATED_BYIdentifies the system or user which last updated the entity - default as property app.name
auditInfo.updatedDateUPDATED_DATETimestamp of when the entity was last updated - default as current timestamp

(back to top)


Reviews

TypeTemplate
OrganizationMulesoft Inc.
Published by
MuleSoft Solutions
Published onDec 16, 2022
Asset overview

Asset versions for 1.6.x

Asset versions
VersionActions
1.6.0