Explorando consultas e API de consulta

Objective

After completing this lesson, you will be able to criar consultas complexas no banco de dados do SAP Field Service Management Cloud usando o CoreSQL e exportando os resultados com eficiência.

Introdução a consultas e APIs de consulta

Unidade 4: Principais tópicos

Vários conceitos-chave são essenciais para você compreender nessas lições a fim de aproveitar efetivamente os recursos do SAP Field Service Management (FSM).

A lição se concentra em consultas que usam o banco de dados da empresa FSM. "CoreSQL" é a linguagem usada para escrever essas consultas e pode ser usada para gerar instruções SELECT complexas de várias tabelas no banco de dados em nuvem FSM.

O "Grupo de política do usuário" controla o acesso aos dados no sistema. Os dados no banco de dados do FSM Cloud são organizados em "Objetos de transferência de dados" (DTOs), que incluem 'Atividade', 'Chamada de serviço' e 'WorkTimeTask'. É essencial entender os relacionamentos dos DTOs e como eles se vinculam para atender a vários recursos do sistema.

A lição dois sublinha o "Painel de análise", um recurso que apresenta indicadores-chave de desempenho para fácil rastreamento.

O painel usa consultas pré-criadas que podem representar visualmente dados usando vários tipos de gráfico. Você também pode definir suas próprias consultas para análises mais personalizadas.

A lição três aborda os relatórios do FSM, onde "modelos de relatório" são fundamentais para projetar, criar e utilizar relatórios.

Esses modelos, que incluem elementos de design, estilo, arquivos de tradução e imagens, juntamente com os dados da empresa ou do banco de dados móvel, geram o relatório final. "Geração automática de relatório" e "Geração manual de relatório" são dois métodos de criação desses relatórios.

Em todas as lições, o uso do "CoreSQL" para extração de dados é proeminente. A estrutura do banco de dados e a disposição dos DTOs contribuem significativamente para a criação de relatórios e análises. Compreender 'consultas', 'dashboard analítico', 'modelos de relatório' e 'DTOs' é fundamental para dominar essas lições.

Consultas

O SAP Field Service Management oferece aos usuários regulares a opção de consultar o banco de dados da empresa FSM.

O SAP Field Service Management oferece aos usuários regulares a opção de consultar o banco de dados da empresa FSM (desde que os usuários tenham recebido acesso). Esse recurso está disponível em Análise e relatóriosConsultas. Com consultas, você pode efetuar o seguinte:

  • Obter uma lista de dados de acordo com uma consulta
  • Salvar consultas para uso posterior
  • Compartilhar consultas com outros usuários na mesma empresa

Ao definir uma consulta como favorita (Adicionar ao menu), um coração aparece na lista de consultas.

As consultas são escritas no CoreSQL. Ele permite instruções SELECT complexas em várias tabelas no banco de dados em nuvem FSM.

As consultas são escritas no CoreSQL. Este é o mesmo idioma de consulta que está sendo utilizado para o API de consulta FSM. É derivado do PostgreSQL e limitado a operações READ. Ele permite instruções SELECT complexas em várias tabelas no banco de dados em nuvem FSM. A saída resultante pode ser exportada em formatos CSV ou JSON.

O acesso aos dados é controlado pelas configurações no grupo de políticas do administrador.

