InsProductService:getRatedProducts

Você está aqui:

InsProductService:getRatedProducts

Use esse serviço para obter uma matriz de um ou mais produtos, precificados usando os procedimentos de classificação anexados a esses produtos. Esse serviço também inclui recursos extras, como cálculos de taxa e imposto, filtragem e otimização de desempenho.

Classe: InsProductService

Método: getRatedProducts

Para usar esse serviço, passe o conjunto de entradas de que o procedimento de classificação precisa para precificar produtos. O serviço retorna uma matriz filtrada de produtos e um JSON de resultado do procedimento de classificação.

Como funciona

O serviço pesquisa o Salesforce para recuperar um conjunto de produtos ativos que estejam dentro das datas de início e término efetivas. Consulte effectiveDate abaixo para obter mais informações.

Como parte da consulta, os serviços usam os critérios passados na opção de filtro para obter um conjunto inicial de produtos. Os dados obtidos do Salesforce incluem as regras de elegibilidade do produto e o procedimento de classificação, especificações de item segurado, especificações de parte segurada, especificações de cobertura, especificações de fato de classificação e todos os seus atributos.
Avalia cada produto no conjunto inicial com base em suas regras de elegibilidade, reduzindo ainda mais o conjunto de produtos.
Pesquisa no JSON de entrada a chave userInputs e recupera o valor da chave. userInputs é o conjunto de dados de entrada que o procedimento de classificação usa para obter o preço do produto. O serviço avalia esse objeto com base nos mapeamentos de entrada de classificação de produto para criar o JSON de entrada necessário para o procedimento de classificação.

Você formata os userInputs de forma diferente dependendo da definição do produto e da configuração de classificação. Para evitar erros, filtre produtos que usam o mesmo tipo de formato de userInputs.
Classifica cada produto no conjunto criado na etapa 2. Ele chama o procedimento de classificação associado ao produto com o JSON de entrada da etapa 3.
Retorna uma matriz de objetos de produto com o preço total de cada produto e o valor total seguro.

Cada objeto de produto devolvido também inclui o JSON de saída do procedimento de classificação como o valor de CalculatedPriceData. O serviço também define price e totalSumInsured se as fórmulas forem definidas no produto.

Tenha em mente que:
- Se um único atributo for configurado com uma regra de atributo Definir valor e uma regra de atributo Definir valor padrão, a getRatedProducts aplicará apenas a regra de atributo Definir valor padrão.
- Como prática recomendada, ao configurar expressões de regra de atributo, não faça referência a valores de atributo em estruturas de nível inferior.

Opções remotas

Opções de classificação
Opção	Descrição
`aggByKey`	`PRODUCT.instanceKey` Quando `aggByKey` é definido, seu valor é incluído na `aggregationResult` do procedimento de cálculo, se `aggregationResult` não estiver vazio. (O `aggregationResult` geralmente é preenchido quando um procedimento de cálculo tem etapas de agregação configuradas). Por exemplo, uma apólice de seguro de carro que tem vários motoristas segurados para vários carros exige que as `aggByKey` sejam passadas para o procedimento de cálculo.
`alwaysCreateInstance`	Defina essa opção como `true` para produtos com várias especificações filho em um determinado nível da hierarquia, sem especificações neto e apenas um procedimento de classificação no nível raiz. Omita essa opção para produtos que não atendem a todos esses critérios. Para formatar as `userInputs` para esse tipo de produto, consulte Um procedimento de classificação por produto para getRatedProducts.
`includeInputKeys`	Uma string de chaves de entrada separadas por vírgula para incluir no objeto de produto de saída, dentro do objeto `CalculatedPriceData`. Somente as chaves de entrada usadas pelo procedimento de cálculo têm um valor nos resultados.
`rateType`	`Age` ou `Composite` Use essa opção para classificação de grupo pequeno.
`searchText`	PartOfAProductName Se essa opção for usada, o serviço receberá apenas produtos com nomes que contenham o valor fornecido.
`sortBy`	productField1, productField2. Classifica os produtos que o serviço recebe na ordem especificada. Você pode usar `DESC` com essa opção para classificar produtos em ordem decrescente. Você pode especificar o primeiro item a descender. Se você não especificar um local para começar, `DESC` usará a ordem alfabética como padrão. Se você não especificar um valor para essa opção, o serviço classificará os produtos retornados por nome em ordem alfabética crescente.

