Product JSON Structure Model

Many Vlocity insurance services are built to input and/or output product data objects. The product object definition is a map of a product as designed in Vlocity by a product administrator. Each product JSON object includes product data, attributes, child products, and service-specific data.

A product JSON's basic structure looks like this:

Product- and Service-Specific Data

Product data with service-specific data looks like this:

Many services add data to the product object as part of its action.

Attributes data is organized by attribute category. Each attribute category contains data about the category and an object with an array of attributes directly associated to the product.

Some services can take data added to the product object.

For example, the createUpdatePolicy service can take an additionalFields JSON in the product object. The additionalFields JSON is a listing of field key/value pairs that it sets when creating or updating the product record.

Each service has a list of specific data it takes in or adds to the product object as part of its input or output JSON.

Attributes

Attributes help define a product. All the attributes for a product are stored in an object within an attributeCategories key. This object’s definition is the same whether it's for root products or child products. It only contains attributes associated to that specific product or child product.

The attribute array is organized by attribute category. Each attribute category object in the array contains one or more attribute objects in the record array of the productAttributes object.

Each attribute object in the array contains the attribute data defined by the attribute assignment record for the specific product attribute relationship in the product definition.

An attribute object contains attribute data that defines the attribute. For configurable attributes, the attribute object can contain a single value or sets of values in an array of values objects. Configurable attributes have the readonly value set to false. Each attribute has a userValue that is the value used for rating if it's mapped.

Rules associated to the attribute or values are added in an array of rules objects in a rules node.

An attribute category with attribute data looks like this:

Child and (grand)child Products

Child products are associated to root parent products or to first-level child products, they're never standalone. Coverage spec, insured item spec, insured party spec, and rating facts product types are examples of child products.

You can find the record type of a child product in RecordTypeName__c of the child product object. Child products use the same product object structure as the root product, but they are defined differently based on their intended usage. Also, coverage spec child products include an isOptional key/value pair that's exposed in the product administration UI for child products, but not for the root product.

Starting with the Vlocity Insurance Summer '18 release, child products include pricingFormula__c.

Starting with Vlocity Insurance/Vlocity Health Summer '18 release, the product structure supports the following structure:

Child and grandchild products now include instanceKey fields. Each instanceKey describes a unique instance of an insured item in a policy that includes multiple insured items.

• Root product

  • Child product

    • (Grand)Child product

      Grandchild products are called childProducts, but the records are nested inside the first-level child product they are associated with.

Child and grandchild products now include instanceKey fields. Each instanceKey describes a unique instance of an insured item in a policy that includes multiple insured items.

(Grand)Child product records and their attribute records are structured the same way as first-level child products and root products. They include a parentInstanceKey field that ties them to the instance of the first-level child product they're associated with.

The child product structure looks like this:

Keys Catalog

The following are lists of the most common keys organized by type.

Many fields are pulled directly from the object in Salesforce, which are specified in the description. Most Salesforce object field names equal the name of the key and are also specified in the description. In Salesforce, the field is prefaced by the namespace <namespace>__<fieldname>, for example vlocityins__isConfigurable.

Product

instanceKey

parentInstanceKey

priceDiff

rawPriceData

totalPremiumForTermDiff

Attribute

Values

Note

The values array is stored in the ValidValuesData__c in the attribute assignment object.

Rules

Note

The rules array is stored in the RuleData__c in the attribute assignment object.