Os dados no banco de dados do FSM Cloud são estruturados em tabelas, uma para cada tipo de objeto. Estas tabelas são referidas como objetos de transferência de dados (DTO')

Os dados no banco de dados do FSM Cloud são estruturados em tabelas, uma para cada tipo de objeto. Os tipos de objeto ou tabelas são referidos como objetos de transferência de dados ou DTOs. Alguns exemplos de DTOs incluem Atividade, Chamado de serviço e WorkTimeTask. Cada DTO consiste em vários campos de dados diferentes, e cada DTO pode ter vários registros de dados individuais. No total, há centenas desses DTOs.

Os DTOs não são apenas designados pelo seu nome, mas também pelo seu número de versão. Os números de versão aumentam gradualmente ao longo do tempo, à medida que a definição de cada tabela é modificada. Isso pode acontecer, por exemplo, quando um novo campo é adicionado a uma tabela.

A imagem acima é um diagrama simplificado de vários objetos de transferência de dados importantes. O diagrama não está completo, mas mostra várias entidades comumente usadas e suas relações.

Nota

Este diagrama também pode ser útil para as unidades que abrangem regras comerciais e dados mestre para recuperar informações sobre os objetos de transferência de dados principais.

é importante entender como diferentes DTOs se relacionam: quais DTOs podem ser vinculados em primeiro lugar e se eles podem ter um link. Se as tabelas estiverem vinculadas, é importante entender a natureza dessas relações, por exemplo:

  • Cada chamada de serviço (SC) individual é atribuída a exatamente um tipo de chamado de serviço
  • Um tipo de chamado de serviço pode ser referido por muitos chamados de serviço
  • Qualquer atividade individual é atribuída a exatamente um chamado de serviço, mas só pode ser vinculada a 1 ou 0 atribuições de serviço de cada vez

Embora não seja possível fornecer uma síntese completa de todos os DTOs e suas relações aqui, a utilização de consultas FSM pode ajudar você a explorar e compreender o modelo de dados.

A maioria, mas não todos os dados, faz parte do banco de dados da empresa FSM. Alguns dados são armazenados em microsserviços, que não podem ser acessados pela API de consulta/CoreSQL. Em vez disso, esses microsserviços têm suas próprias APIs dedicadas.

O núcleo da lógica e dos dados no Field Service Management é referido como o "monólito". O monólito inclui o banco de dados FSM Cloud de sua empresa FSM. Nem todos os dados, no entanto, fazem parte do banco de dados da empresa FSM: o desenvolvimento de produtos de Field Service Management está implementando cada vez mais microsserviços porque isso torna o desenvolvimento de software mais ágil. Esses microsserviços operam fora do monólito e geralmente têm seus próprios bancos de dados fora do banco de dados da empresa principal, além de ter APIs específicas dedicadas. Por isso, os dados de microsserviços (por exemplo, detalhes do nível organizacional) devem ser recuperados pelo API dedicado correspondente, em vez de usar o API de consulta ou o API de dados.

Ao lado da função Consultas no módulo Análise e relatórios, uma funcionalidade semelhante está disponível para administradores no console de administração para uma empresa FSM. Lá, ele está disponível na guia API de consulta. Os clientes fora do FSM também podem ler a data usando o API de consulta FSM.

As consultas CoreSQL também são componentes importantes de modelos de relatório e regras de negócios. Compreender a API de consulta é uma habilidade inestimável para depuração e ao configurar integrações.

O CoreQL suporta muitas instruções SQL, mas não todas, para a leitura de dados.

O CoreQL suporta muitas instruções SQL, mas não todas, para a leitura de dados. Para um guia completo das instruções suportadas, consulte a documentação de ajuda.

Ao usar Consultas na IU do usuário final ou no módulo Admin, a versão DTO é padronizada com a versão mais recente. Contudo, em regras comerciais, é obrigatório indicar a versão DTO desejada.

Ao escrever uma consulta, é obrigatório usar um alias ao fazer referência a um DTO. Na seguinte consulta, por exemplo, nos referimos ao DTO de atividade com o alias "act": SELECT act FROM Activity act

Aqui estão alguns exemplos de consultas:

  • Obtenção de todos os campos de todas as atribuições de serviço:

    SELECT sa FROM ServiceAssignment sa

  • Obtendo os campos de código e assunto das 10 atividades mais recentes:

    SELECT act.code, act.subject FROM Activity act ORDER BY act.createDateTime DESC LIMIT 10

  • selecionando Dados de parceiro de negócios e Chamado de serviço para chamados de serviço com alta prioridade, juntando-se às 2 tabelas:

    SELECT bp.code, bp.name, sc.code, sc.subject FROM ServiceCall sc LEFT JOIN BusinessPartner bp ON bp.id = sc.businessPartner WHERE sc.priority = 'HIGH'

No console Admin, em API de consulta, você pode executar consultas escritas no CoreSQL e ver os resultados na tela.

A API de consulta no módulo Admin usará a versão mais recente do DTO por padrão. Se você quiser usar uma versão DTO específica, pode selecionar a opção de configurações que permitirá declarar uma versão específica de um objeto de dados suportado. Você também pode selecionar se quer exibir registros da hora como datas/horas ou como um registro da hora Unix. Para simular o que um usuário específico veria, você pode indicar alguns em Executar como.

Para aumentar a facilidade de utilização, o sistema sugere comandos, tabelas e nomes de campo relevantes à medida que você digita. Você pode marcar suas consultas para salvá-las para uso posterior. As consultas mais recentes são visíveis no botão Histórico