Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

A Carol possui algumas formas para efetuar o consumo de dados por aplicativos terceiros. O formato mais convencional é através de "filters" ou "named queries".


Índice

Índice
indentÍndice
excludeÍndice


Visão Geral


Abaixo um fluxo demonstrando o processo de consumo de dados da Carol através de filter ou named queries:

...

Estes serviços permitem o consumo de dados através de consultas (filter/queries) ou através de consultas nomeadas (named-queries). Ambos recursos serão detalhados nos próximos capítulos.

Filter/Queries


A forma mais convencional de consumo de dados na Carol é através de consultas (filter/queries) e consultas nomeadas (named queries). Esses recursos permitem o consumo de dados considerando a estrutura de dados definida no data model.

...

O print-screen abaixo mostra o serviço utilizado para executar os filtros/queries:



Informações
titleFilter & scrollID

Quando executando filters com o scrollId (scrollable) ativado, sempre deve ser considerado o scrollID retornado na request, utilizando este para a próxima request:

/api/v3/queries/filter/{scrollId}


Este serviço retorna uma lista de golden records, no qual será detalhado no próximo capítulo.


Named Queries


Outra forma de trabalhar com consultas na Carol é através de named queries. As named queries permitem armazenar o filtro/query na Carol, permitindo assim uma manutenção mais ágil da named query.

...

{
    "excludeMergePending": false,
    "filtering": true,
    "minimumShouldMatch": 1,
    "mustList": [
      {
        "mdmFilterType": "TYPE_FILTER",
        "mdmValue": "deviceGolden"
      },
      {
        "mdmFilterType": "TERM_FILTER",
        "mdmKey": "mdmGoldenFieldAndValues.integraterm",
        "mdmValue": true
      },
      {
        "mdmFilterType": "WILDCARD_FILTER",
        "mdmKey": "mdmGoldenFieldAndValues.devicedescription",
        "mdmValue": "{{deviceDescription}}"
      }
    ],
    "resolveRelationships": false
  }


Criando/Atualizando uma named query


As named queries são filtros dentro de um envelope (estrutura Json), armazenados na Carol. Os filtros ficam encapsulados conforme abaixo:

...

O serviço a seguir retorna a lista de named queries existentes, fazendo com que seja possível recuperar todas as named queries existentes neste momento no ambiente:



Eliminando uma named query


Após adicionar uma named query (e obter o código mdmId) é possível eliminar a named query com o serviço abaixo:

...

O parâmetro "force" indica se a named query deverá ser elininado mesmo q eu tenha referência por outros recursos, como um Insight ou Carol App.


Próximos Passos


O próximo capítulo detalha as meta informações disponíveis nos Golden Records.Você pode entender a estrutura dos registros de Golden Record consumidos nesta documentação: https://tdn.totvs.com/display/public/CARL/Detalhes+Golden+Record




HTML
<!-- esconder o menu --> 


<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
</style>