Histórico da Página
...
Esse documento possui as informações necessárias para que uma pessoa com conhecimentos em programação na linguagem Progress 4GL possa desenvolver e integrar uma API específica para utilização no painel de Gestão à Vista. Serão detalhados os principais métodos, parâmetros e funções que deverão ser implementados na API para torná-la compatível com a aplicação.
02. CONSTRUINDO UMA API DE NEGÓCIO PARA USO NOS MONITORES EXCUSIVOS
Cada monitor exclusivo deve possui em seu cadastro de metadados uma API Progress vinculada. Essa API será responsável pela busca dos dados e processamento das informações que serão exibidas no painel. A API será executada pelo Gestão à Vista de forma transparente e automática, portanto o desenvolvedor precisará focar apenas em construir os métodos necessários seguindo as diretrizes deste documento. Antes de iniciar o desenvolvimento da API, verifique se o monitor foi corretamente cadastrado no painel de Monitores Exclusivos e já possui todas as suas propriedades (filtros) bem definidas.
...
Esses endpoints irão chamar certas procedures na API de negócio que está cadastrada na tabela Monitor, campo api-negocio, do monitor em questão para que ela retorne os dados necessários para a apresentação.
...
Esse endpoint é responsável por buscar as informações que serão exibidas no monitor, assim como o layout no caso dos monitores do tipo Texto (Info). Ele chama os métodos pi-get-monitor-data-info
ou pi-get-monitor-data-chart
, dependendo se o monitor é do tipo "Info" (texto) ou "Gráfico". Portanto, a API de negócio cadastrada para o monitor deve implementá-los conforme necessário.
O retorno esperado da API muda conforme o tipo do monitor.
02. Api de negócio
Para o funcionamento correto do monitor, é necessário que a Api de negócio possua os seguintes métodos:
Nome | Descrição | Obrigatório |
---|---|---|
pi-get-monitor-data- |
chart | Realiza a busca dos dados que serão visualizados |
nos monitores de |
Gráfico, como |
os categorias, séries e valores para os gráficos. | Somente p/ tipo Gráfico |
pi-get-monitor-data- |
info | Realiza a busca dos dados que serão visualizados |
no monitor de |
Informação, como |
tags, linhas, barra de progresso e valores |
. | Somente p/ tipo Texto | |
pi-get-monitor-detail | Realiza a busca dos dados de detalhes de um monitor (Para apresentação em formato de tabela em uma janela ao detalhar as informações) | Não |
02.A.1 Monitor tipo INFO
Esse tipo de monitor é bastante flexível, permitindo criar layouts diferenciados conforme necessário. Ele é formado por linhas, cuja aparência, altura, largura e conteúdo mudam conforme o retorno da API. É possível customizar cada uma dessas linhas com classes e estilos nativos do HTML, além de ícones do PO-UI. Se o monitor que você está planejando construir for do tipo INFO (texto), confira as informações abaixo:
...