Opções de filtro
Opção	Descrição
`attributeFilters`	Um mapa de `attributeCode` e valores Retorna apenas produtos que cumprem os valores de atributo fornecidos no filtro.
`effectiveDate`	`“YYYY-MM-DD HH:MM:SS”` ou `%OmniScriptDataElement%` O padrão é a data de hoje. O serviço atrai produtos com uma `effectiveDate` entre `EffectiveDate__c` e `EndDate__c` e `IsActive`. O serviço também usa o `effectiveDate` para selecionar a versão correta do procedimento de cálculo usado para classificar o produto.
`filters`	`Product2FieldName:Value` `Product2FieldName:%ElementName%` Use o nome da API com uma vírgula seguida por um valor ou uma variável. Por exemplo, em um OmniScript, uma variável pode ser um nome de um elemento, como uma lista de opções de entrada. Separe vários parâmetros de filtro com vírgulas: `ProductCode:Value,ProductCode:%ElementName%` Os filtros podem incluir qualquer campo no objeto `Product2`.
`includeFilterAttrValues`	`true` ou `false` Padrão para `false`. No JSON de saída, junto com a matriz de produtos, isso adiciona o objeto `filterAttrValues`. Esse objeto contém os atributos do produto raiz marcados como filtráveis, com a lista possível de valores. Essa lista é usada por alguns modelos de IU para filtrar grandes conjuntos de produtos. Os atributos filho do produto não são incluídos.
`whereClause`	Insira qualquer instrução SOQL do Salesforce válida como o valor dessa opção. Use isso quando precisar desse serviço para procurar campos de várias listas de opções ao pesquisar produtos. Por exemplo, a declaração `vlocity_ins_marketsegment_c includes ('Small Group')` pega produtos que têm Segmentos de mercado "Pequeno grupo" e mais ou nenhum segmento de mercado na lista de opções de seleção múltipla. Importante Remova qualquer referência aos campos na `whereClause` da chave de filtro. Por exemplo, se você tiver `vlocity_ins_marketsegment_c:Small Group` no filtro e um `whereClause` contendo uma referência ao mesmo campo, eles colidirão e entrarão em conflito, produzindo resultados imprevisíveis.

Opções de otimização
Opção	Descrição
`includeOptionalCovSelectFlag`	`true` ou `false` Padrão para `false`. Defina essa opção para `true` que o serviço avalie regras de cobertura opcionais antes de passar entradas de classificação para procedimentos de cálculo. Se os produtos não usarem coberturas opcionais, use a configuração padrão de `false`. Obter e adicionar dados de cobertura opcionais à entrada de classificação requer processamento extra e pode desacelerar esse serviço.
`includeRawCalculationResult`	`true` ou `false` Padrão para `false`. Inclui todos os resultados do procedimento de cálculo na chave de `RawPriceData`.
`isBatchMode`	`true` ou `false` Quando definido como `true`, o serviço retorna um JSON de produto simplificado que não inclui categorias de atributo, mas inclui valores e regras selecionados por atributo. Quando definido como `false`, o serviço retorna o JSON de produto completo. Essa opção é útil quando não há UI que consuma os resultados do serviço. Por exemplo, se você estiver executando um procedimento de integração no modo em lote que contenha esse serviço.
`mergeList`	`true` ou `false` Padrão para `false`. Otimiza chamadas de classificação agrupando chamadas de procedimento de classificação por produtos usando o mesmo procedimento de classificação. Ele faz uma chamada de classificação com uma matriz de objetos de entrada. Isso é útil ao capturar uma grande lista de produtos. Várias chamadas de classificação podem atingir os limites de SQL. A arquitetura do procedimento de classificação é otimizada para lidar com uma matriz de objetos de entrada e minimizar o número de consultas SQL necessárias.
`omitChildren`	`true` ou `false` Defina essa opção como true apenas se você também definir `omitRating` como `true`. Isso retorna produtos sem precificação.
`omitRating`	`true` ou `false` Se verdadeiro, o serviço devolverá produtos sem precificação.
`productClasses`	`“ProductClassName1,ProductClassName2”` Lista separada por vírgulas de nomes de classe de produto. Limita a lista de produtos a essas classes de produto.
`rootPricingOnly`	`true` ou `false` Padrão para `false`. Essa opção melhora o desempenho reduzindo os tamanhos de heap. Se o procedimento de classificação que você está usando for definido apenas no nível do produto raiz, você poderá definir essa opção como `true` para melhorar o desempenho.

