You are here:
The InsPolicy FSC-Vlocity Mapping Interface
The InsPolicy interface is a generic service interface that lets Vlocity policy services work with any policy data model, including the Salesforce FSC Insurance Policy data model.
The InsPolicyService and InsPolicyRevenueScheduleService services perform their business logic on the InsPolicy interface instead of on the Vlocity policy data model directly.
Beginning with Winter '20, Vlocity Insurance policy services no longer interact with database objects and fields directly. Instead, they rely on the caller to fetch or post data to database objects and fields using Omnistudio Data Mappers or Apex classes. The Get Data Mapper or Apex class needs to fetch data, and conform that data to the InsPolicy interface for policy services. The Post Data Mapper or Apex class needs to accept the InsPolicy interface from policy services, and post the data to the database.
Vlocity Insurance Policy to Salesforce FSC Policy Data Model Mapping
Here's how Vlocity objects map to Salesforce FSC objects.
Vlocity Object |
FSC Object |
Notes |
|---|---|---|
|
|
|
|
|
|
|
|
For InsurancePolicyAsset, an associated CustomerProperty record is required via the CustomerPropertyId field on the InsurancePolicyAsset. This is a Salesforce FSC-specific object. |
|
|
For InsurancePolicyParticipant, an associated Contact record is required via the PrimaryParticipantContactId on the InsurancePolicyParticipant. |
|
|
|
|
|
|
|
|
|
|
|
Data Mappers and Custom Classes
The Insurance Industries Extension package comes with Data Mappers and custom classes that you can use in conjunction with InsPolicyService and InsPolicyRevenueScheduleService services.
You can change the contents of these Data Mappers to fit your business needs.
For example, you can use the additionalFields key to query your own custom fields and add them to the Data Mappers we provide.
These fields won't show up on the Vlocity policy UI, but you can map attribute values to these custom fields using the InsPolicyService:createUpdatePolicy and InsPolicyService:createPolicyVersion services.
These Data Mappers and custom classes let you use these services with the Salesforce FSC data model without having to write your own Data Mappers or custom classes.
-
getFSCPolicyDetail
Retrieves FSC data model and converts it to InsPolicy interface
-
postFSCPolicyDetailGeneric
Takes in InsPolicy interface, converts it to FSC data model, and inserts the records
-
postVersionFSCPolicyDetail
Takes in InsPolicy interface, converts it to FSC data model, and inserts the records. The main difference from postFSCPolicyDetailGeneric is that any transaction and revenue schedule records are linked to the original policy version instead of the newly created policy
-
updateFSCPolicyDetailGeneric
Takes in InsPolicy interface, converts it to FSC data model, and updates the target records
-
postFSCPolicyTransaction
Takes in InsPolicy interface, specifically
InsTransaction, converts it to anInsurancePolicyTransaction__crecord, and inserts the record -
getFSCPolicyRevenue
Retrieves the FSC data model, specifically the InsurancePolicyTransaction__c and InsurancePolicyRevenueSchedule__c records, and converts it to the InsPolicy interface
-
updateFSCPolicyRevenue
Takes in InsPolicy interface, specifically the InsRevenue, converts it to InsurancePolicyRevenueScheulde__c records, and updates the target records
-
postFSCPolicyRevenue
Takes in InsPolicy interface, specifically the InsRevenue, converts it to InsurancePolicyRevenueScheulde__c records, and inserts the records
The custom classes included with the Insurance Industries Extension package are:
-
CancelPolicyRevenue
Takes in InsPolicy interface, specifically the InsRevenue, and deletes/updates the associated InsurancePolicyRevenueSchedule__c records
-
GetInsurancePolicy
Retrieves FSC data model and converts it to InsPolicy interface
To add these Data Mappers and custom classes to your org, see Add Insurance Industries Extension Data Mappers and Custom Classes to Your Org.
Policy Service to Data Mapper and Custom Class Mapping
Here's a list of Policy services and the Data Mappers or Custom Classes they use for Insurance Industries Extension.
Vlocity Insurance Service |
Related Service Option: Data Raptor or Custom Class |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Creating Your Own Custom Classes
If the Data Mappers and custom classes included with the Insurance Industries Extension package don't work for your business needs, you can write your own custom classes to work with the InsPolicy interface to get or post data in the Salesforce FSC policy object. See Create Custom Classes for the InsPolicy Interface.
- Add Insurance Industries Extension Data Mappers and Custom Classes to Your Org
The Insurance Industries Extension package comes with Omnistudio Data Mappers and custom classes that you can use in conjunction with InsPolicyService and InsPolicyRevenueScheduleService services. Add these Data Mappers and custom classes to your org, and change the contents of the Data Mappers to fit your business needs. - Create Custom Classes for the InsPolicy Interface
If the Omnistudio Data Mappers and custom classes included with the Insurance Industries Extension package don't work for your business needs, you can write your own custom classes to work with the InsPolicy interface to get or post data in the Salesforce FSC policy object.
