FINS Salesforce Insurance 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 |
---|---|
quote-create-insurance-library-to-vlocity | Map Quote details to Integration Procedure in Salesforce |
retrieve-policies-by-id-response | Retrieve Policy By Id Response Mapping in Salesforce |
retrieve-quotes-by-id-response | Retrieve Quote By Id Response Mapping in Salesforce |
search-policies-response | Search Policies Response Mapping in Salesforce |
search-quotes-response | Retrieve Quote By Id Response Mapping in Salesforce |
quote-create-insurance-library-to-vlocity
Map Quote details to Integration Procedure in Salesforce
Source:
./src/main/resources/dwl/quote-create-insurance-library-to-vlocity.dwl
retrieve-policies-by-id-response
Retrieve Policy By Id Response Mapping in Salesforce
Source:
./src/main/resources/dwl/retrieve-policies-by-id-response.dwl
Mapping Tables
Maps Salesforce InsurancePolicy Object to Insurance Library format
Salesforce InsurancePolicy | Insurance Library | Description |
---|---|---|
id | Id | The id of the Policy |
name | Name | The general name of the Policy |
description | PolicyDescription | General description the policy coverage |
policyName | PolicyName | Descriptive name of the policy |
policyTerm | PolicyTerm | The term of the Policy |
policyType | PolicyType | Type of policy the instance represents |
policyStatus | Status | The status of the Policy |
policySubStatus | Substatus | The sub status of the Policy |
insuranceProductId | ProductId | Identifier of the underlying insurance product |
primaryParticipantId | NameInsuredId | Account identifier of the primary participant of the policy |
effectiveDate | EffectiveDate | The date from which the Policy is effective |
expirationDate | ExpirationDate | The date on which the Policy expires |
renewalDate | RenewalDate | The date on which the Policy is renewed |
cancellationDate | CancellationDate | The date on which the Insurance Policy is cancelled |
cancellationReason | CancellationReason | The cancellation reason |
sourceQuoteId | SourceQuoteId | The source quote id of the Policy |
ForEach InsurancePolicyAsset | ||
id | Id | The id of the Asset in Salesforce |
name | Name | The Name of the Insurance Policy Asset in Salesforce |
description | Description__c | The description of the Insurance Policy Asset in Salesforce |
assetName | AssetName | General description of the policy asset |
customerPropertyId | CustomerPropertyId | Identifier of the customer property covered by the asset |
insuranceProductId | vlocity_ins_fscProduct2Idc | Identifier of the underlying insurance product |
insurancePolicyId | InsurancePolicyId | Identifier of the policy the asset is associated with |
policyParticipantId | PrimaryPolicyParticipantId | Identifier of the customer property covered by the asset |
termPremiumAmount | TermPremiumAmount | The Term Premium amount of the Asset |
termTaxAmount | TermTaxAmount | The Term Tax amount of the Asset |
termFeeAmount | TermFeeAmount | The Term Fee amount of the Asset |
termTotalAmount | TotalTermAmount | The Term Total amount of the Asset |
End of ForEach InsurancePolicyAsset | ||
ForEach InsurancePolicyCoverage | ||
id | Id | The id of the Insurance Policy Coverage in Salesforce |
name | Name | The name of the Insurance Policy Coverage in Salesforce. This is an auto generated number |
description | Description | General description the policy coverage |
coverageName | CoverageName | Descriptive name of the policy coverage |
coverageType | CoverageTypeId | Type of coverage the instance represents |
coverageCategory | Category | Category assigned to the policy coverage |
insuranceProductId | vlocity_ins_fscProduct2Idc | Identifier of the underlying insurance product |
insurancePolicyId | InsurancePolicyId | Identifier of the policy the coverage applies to |
insurancePolicyAssetId | InsurancePolicyAssetId | Identifier of the specific policy asset the coverage applies to |
premiumAmount | PremiumAmount | The premium amount of the Insurance Policy Coverage |
deductibleAmount | DeductibleAmount | The deductible amount of the Insurance Policy Coverage |
effectiveDate | EffectiveDate | The date from which the policy coverage is effective |
expirationDate | ExpirationDate | The date on which the policy coverage expires |
End of ForEach InsurancePolicyCoverage | ||
ForEach InsurancePolicyParticipant | ||
id | Id | The id of the InsurancePolicyParticipant record in Salesforce |
name | Name | The name of the InsurancePolicyParticipant record. This is an auto-generated number. |
insuranceProductId | vlocity_ins_fscInsuredPartySpecIdc | Identifier of the underlying insurance product |
insurancePolicyId | InsurancePolicyId | Identifier of the policy the participant is associated with |
participantAccountId | PrimaryParticipantAccountId | Identifier of the primary participant of the underlying policy |
participantContactId | PrimaryParticipantContactId | Identifier of the primary contact of the underlying policy |
participantRole | Role | The role of the PolicyParticipant |
effectiveDate | EffectiveDate | The date from which the Policy Participant is effective |
expirationDate | ExpirationDate | The date on which the Policy Participant expires |
End of ForEach InsurancePolicyParticipant | ||
externalIds.id | Global_Policy_Id__c | Set as Global Policy Id |
externalIds.externalId | Global_Policy_Id__c | The Global Identifier of the Policy |
externalIds.externalIdType | MDM | Set as MDM |
externalIds.statusLastChangedDate | LastModifiedDate | Last modified date to "yyyy-MM-dd'T'HH:mm:ssz" |
externalIds.status | VALID | Set as VALID |
auditInfo.createdBy | CreatedBy.NameIdentifies the system or user which created the entity | |
auditInfo.createdDate | CreatedDate | Timestamp of when the entity was created - default as current timestamp |
auditInfo.updatedBy | LastModifiedBy.Name | Identifies the system or user which last updated the entity |
auditInfo.updatedDate | LastModifiedDate | Timestamp of when the entity was last updated |
auditInfo.isDeleted | IsDeleted | Indicates whether or not the entity has been soft-deleted - default as false |
retrieve-quotes-by-id-response
Retrieve Quote By Id Response Mapping in Salesforce
Source:
./src/main/resources/dwl/retrieve-quotes-by-id-response.dwl
Mapping Tables
Maps Salesforce Quote Object to Insurance Library format
Salesforce Quote | Insurance Library | Description |
---|---|---|
id | Id | The id of the Quote |
name | Name | The general name of the Quote |
description | QuoteDescription | General description the Quote coverage |
QuoteNumber | quoteNumber | A number to identify the Quote |
OpportunityId | opportunityId | Identifier of the opportunity this quote is related to |
AccountId | quoteAccountId | Identifier of the customer this quote was prepared for |
ContactId | quoteContactId | Identifier of the contact for the quote |
Status | quoteStatus | Current status of the quote |
vlocity_insPrimaryProductIdc | insuranceProductId | Identifier of the insurance product this quote applies to |
vlocity_insRatingTypec | ratingType | Rating to provide a quote |
vlocity_insTermc | termDuration | Duration of the Insurance for quote |
Subtotal | subtotalAmount | Sub Total Amount on quote - default 0.0 |
vlocity_insTotalTaxAmountc | taxAmount | Tax amount for the quote - default 0.0 |
vlocity_insTotalFeeAmountc | feeAmount | Total Fee for quote - default 0.0 |
Discount | discountAmount | Discount applied on the quote - default 0.0 |
vlocity_insTotalAmountc | totalAmount | Total Amount on the quote - default 0.0 |
vlocity_ins_fscSourceInsurancePolicyIdc | insurancePolicyId | policy id tied to the quote |
vlocity_insEffectiveDatec | effectiveDate | effective date of quote |
ExpirationDate | expirationDate | Expiration Date for the quote |
auditInfo.createdBy | CreatedBy.NameIdentifies the system or user which created the entity | |
auditInfo.createdDate | CreatedDate | Timestamp of when the entity was created - default as current timestamp |
auditInfo.updatedBy | LastModifiedBy.Name | Identifies the system or user which last updated the entity |
auditInfo.updatedDate | LastModifiedDate | Timestamp of when the entity was last updated |
auditInfo.isDeleted | IsDeleted | Indicates whether or not the entity has been soft-deleted - default as false |
search-policies-response
Search Policies Response Mapping in Salesforce
Source:
./src/main/resources/dwl/search-policies-response.dwl
Mapping Tables
Maps Salesforce InsurancePolicy Object to CIM format
Salesforce InsurancePolicy | CIM | Description |
---|---|---|
ForEach InsurancePolicy | ||
id | Id | The id of the Policy |
name | Name | The general name of the Policy |
description | PolicyDescription | General description the policy coverage |
policyName | PolicyName | Descriptive name of the policy |
policyTerm | PolicyTerm | The term of the Policy |
policyType | PolicyType | Type of policy the instance represents |
policyStatus | Status | The status of the Policy |
policySubStatus | Substatus | The sub status of the Policy |
insuranceProductId | ProductId | Identifier of the underlying insurance product |
primaryParticipantId | NameInsuredId | Account identifier of the primary participant of the policy |
effectiveDate | EffectiveDate | The date from which the Policy is effective |
expirationDate | ExpirationDate | The date on which the Policy expires |
renewalDate | RenewalDate | The date on which the Policy is renewed |
cancellationDate | CancellationDate | The date on which the Insurance Policy is cancelled |
cancellationReason | CancellationReason | The cancellation reason |
sourceQuoteId | SourceQuoteId | The source quote id of the Policy |
ForEach InsurancePolicyAsset | ||
id | Id | The id of the Asset in Salesforce |
name | Name | The Name of the Insurance Policy Asset in Salesforce |
description | Description__c | The description of the Insurance Policy Asset in Salesforce |
assetName | AssetName | General description of the policy asset |
customerPropertyId | CustomerPropertyId | Identifier of the customer property covered by the asset |
insuranceProductId | vlocity_ins_fscProduct2Idc | Identifier of the underlying insurance product |
insurancePolicyId | InsurancePolicyId | Identifier of the policy the asset is associated with |
policyParticipantId | PrimaryPolicyParticipantId | Identifier of the customer property covered by the asset |
termPremiumAmount | TermPremiumAmount | The Term Premium amount of the Asset |
termTaxAmount | TermTaxAmount | The Term Tax amount of the Asset |
termFeeAmount | TermFeeAmount | The Term Fee amount of the Asset |
termTotalAmount | TotalTermAmount | The Term Total amount of the Asset |
End of ForEach InsurancePolicyAsset | ||
ForEach InsurancePolicyCoverage | ||
id | Id | The id of the Insurance Policy Coverage in Salesforce |
name | Name | The name of the Insurance Policy Coverage in Salesforce. This is an auto generated number |
description | Description | General description the policy coverage |
coverageName | CoverageName | Descriptive name of the policy coverage |
coverageType | CoverageTypeId | Type of coverage the instance represents |
coverageCategory | Category | Category assigned to the policy coverage |
insuranceProductId | vlocity_ins_fscProduct2Idc | Identifier of the underlying insurance product |
insurancePolicyId | InsurancePolicyId | Identifier of the policy the coverage applies to |
insurancePolicyAssetId | InsurancePolicyAssetId | Identifier of the specific policy asset the coverage applies to |
premiumAmount | PremiumAmount | The premium amount of the Insurance Policy Coverage |
deductibleAmount | DeductibleAmount | The deductible amount of the Insurance Policy Coverage |
effectiveDate | EffectiveDate | The date from which the policy coverage is effective |
expirationDate | ExpirationDate | The date on which the policy coverage expires |
End of ForEach InsurancePolicyCoverage | ||
ForEach InsurancePolicyParticipant | ||
id | Id | The id of the InsurancePolicyParticipant record in Salesforce |
name | Name | The name of the InsurancePolicyParticipant record. This is an auto-generated number. |
insuranceProductId | vlocity_ins_fscInsuredPartySpecIdc | Identifier of the underlying insurance product |
insurancePolicyId | InsurancePolicyId | Identifier of the policy the participant is associated with |
participantAccountId | PrimaryParticipantAccountId | Identifier of the primary participant of the underlying policy |
participantContactId | PrimaryParticipantContactId | Identifier of the primary contact of the underlying policy |
participantRole | Role | The role of the PolicyParticipant |
effectiveDate | EffectiveDate | The date from which the Policy Participant is effective |
expirationDate | ExpirationDate | The date on which the Policy Participant expires |
End of ForEach InsurancePolicyParticipant | ||
externalIds.id | Global_Policy_Id__c | Set as Global Policy Id |
externalIds.externalId | Global_Policy_Id__c | The Global Identifier of the Policy |
externalIds.externalIdType | MDM | Set as MDM |
externalIds.statusLastChangedDate | LastModifiedDate | Last modified date to "yyyy-MM-dd'T'HH:mm:ssz" |
externalIds.status | VALID | Set as VALID |
auditInfo.createdBy | CreatedBy.NameIdentifies the system or user which created the entity | |
auditInfo.createdDate | CreatedDate | Timestamp of when the entity was created - default as current timestamp |
auditInfo.updatedBy | LastModifiedBy.Name | Identifies the system or user which last updated the entity |
auditInfo.updatedDate | LastModifiedDate | Timestamp of when the entity was last updated |
auditInfo.isDeleted | IsDeleted | Indicates whether or not the entity has been soft-deleted - default as false |
End of ForEach InsurancePolicy |
search-quotes-response
Retrieve Quote By Id Response Mapping in Salesforce
Source:
./src/main/resources/dwl/search-quotes-response.dwl
Mapping Tables
Maps Salesforce Quote Object to CIM format
Salesforce Quote | CIM | Description |
---|---|---|
id | Id | The id of the Quote |
name | Name | The general name of the Quote |
description | QuoteDescription | General description the Quote coverage |
QuoteNumber | quoteNumber | A number to identify the Quote |
OpportunityId | opportunityId | Identifier of the opportunity this quote is related to |
AccountId | quoteAccountId | Identifier of the customer this quote was prepared for |
ContactId | quoteContactId | Identifier of the contact for the quote |
Status | quoteStatus | Current status of the quote |
vlocity_insPrimaryProductIdc | insuranceProductId | Identifier of the insurance product this quote applies to |
vlocity_insRatingTypec | ratingType | Rating to provide a quote |
vlocity_insTermc | termDuration | Duration of the Insurance for quote |
Subtotal | subtotalAmount | Sub Total Amount on quote - default 0.0 |
vlocity_insTotalTaxAmountc | taxAmount | Tax amount for the quote - default 0.0 |
vlocity_insTotalFeeAmountc | feeAmount | Total Fee for quote - default 0.0 |
Discount | discountAmount | Discount applied on the quote - default 0.0 |
vlocity_insTotalAmountc | totalAmount | Total Amount on the quote - default 0.0 |
vlocity_ins_fscSourceInsurancePolicyIdc | insurancePolicyId | policy id tied to the quote |
vlocity_insEffectiveDatec | effectiveDate | effective date of quote |
ExpirationDate | expirationDate | Expiration Date for the quote |
auditInfo.createdBy | CreatedBy.NameIdentifies the system or user which created the entity | |
auditInfo.createdDate | CreatedDate | Timestamp of when the entity was created - default as current timestamp |
auditInfo.updatedBy | LastModifiedBy.Name | Identifies the system or user which last updated the entity |
auditInfo.updatedDate | LastModifiedDate | Timestamp of when the entity was last updated |
auditInfo.isDeleted | IsDeleted | Indicates whether or not the entity has been soft-deleted - default as false |