Você está aqui:
Modelo de estrutura JSON do produto
O objeto JSON do produto fornece um objeto de dados de produto portátil para uso de tempo de execução entre serviços e modelos.
Muitos serviços de seguro do Vlocity são criados para inserir e/ou gerar objetos de dados de produto. A definição de objeto de produto é um mapa de um produto conforme projetado no Vlocity por um administrador de produto. Cada objeto JSON de produto inclui dados de produto, atributos, produtos filhos e dados específicos do serviço.
A estrutura básica do JSON de um produto fica assim:
Dados específicos do produto e do serviço
Os dados do produto com dados específicos do serviço ficam assim:
Muitos serviços adicionam dados ao objeto de produto como parte de sua ação.
Os dados de atributos são organizados pela categoria de atributo. Cada categoria de atributo contém dados sobre a categoria e um objeto com uma matriz de atributos diretamente associados ao produto.
Alguns serviços podem levar dados adicionados ao objeto de produto.
Por exemplo, o createUpdatePolicy serviço pode ter um additionalFields JSON no objeto de produto. O additionalFields
JSON é uma listagem de pares de chave/valor de campo que ele define ao criar ou atualizar o registro do produto.
Cada serviço tem uma lista de dados específicos que ele coleta ou adiciona ao objeto de produto como parte de seu JSON de entrada ou saída.
Atributos
Os atributos ajudam a definir um produto. Todos os atributos de um produto são armazenados em um objeto dentro de uma attributeCategories chave. A definição desse objeto é a mesma para produtos raiz ou produtos filho. Ele contém apenas atributos associados a esse produto ou produto filho específico.
A matriz de atributos é organizada pela categoria de atributo. Cada objeto de categoria de atributo na matriz contém um ou mais objetos de atributo na matriz de registro do productAttributes objeto.
Cada objeto de atributo na matriz contém os dados de atributo definidos pelo registro de atribuição de atributo para o relacionamento de atributo de produto específico na definição do produto.
Um objeto de atributo contém dados de atributo que definem o atributo. Para atributos configuráveis, o objeto de atributo pode conter um único valor ou conjuntos de valores em uma matriz de objetos de valores. Atributos configuráveis têm o readonly valor definido como false. Cada atributo tem um userValue que é o valor usado para classificação se estiver mapeado.
As regras associadas ao atributo ou valores são adicionadas em uma matriz de objetos de regras em um nó de regras.
Produtos filho e (avô)filho
Os produtos filho são associados a produtos pai raiz ou a produtos filho de primeiro nível, eles nunca são independentes. Especificação de cobertura, especificação de item seguro, especificação de parte segurada e tipos de produto de fatos de classificação são exemplos de produtos filho.
Você pode encontrar o tipo de registro de um produto filho em RecordTypeName__c do objeto de produto filho. Os produtos filho usam a mesma estrutura de objeto do produto que o produto raiz, mas são definidos de modo diferente com base no uso pretendido. Além disso, os produtos secundários da especificação de cobertura incluem um par de isOptional chave/valor exposto na IU de administração do produto para produtos secundários, mas não para o produto raiz.
A partir da versão Summer '18 do Vlocity Insurance, os produtos filho incluem pricingFormula__c.
A partir da versão Summer '18 do Vlocity Insurance/Vlocity Health, a estrutura do produto oferece suporte à seguinte estrutura:
Os produtos filho e neto agora incluem campos instanceKey. Cada instanceKey descreve uma instância exclusiva de um item seguro em uma apólice que inclui vários itens segurados.
-
Produto raiz
-
Produto filho
-
(Grande)produto filho
Os produtos netos são chamados childProducts, mas os registros são aninhados dentro do produto filho de primeiro nível ao qual estão associados.
-
-
Os produtos filho e neto agora incluem campos instanceKey. Cada instanceKey descreve uma instância exclusiva de um item seguro em uma apólice que inclui vários itens segurados.
(Grande)Os registros de produto filho e seus registros de atributo são estruturados da mesma maneira que produtos filho de primeiro nível e produtos raiz. Eles incluem um parentInstanceKey campo que os vincula à instância do produto filho de primeiro nível ao qual estão associados.
Catálogo de chaves
A seguir estão listas das chaves mais comuns organizadas por tipo.
Muitos campos são capturados diretamente do objeto no Salesforce, que são especificados na descrição. A maioria dos nomes de campo de objeto do Salesforce é igual ao nome da chave e também é especificada na descrição. No Salesforce, o campo é precedido pelo <namespace>__<fieldname> de namespace, por exemplo, vlocityins__isConfigurable.
Produto
Chave |
Descrição |
|---|---|
|
Objeto que contém pares de chave/valor de qualquer campo de produto que não faça parte do serviço. Uma adição opcional usada para entrada em serviços de criação/atualização. |
|
A estrutura de dados de registros da categoria de atributo, que contém uma matriz de registros de categorias de atributo. Cada categoria contém uma matriz de dados de atributos. |
|
Os dados JSON produzidos pelo procedimento de cálculo ou pelo Procedimento de integração. |
|
Estrutura de dados de registros filho do produto, que contém matriz de registros de produtos filho. Os tipos de registro possíveis incluem especificação de cobertura, especificação de item segurado e especificação de fato de classificação. |
|
Campo Product2 |
|
|
|
Campo Product2 |
|
Campo Product2 |
|
Campo Product2 extraído de |
|
Identifica a instância específica do item segurado. |
|
Campo Product2 |
|
O campo |
|
Campo Product2 |
|
Campo Product2 |
|
Campo Product2 |
|
A chave de instância do produto pai de um produto (grand)child. |
|
Calculado usando a fórmula em |
|
A diferença entre o preço da apólice existente e o novo preço calculado. |
|
Campo Product2 |
|
Campo Product2 |
|
ID de registro do Salesforce do produto |
|
Esse nó é incluído quando a opção remota |
|
Product, CoverageSpec, InsuredItemSpce, or RatingFactSpec |
|
Campo Product2 |
|
Campo Product2 |
|
Campo Product2 |
|
A diferença entre o prêmio total original para prazo e a soma entre o prêmio total para prazo da nova versão da apólice e o prêmio atualizado para prazo da versão antiga da apólice |
|
Calculado usando a fórmula em |
|
Campo Product2 |
Atributo
Chave |
Descrição |
|---|---|
|
Campo de categoria de atributo |
|
Campo de categoria de atributo |
|
Campo de categoria de atributo |
|
Campo de categoria de atributo |
|
Atributos do produto registros de objeto de dados, contém matriz de registros de objetos de atributo. |
Valores
Chave |
Descrição |
|---|---|
|
|
|
O ID de sequenciamento do objeto de dados de valor na matriz de valores. |
|
Rótulo de exibição para a UI. |
|
|
|
Matriz de objetos de regras. |
|
O valor real que o rótulo representa. |
Regras
Chave |
Descrição |
|---|---|
ações |
Definição da ação. |
expression |
Uma expressão avaliada da seguinte maneira: Verdadeiro: Acione a ação para a regra. Falso: Nenhuma ação é acionada. |
message |
Para regras do tipo mensagem, esse valor contém
A gravidade determina como a mensagem é exibida. |
tipo de regra |
Há suporte para três tipos de regra:
|
expressão de valor |
Insira Como valor, insira um %valueExpression% válido. |