Opções de regras
Opção	Descrição
`evalOptionalCoverageRelationship`	`true` ou `false`Se definido como `true`, o serviço executa regras de relacionamento de cobertura opcionais.
`omitEligibility`	`true` ou `false` Padrão para `false`. Quando definido como `true`, o serviço não consulta produtos elegíveis. Em vez disso, você deve fornecer um ID de produto de lista sob o `products` de chave no mapa de entrada ou no mapa de opção. Tanto uma lista de IDs de produto quanto uma string de IDs de produto separados por vírgula são valores aceitáveis para `products`.
`ruleAttributeSetValues`	`true` ou `false` Quando definido como `false`, o serviço não executa regras de valor do conjunto de atributos. Quando definido como `true`, o serviço executa as regras de valor do conjunto de atributos.
`validateCoverageSelection`	`true` ou `false` Defina como `true` se você tiver regras de validação que precisar que o serviço execute.

Opções de função complementar
Opção	Descrição
`calculateTaxesAndFees`	Opcional `true` ou `false` Quando definido como `true`, calcula impostos e taxas sobre o produto de destino.
`includeFullProductJson`	`true` ou `false` Essa opção controla a presença de nós netos adicionais em resposta à API com base no JSON de entrada. Quando definido como verdadeiro, há duas alterações no JSON de saída: Se o tipo de neto for Parte segurada, o nó JSON pai conterá dois nós filhos extras; parte principal e outras partes. Esses dois novos nós são preenchidos com base se o `isPrimary` indicador está definido para o nó neto. Se o tipo de neto for Item seguro, esses dois nós (parte principal e outras partes) não estarão presentes na API de resposta. Os netos contidos no JSON de entrada são vinculados ao nó pai correto no JSON de saída da API. Para compatibilidade com versões anteriores, o padrão é `false`.
`jurisdictionIds`	Tipo: Lista estratificada de IDs Usado em conjunto com a opção de `calculateTaxesAndFees`. Calcula apenas os impostos e tarifas associados às jurisdições fornecidas.
`taxAndFeeEffectiveDate`	A data efetiva que esse serviço usa para calcular impostos e tarifas. Essa opção é separada da opção de `effectiveDate` usada para precificar o produto. Se um valor for fornecido, o serviço usará esse valor. Se um valor não for fornecido e o JSON do produto não for uma política, o serviço usará como padrão a data de hoje.
`withTaxFeeRounding`	Opcional Se verdadeiro, os valores de taxa e imposto calculados são arredondados para duas casas decimais usando o método de arredondamento para metade. A `withTaxFeeRounding` é efetiva apenas quando a opção `calculateTaxesAndFees` também é verdadeira. Se falso, o arredondamento estará desabilitado. O valor padrão é false.

