FINS Core Banking Customers System API - Implementation Template
Data mappings
This document provides information generated from the DataWeave scripts included in the project, such as function definitions, variable definitions, and data mapping tables.
| Module | Description |
|---|---|
| map-create-account-storedprocedure-request | Account Create Mapping for Core Banking System System |
| map-get-account-response | Account Retrieve Mapping for Core Banking System System |
| map-create-contactpointsaddress-storedprocedure-request | ContactPointAddress Create/Update Mapping for Core Banking System System |
| map-create-contactpointsemail-storedprocedure-request | ContactPointEmail Create/Update Mapping for Core Banking System System |
| map-create-contactpointsphone-storedprocedure-request | ContactPointPhone Create/Update Mapping for Core Banking System System |
| map-create-customers-payload | Customer Create Mapping for Core Banking System System |
| map-get-customers-response | Customer Query Mapping for Core Banking System System |
| map-patch-customers-payload | Customer Update Mapping for Core Banking System System |
| map-search-customers-response | Customer Search Mapping for Core Banking System System |
| map-get-account-response | Account Retrieve Mapping for Core Banking System System |
| map-get-contactpoints-response | ContactPoint Retrieve Mapping for Core Banking System System |
map-create-account-storedprocedure-request
Account Create Mapping for Core Banking System System
Source:
./src/main/resources/dwl/map-create-account-storedprocedure-request.dwl
Mapping Tables
Maps CIM Account to Core Banking System Account format
| Core Banking System | 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 |
map-get-account-response
Account Retrieve Mapping for Core Banking System System
Source:
./src/main/resources/dwl/map-get-account-response.dwl
Mapping Tables
Maps Core Banking System Account to CIM Account format
| CIM | Core Banking System | 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 |
map-create-contactpointsaddress-storedprocedure-request
ContactPointAddress Create/Update Mapping for Core Banking System System
Source:
./src/main/resources/dwl/map-create-contactpointsaddress-storedprocedure-request.dwl
Mapping Tables
Maps CIM ContactPointAddress to JSON which is used by stored procedure - sp_ContactPointAddress_Create or sp_ContactPointAddress_Update
| JSON used by the stored procedure | CIM | Default Value | Description |
|---|---|---|---|
| id | id | The id of the contactpoint | |
| customerId | customerId | The id of the customer | |
| contactPointType | contactPointType | The type of contact point | |
| activeFromDate | activeFromDate | The date from which contactpoint is active | |
| activeToDate | activeToDate | The date until which contactpoint is active | |
| addressLine1 | addressLine1 | The address line1 of the contactpoint address | |
| addressLine2 | addressLine2 | The address line2 of the contactpoint address | |
| addressLine3 | addressLine3 | The address line3 of the contactpoint address | |
| addressLine4 | addressLine4 | The address line4 of the contactpoint address | |
| bestTimeToContactEndTime | bestTimeToContactEndTime | The best time to contact end time | |
| bestTimeToContactStartTime | bestTimeToContactStartTime | The best time to contact start time | |
| cityName | cityName | The city name of the contactpoint address | |
| countryName | countryName | The country name of the contactpoint address | |
| 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 |
| 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 | |
| geoAccuracy | geoAccuracy | The geo-accuracy of the contactpoint address | |
| geoLatitude | geoLatitude | The geo-latitude of the contactpoint address | |
| geoLongitude | geoLongitude | The geo-longitude of the contactpoint address | |
| isUsedForBilling | isUsedForBilling | Flag to indicate whether the address is used for billing | |
| isUsedForShipping | isUsedForShipping | Flag to indicate whether the address is used for shipping | |
| name | name | The name of the contactpoint address | |
| postalCodeText | postalCodeText | The postalcode of the contactpoint address | |
| primaryFlag | primaryFlag | Flag to indicate if the 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 | |
| stateProvinceName | stateProvinceName | The state province of the contactpoint address | |
| 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 |
map-create-contactpointsemail-storedprocedure-request
ContactPointEmail Create/Update Mapping for Core Banking System System
Source:
./src/main/resources/dwl/map-create-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 | |
| customerId | customerId | The id of the customer | |
| 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 |
map-create-contactpointsphone-storedprocedure-request
ContactPointPhone Create/Update Mapping for Core Banking System System
Source:
./src/main/resources/dwl/map-create-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 | |
| customerId | customerId | The id of the customer | |
| 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 |
map-create-customers-payload
Customer Create Mapping for Core Banking System System
Source:
./src/main/resources/dwl/map-create-customers-payload.dwl
Mapping Tables
Maps CIM Customer to JSON which is used by stored procedure - sp_Customers_Upsert
| 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 Core Banking System | |
| 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 |
map-get-customers-response
Customer Query Mapping for Core Banking System System
Source:
./src/main/resources/dwl/map-get-customers-response.dwl
Mapping Tables
Maps Core Banking System Customer to CIM Customer format
| CIM | Core Banking System | Description |
|---|---|---|
| id | ID | The id of the customer in Core Banking System system |
| churnScore | CHURN_SCORE | The churn score of the customer |
| customerNumber | CUSTOMER_NUMBER | The Customer Number in Core Banking System |
| customerSatisfactionScore | CUSTOMER_SATISFACTION_SCORE | The customer satisfaction score |
| customerStatus | CUSTOMER_STATUS | The status of the customer in Core Banking System 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 Core Banking System |
| 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 |
map-patch-customers-payload
Customer Update Mapping for Core Banking System System
Source:
./src/main/resources/dwl/map-patch-customers-payload.dwl
Variables
var payloadRecordfromDB
payloadRecordfromDB is the existing customer record in Core Banking System system
Mapping Tables
Maps CIM Customer to Core Banking System Customer PATCH payload is created by validating the Input Request payload with DB Record Payload.
| Core Banking System | CIM | Description |
|---|---|---|
| id | vars.customerId | The id of the customer in Core Banking System |
| 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 Core Banking System |
| 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 |
map-search-customers-response
Customer Search Mapping for Core Banking System System
Source:
./src/main/resources/dwl/map-search-customers-response.dwl
Mapping Tables
Maps Core Banking System Customer to CIM Customer format
| CIM | Core Banking System | Description | |
|---|---|---|---|
| id | ID | The id of the customer in Core Banking System system | |
| churnScore | CHURN_SCORE | The churn score of the customer | |
| customerNumber | CUSTOMER_NUMBER | The Customer Number in Core Banking System | |
| customerSatisfactionScore | CUSTOMER_SATISFACTION_SCORE | The customer satisfaction score | |
| customerStatus | CUSTOMER_STATUS | The status of the customer in Core Banking System 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 Core Banking System | |
| activeFromDate | EMAIL_ACTIVE_FROM_DATE | The date from which the email address is active | |
| emailAddress | EMAIL_ADDRESSThe emailaddress of the individual stored in Core Banking System | ||
| contactPoints [1] | |||
| contactPointType | ['ContactPointPhone'] | The contactpoint type Phone | |
| id | PHONE_ID | The id of the contactpoint stored in Core Banking System | |
| 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 Core Banking System | |
| telephoneNumber | TELEPHONE_NUMBERThe telephone number of the individual stored in Core Banking System | ||
| 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 Core Banking System | |
| 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 |
map-get-account-response
Account Retrieve Mapping for Core Banking System System
Source:
./src/main/resources/dwl/map-get-account-response.dwl
Mapping Tables
Maps Core Banking System Account to CIM Account format
| CIM | Core Banking System | 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 |
map-get-contactpoints-response
ContactPoint Retrieve Mapping for Core Banking System System
Source:
./src/main/resources/dwl/map-get-contactpoints-response.dwl
Mapping Tables
Maps Core Banking System ContactPoint to CIM ContactPoint format
| CIM | Core Banking System | 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 |