FINS SilverLake 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 |
|---|---|
| create-customers-soap-request | Create Customer in SilverLake request mapping |
| customers-search-response-mapping | Lookup Customer from SilverLake response mapping |
| get-contactpoints-response | Retrieve Customer ContactPoints from SilverLake response mapping |
| get-customers-response | Retrieve Customer from SilverLake response mapping |
| get-customers-soap-request | SOAP Request mapping for retrieving a Customer from SilverLake |
| search-customer-by-emailaddress-soap-request | SOAP Request mapping for a searching a Customer by EmailAddress from SilverLake The CustSrch Operation of CustomerService is used to look up a Customer |
| search-customer-by-individualname-soap-request | SOAP Request mapping for a searching a Customer by Individual from SilverLake The CustSrch Operation of CustomerService is used to look up a Customer |
| update-customer-soap-request | Update Customer in SilverLake request mapping |
| upsert-contactpoints-soap-request | Create Customer ContactPoints in SilverLake request mapping |
| SilverLakeTools |
create-customers-soap-request
Create Customer in SilverLake request mapping
Source:
./src/main/resources/dwl/create-customers-soap-request.dwl
Mapping Tables
The CustAdd Operation of the CustomerService is used to create the Customer in SilverLake Maps CIM Customer to the request xml that is used to consume the CustAdd Operation of the CustomerService The SOAP request includes the MsgRqHdr.jXchangeHdr and all the mappings in the header are specific to the jExchange Instance The customerNumber is mandatory and needs to be uinque to create a customer in Silverlake The Address is also mandatory to create a customer
| CustAdd Request | CIM | Description |
|---|---|---|
| TaxDetail.TaxDetail.TINInfo.TaxId | customerNumber | The Customer Tax Identification Number in SilverLake. This needs to be unique. |
| CustDetail.PersonName.FirstName | party.firstName | The Firstname of the Customer. |
| CustDetail.PersonName.LastName | party.lastName | The Lastname of the Customer. |
| CustDetail.BirthDt | party.birthDate | The Customer birth date. |
| CustDetail.Addr.StreetAddr1 | addressLine1 | The Addressine1 of the Customer Address. |
| CustDetail.Addr.City | cityName | The City name of the Customer Address. |
| CustDetail.Addr.PostalCode | postalCodeText | The Post Code of the Customer Address. |
| CustDetail.Addr.StateCode | stateProvinceName | The State Province of the Customer Address. |
| CustDetail.Addr.Cntry | countryName | The Country Name of the Customer Address. |
customers-search-response-mapping
Lookup Customer from SilverLake response mapping
Source:
./src/main/resources/dwl/customers-search-response-mapping.dwl
Mapping Tables
The CustSrch Operation of the CustomerService is used to search a Customer in SilverLake Maps the CustSrch response to CIM Customer format
| CIM | CustSrchResponse.CustSrchRecArray.CustSrchRec | Description |
|---|---|---|
| id | CustId | The Customer Identifier in SilverLake |
| partyRoleType | Customer | Set as "Customer". |
| customerNumber | x_TaxDetail.TaxDetail.TINInfo.TaxId | The Customer Tax Identification Number in SilverLake. |
| customerStatus | "ACTIVE" | The Status of the Customer in SilverLake. Set as "Active". |
| party.id | null | Set as null. |
| party.salutation | CustDetail.PersonName.x_PersonName.SalName | The Salutation of the Customer. |
| party.personName | FirstName ++ LastName | Fullname of the Customer (concatenate FistName + LastName). |
| party.firstName | CustDetail.PersonName.FirstName | The Firstname of the Customer. |
| party.lastName | CustDetail.PersonName.LastName | The Lastname of the Customer. |
| party.birthDate | CustDetail.BirthDt | The Customer birth date. |
| party.gender | CustDetail.Gender | The gender of the Customer. |
| party.partyType | "Individual" | The party type set as "Individual". |
| contactPointType | ContactPointAddress | The contactpoint type set as "ContactPointAddress". |
| id | null | The ContactPoint type Id - Set as null. |
| activeFromDate | now() | The date from which the ContactPoint Type is Active - Set as current date. |
| addressLine1 | CustDetail.Addr.StreetAddr1 | The Addressine1 of the Customer Address. |
| cityName | CustDetail.Addr.City | The City name of the Customer Address. |
| postalCodeText | CustDetail.Addr.PostalCode | The Post Code of the Customer Address. |
| stateProvinceName | CustDetail.Addr.StateCode | The State Province of the Customer Address. |
| countryName | CustDetail.Addr.Cntry | The Country Name of the Customer Address. |
| contactPointType | ContactPointEmail | The ContactPointType - Set as "ContactPointEmail". |
| id | null | The ContactPoint type Id - Set as null. |
| activeFromDate | now() | The date from which the ContactPoint Type is Active - Set as current date. |
| emailAddress | CustDetail.EmailArray.EmailInfo.EmailAddr | The Email Address of the Customer. |
| contactPointType | ContactPointPhone | The ContactPointType - Set as "ContactPointPhone". |
| contactPointType | null | The ContactPoint type Id - Set as null. |
| activeFromDate | now() | The date from which the ContactPoint Type is Active - Set as current date. |
| telephoneNumber | CustDetail.PhoneArray.PhoneInfo.PhoneNum | The Phone Number of the Customer. |
| auditInfo.createdDate | now() | Timestamp of when the customer was created - Set as Current Time. |
| auditInfo.createdBy | createdByUserLogin | Identifies the system or user which created the customer. |
| auditInfo.updatedDate | lastUpdatedTxStamp | Timestamp of when the customer was last updated. |
| auditInfo.updatedBy | payload.CustInqResponse.MsgRsHdr.jXchangeHdr.AuditUsrId | Identifies the system or user which last updated the customer. |
| auditInfo.isDeleted | false | Indicates whether or not the customer has been soft-deleted - Set as false. |
get-contactpoints-response
Retrieve Customer ContactPoints from SilverLake response mapping
Source:
./src/main/resources/dwl/get-contactpoints-response.dwl
Mapping Tables
The CustInq Operation of the CustomerService is used to retrieve the Customer ContactPoints from SilverLake Maps the CustInq response to CIM Customer format
| CIM | CustInqResponse.CustRec | Description |
|---|---|---|
| id | CustId | The Customer Identifier in SilverLake. |
| contactPointType | ContactPointAddress | The contactpoint type set as "ContactPointAddress". |
| id | null | The ContactPoint type Id - Set as null. |
| activeFromDate | now() | The date from which the ContactPoint Type is Active - Set as current date. |
| addressLine1 | CustDetail.Addr.StreetAddr1 | The Addressine1 of the Customer Address. |
| cityName | CustDetail.Addr.City | The City name of the Customer Address. |
| postalCodeText | CustDetail.Addr.PostalCode | The Post Code of the Customer Address. |
| stateProvinceName | CustDetail.Addr.StateCode | The State Province of the Customer Address. |
| countryName | CustDetail.Addr.Cntry | The Country Name of the Customer Address. |
| contactPointType | ContactPointEmail | The ContactPointType - Set as "ContactPointEmail". |
| id | null | The ContactPoint type Id - Set as null. |
| activeFromDate | now() | The date from which the ContactPoint Type is Active - Set as current date. |
| emailAddress | CustDetail.EmailArray.EmailInfo.EmailAddr | The Email Address of the Customer. |
| contactPointType | ContactPointPhone | The ContactPointType - Set as "ContactPointPhone". |
| contactPointType | null | The ContactPoint type Id - Set as null. |
| activeFromDate | now() | The date from which the ContactPoint Type is Active - Set as current date. |
| telephoneNumber | CustDetail.PhoneArray.PhoneInfo.PhoneNum | The Phone Number of the Customer. |
get-customers-response
Retrieve Customer from SilverLake response mapping
Source:
./src/main/resources/dwl/get-customers-response.dwl
Mapping Tables
The CustInq Operation of the CustomerService is used to retrieve the Customer information from SilverLake Maps the CustInq response to CIM Customer format
| CIM | CustInqResponse.CustRec | Description |
|---|---|---|
| id | CustId | The Customer Identifier in SilverLake. |
| partyRoleType | Customer | Set as "Customer". |
| customerNumber | x_TaxDetail.TaxDetail.TINInfo.TaxId | The Customer Tax Identification Number in SilverLake. |
| customerStatus | "ACTIVE" | The Status of the Customer in SilverLake. Set as "Active". |
| party.id | null | Set as null. |
| party.salutation | CustDetail.PersonName.x_PersonName.SalName | The Salutation of the Customer. |
| party.personName | FirstName ++ LastName | Fullname of the Customer (concatenate FistName + LastName). |
| party.firstName | CustDetail.PersonName.FirstName | The Firstname of the Customer. |
| party.lastName | CustDetail.PersonName.LastName | The Lastname of the Customer. |
| party.birthDate | CustDetail.BirthDt | The Customer birth date. |
| party.gender | CustDetail.Gender | The gender of the Customer. |
| party.partyType | "Individual" | The party type set as "Individual". |
| contactPointType | ContactPointAddress | The contactpoint type set as "ContactPointAddress". |
| id | null | The ContactPoint type Id - Set as null. |
| activeFromDate | now() | The date from which the ContactPoint Type is Active - Set as current date. |
| addressLine1 | CustDetail.Addr.StreetAddr1 | The Addressine1 of the Customer Address. |
| cityName | CustDetail.Addr.City | The City name of the Customer Address. |
| postalCodeText | CustDetail.Addr.PostalCode | The Post Code of the Customer Address. |
| stateProvinceName | CustDetail.Addr.StateCode | The State Province of the Customer Address. |
| countryName | CustDetail.Addr.Cntry | The Country Name of the Customer Address. |
| contactPointType | ContactPointEmail | The ContactPointType - Set as "ContactPointEmail". |
| id | null | The ContactPoint type Id - Set as null. |
| activeFromDate | now() | The date from which the ContactPoint Type is Active - Set as current date. |
| emailAddress | CustDetail.EmailArray.EmailInfo.EmailAddr | The Email Address of the Customer. |
| contactPointType | ContactPointPhone | The ContactPointType - Set as "ContactPointPhone". |
| contactPointType | null | The ContactPoint type Id - Set as null. |
| activeFromDate | now() | The date from which the ContactPoint Type is Active - Set as current date. |
| telephoneNumber | CustDetail.PhoneArray.PhoneInfo.PhoneNum | The Phone Number of the Customer. |
| auditInfo.createdDate | now() | Timestamp of when the customer was created - Set as Current Time. |
| auditInfo.createdBy | createdByUserLogin | Identifies the system or user which created the customer. |
| auditInfo.updatedDate | now() | Timestamp of when the customer was last updated. |
| auditInfo.updatedBy | payload.CustInqResponse.MsgRsHdr.jXchangeHdr.AuditUsrId | Identifies the system or user which last updated the customer. |
| auditInfo.isDeleted | false | Indicates whether or not the customer has been soft-deleted - Set as false. |
get-customers-soap-request
SOAP Request mapping for retrieving a Customer from SilverLake
Source:
./src/main/resources/dwl/get-customers-soap-request.dwl
search-customer-by-emailaddress-soap-request
SOAP Request mapping for a searching a Customer by EmailAddress from SilverLake
The CustSrch Operation of CustomerService is used to look up a Customer
Source:
./src/main/resources/dwl/search-customer-by-emailaddress-soap-request.dwl
search-customer-by-individualname-soap-request
SOAP Request mapping for a searching a Customer by Individual from SilverLake
The CustSrch Operation of CustomerService is used to look up a Customer
Source:
./src/main/resources/dwl/search-customer-by-individualname-soap-request.dwl
update-customer-soap-request
Update Customer in SilverLake request mapping
Source:
./src/main/resources/dwl/update-customer-soap-request.dwl
Mapping Tables
The CustMod Operation of the CustomerService is used to update the Customer in SilverLake Maps CIM Customer to the request xml that is used to consume the CustMod Operation of the CustomerService The SOAP request includes the MsgRqHdr.jXchangeHdr and all the mappings in the header are specific to the jExchange Instance
| CustMod Request | CIM | Description |
|---|---|---|
| TaxDetail.TaxDetail.TINInfo.TaxId | customerNumber | The Customer Tax Identification Number in SilverLake. This needs to be unique. |
| CustDetail.PersonName.FirstName | party.firstName | The Firstname of the Customer. |
| CustDetail.PersonName.LastName | party.lastName | The Lastname of the Customer. |
| CustDetail.BirthDt | party.birthDate | The Customer birth date. |
upsert-contactpoints-soap-request
Create Customer ContactPoints in SilverLake request mapping
Source:
./src/main/resources/dwl/upsert-contactpoints-soap-request.dwl
SilverLakeTools
Source:
./src/main/resources/dwl/SilverLakeTools.dwl
Variables
var ISOStateCodesMap
This map includes the ISO 3166-2 Codes for different States in USA
var stateNamesMap
This map is obtained by swapping values and keys in the ISOStateCodesMap
Functions
fun getISOAlpha2CodeForStateName (stateName)
Maps State Name to ISO 3166-2 code. Default value is "TX"
return ISO 3166-2 State Code
fun getStateNameFromAlpha2Code (ISOCode)
Maps ISO 3166-2 code to State name. Default value is "Texas"
return State Name