Opções de IU
Opção	Descrição
`lastRecordId`	Especifica o ID do último produto que o serviço capturou para a UI. Use essa opção com a opção `pageSize`.
`pageSize`	Determine quantos produtos o serviço retorna à UI em uma chamada.

JSON de entrada

O InsProductService: getRatedProducts procura uma chave userInputs no JSON de entrada. Use o formato de userInputs apropriado, dependendo da definição do produto e da configuração de classificação. O serviço aceita apenas um tipo de formato userInputs por vez.

Um procedimento de classificação por produto para getRatedProducts

Formatar userInputs para produtos que usam um único procedimento de classificação por produto raiz.
Múltiplos procedimentos de classificação por produto ou vários especificações em qualquer nível para getRatedProducts

Formate userInputs para produtos que usam vários procedimentos de classificação na hierarquia de produtos ou várias especificações filho em qualquer nível da hierarquia.

JSON de saída

O serviço retorna uma matriz de um ou mais objetos de produto. Consulte o Modelo de estrutura JSON do produto para obter mais informações sobre esse objeto.

Qualquer userInputs mapeado do JSON de entrada é adicionado ao objeto de produto como a chave de userValues da única instância do atributo para o qual ele foi mapeado.

Para cada produto, o JSON de saída do cálculo do procedimento de classificação é adicionado ao produto com a chave de CalculatedPriceData. Se a fórmula de precificação for definida no produto, o valor de Price será definido como seu valor calculado. Se a fórmula total do seguro for definida no produto, o valor de TotalInsured será definido como o valor calculado.

Neste exemplo, a fórmula de precificação é definida no produto, mas a fórmula de seguro total não é. O CalculatedPriceData é adicionado aos resultados do procedimento de classificação e o preço é calculado com base na fórmula. A fórmula total do seguro não aparece nos dados, nem TotalInsured.

{
  "totalSize": 2,
  "records": [{
      "displaySequence": -1,
      "CalculatedPriceData": {
        "ID": "1",
        "basePremium": 719,
        "premGenlLiab": "356"
      },
      "Id": "01t6A000000FshIQAS",
      "Name": "Economy Business",
      "Family": "Commercial Lines",
      "ProductCode": "bop-ECON",
      "LineOfBusiness__c": "Property & Casualty",
      "Type__c": "BusinessOwners",
      "IsRecommended__c": false,
      "RecordTypeName__c": "Product",
      "IsConfigurable__c": true,
      "PricingFormula__c": "basePremium + premGenlLiab",
      "Term__c": "Annual",
      "productId": "01t6A000000FshIQAS",
      "Price": 1075,
      "childProducts": {
        ...
      },
      "attributeCategories": {
        ...
      }
    },
    {
      ...
    }
  }

filterAttrValues Key

A opção includeFilterAttrValues coloca a matriz de produtos em um nó de ratedProducts e adiciona um resultado de filterAttrValues.

{
  "result": {
    "filterAttrValues": {
      "covType": {
        "listOfValues": [
          "Superior",
          "Economy"
        ],
        "valueDataType": "Text",
        "attributeName": "Type",
        "categoryName": "Policy Terms"
      },
      "covDeductible": {
        "listOfValues": [
          "1000",
          "250"
        ],
        "valueDataType": "Currency",
        "attributeName": "Deductible",
        "categoryName": "Policy Terms"
      }
    },
    "ratedProducts": {
      "totalSize": 2,
      "records": [{
          "displaySequence": -1,
          "CalculatedPriceData": {
            "ID": "1",
            "basePremium": 719,
            "premGenlLiab": "356"
          },
          "Id": "01t6A000000FshIQAS",
          "Name": "Economy Business",
          "Family": "Commercial Lines",
          "ProductCode": "bop-ECON",
          ...,
          "Price": 1075,
          "childProducts": {
            ...
          },
          "attributeCategories": {
            ...
          }
        },
        {
          ...
        }
      }
    }
  }

Cada atributo filtrável é adicionado ao objeto com a chave definida para o código de atributo. O valor de cada atributo de filtro é um objeto que contém o seguinte:

Chave	Valor
`attributeName`	O nome do atributo.
`categoryName`	O nome da categoria.
`listOfValues`	A lista de valores possíveis do produto na matriz.
`valueDataType`	O tipo de dados do atributo, como Texto ou Moeda.

Impostos e taxas

Se impostos e tarifas usarem o serviço, os impostos e tarifas calculados aparecerão em um registro JSON de três maneiras distintas:

Se o registro tiver calculado impostos e taxas, eles serão armazenados como uma lista no campo taxesAndFees.

{
  "taxesAndFees": [{
    "Id": 1,
    "calculatedAmount": 10,
    "Type__c": "Tax"
  }, {
    "Id": 2,
    "calculatedAmount": 15,
    "Type__c": "Fee"
  }]
}

Se o registro tiver calculado impostos sobre si mesmo ou seus filhos, a soma dos impostos calculados sobre si mesmo e seus filhos será armazenada no campo de taxAmount.
```
{  "taxAmount”: 25 // 10 from self, 15 from children}
```
Se o registro tiver calculado taxas sobre si mesmo ou seus filhos, a soma das taxas calculadas sobre si mesmo e seus filhos será armazenada no campo de feeAmount.
```
{  "feeAmount”: 30 // 15 from self, 15 from children}
```

Uma saída JSON de amostra, com impostos e taxas nos registros filhos, bem como na raiz, terá a seguinte aparência:

{
  "Id": 1,
  "productName": "Product",
  "taxesAndFees": [{
    "Id": 1,
    "calculatedAmount": 10,
    "Type__c": "Tax"
  }, {
    "Id": 2,
    "calculatedAmount": 15,
    "Type__c": "Fee"
  }],
  "taxAmount": 25
  "feeAmount": 30
  "childProducts": {
    "records": [{
      "Id": 2,
      "productName": "Insured Item",
      "taxesAndFees": [{
        "Id": 3,
        "calculatedAmount": 15,
        "Type__c": "Tax"
      }],
      "taxAmount": 15
    }, {
      "Id": 3,
      "productName": "Coverage",
      "taxesAndFees": [{
        "Id": 4,
        "calculatedAmount": 15,
        "Type__c": "Fee"
      }],
      "feeAmount": 15
    }]
  }
}

Classificação estrela

Você pode usar a entrada de attributeFilters para filtrar produtos com base em classificações, criadas como atributos por um modelador de produto.

Um procedimento de classificação por produto para getRatedProducts
Formatar InsProductService:getRatedProducts userInputs para produtos que usam um único procedimento de classificação por produto raiz.
Vários procedimentos de classificação por produto ou várias especificações em qualquer nível para getRatedProducts
Formate InsProductService:getRatedProducts userInputs para produtos que usam vários procedimentos de classificação na hierarquia de produtos ou várias especificações filho em qualquer nível da hierarquia.

Este artigo resolveu seu problema?

Diga-nos para podermos melhorar!

Este texto foi traduzido pelo sistema de tradução automática da Salesforce. Mais detalhes aqui.

InsProductService:getRatedProducts

Como funciona

Opções remotas

JSON de entrada

JSON de saída

Impostos e taxas

Classificação estrela

General Information

Required Cookies

Functional Cookies

Advertising Cookies

General Information

Required Cookies

Functional Cookies

Advertising Cookies

Cookie List

Este texto foi traduzido pelo sistema de tradução automática da Salesforce. Mais detalhes aqui.Alternar para inglêsAgora não

Área de produtos

Impacto do recurso

Edição

Experiência

InsProductService:getRatedProducts

Como funciona

Opções remotas

JSON de entrada

JSON de saída

Impostos e taxas

Classificação estrela

Este texto foi traduzido pelo sistema de tradução automática da Salesforce. Mais detalhes aqui.