01. VISÃO GERAL

O Dashboard foi desenvolvido para atender a demanda de todas as áreas. Dessa forma, toda a estrutura se baseia em serviços.

Cadastros

  • Tipos de Card e Tipos de Gráficos
    • Os tipos de Card e Gráficos são cadastrados diretamente através do BackEnd.
  • Gráficos, Painéis e Visões
    • O FrontEnd consome os Tipos de Cards/Gráficos;
    • Com Realiza os Cadastro dos Cards/Gráficos;
    • Realiza o Cadastro de Visões.


Exibição de Dados

  1. O usuário seleciona qual visão deseja exibir;
  2. O Dashboard filtra os cards e gráficos de acordo com a visão e aciona os EndPoints informados no tipo de Card/Gráfico.
  3. O BackEnd faz a consulta das informações no banco de dados e retorna os dados do Dashboard;
  4. Os dados são tratados e exibidos para o usuário.

02. COMPONENTES

Componente utilizado para definição do Menu da Rotina. Opções Disponíveis:

  • Home: Tela principal onde serão exibidos os Cards e Gráficos de acordo com a visão selecionada (Componente Home).
  • Gerenciar Cards: Apresenta uma lista com os Cards cadastrados (Componente Cards).
  • Gerenciar Gráficos: Apresenta uma lista com os Gráficos cadastrados (Componente Graphics).
  • Gerenciar Visões: Apresenta uma lista com as Visões cadastrados (Componente Visions).

Serviços Utilizados

Não há.


Componente utilizado para a exibição inicial dos dados. O usuário seleciona a visão desejada (Cadastro de Visões), o sistema filtra os dados conforma e visão e apresenta ao usuário.

Funcionamento

Ao selecionar a visão, um evento é disparado, acionando o serviço putVision (VisionService). Esse serviço é responsável por atualizar o BehaviorSubject setVision, utilizado para atualizar os dados dos Cards e Gráficos.

Serviços Utilizados

SharedService, VisionService


Componente utilizado para imprimir o gráfico.

Funcionamento

O componente recebe a variável chart através do componente pai ChartComponent. O métodoerviço getChart (ChartService) é acionado para retornar os dados do gráfico que serão apresentados.

Serviços Utilizados

ChartService, Router


Componente responsável por apresentar todos os Gráficos cadastrados.

Funcionamento

O Componente funciona como um browser para manutenção de gráficos (CRUD).

Serviços Utilizados

Router, ChartService, PoDialogService


Componente responsável por permitir a inclusão/alteração de gráficos.

Funcionamento

Inclusão

O sistema abrirá um formulário ao usuário. Ao selecionar o Tipo de Gráfico desejado, o sistema carrega de forma dinâmica as demais informações.

Alteração

O sistema recebe o ID do gráfico que deseja editar. Com base nesse ID, o sistema busca os dados do gráfico e preenche as informações do formulário. 

Serviços Utilizados

Router, ChartService, PoDialogService


Componente utilizado para imprimir o card.

Funcionamento

O componente recebe a variável card, para obter os dados, o sistema utiliza o método getServices (CardService). Esse serviço recebe um EndPoint onde estarão as informações a serem apresentadas.

Serviços Utilizados

CardService, Router


Componente responsável por apresentar todos os Cards cadastrados.

Funcionamento

O Componente funciona como um browser para manutenção de cards (CRUD).

Serviços Utilizados

Router, CardService, PoDialogService


Componente responsável por permitir a inclusão/alteração de cards.

Funcionamento

Inclusão

O sistema abrirá um formulário ao usuário. Ao selecionar o Tipo de cards desejado, o sistema carrega de forma dinâmica as demais informações.

Alteração

O sistema recebe o ID do card que deseja editar. Com base nesse ID, o sistema busca os dados do card e preenche as informações do formulário.

Tanto na inclusão quanto na alteração, um modelo do Card é demostrado em tempo real ao usuário.

Serviços Utilizados

Router, CardService, PoDialogService


Componente responsável por exibir os detalhes do Card.

Funcionamento

Ao clicar na opção “Detalhes”, o sistema busca as informações dos detalhes que serão apresentados através do serviço getTypeCardsById (CardService). Com o EndPoint encontrado, o sistema utiliza o serviço genérico getServices (CardService) para retornar o cabeçalho e dados apresentados.

O usuário poderá exportar os dados apresentados através da opção “Exportar”.

Serviços Utilizados

Router, CardService, PoDialogService


Componente responsável por apresentar todas as visões cadastradas.

Funcionamento

O Componente funciona como um browser para manutenção de visões (CRUD).

Serviços Utilizados

Router, VisionService, PoDialogService


Componente responsável por permitir a inclusão/alteração de visões.

Funcionamento

Inclusão

O sistema abrirá um formulário ao usuário. O usuário deverá informar o nome e descrição da Visão. É possível vincular essa visão a vários Cards e Gráficos.

Alteração

O sistema recebe o ID da visão que deseja editar. Com base nesse ID, o sistema busca os dados da visão e preenche as informações do formulário.

Serviços Utilizados

PoNotificationService, VisionService, ActivatedRoute, ChartService, CardService


Componente responsável por montar a tela de Filtro de Informações. Esse componente é utilizado na inclusão/alteração de Cards e Gráficos.

Funcionamento

O Componente espera receber via Input as seguintes informações:

  1. endPontFilter: String contendo o filtro que será utilizado no EndPoint das requisições em formato REST.
    1. Exemplo: eq_product=ABC&eq_order=001
  2. expFilter: String contendo o filtro que será utilizado no EndPoint das requisições em formato Texto
    1. Exemplo: Produto = ABC E Pedido = 001
  3. itemsFields: Os campos que poderão ser utilizados no filtro. O componente espera um array respeitando a interface do PoComboOption.

Com base nesses dados, o sistema exibe a tela e permite criação de novos filtros. Ao incluir/excluir um filtro, o sistema emite um evento (OutPut) retornando um objeto contendo o filtro no formato EndPoint e o filtro no formato texto. Essas informações são utilizadas na gravação do card e gráfico.

Os filtros gravados também são exibidos como Tags no componente FilterTagsComponent.

Serviços Utilizados

PoNotificationService




03. SERVIÇOS

Serviço responsável pela geração do excel.

Métodos


exportAsExcelFile

Método responsável pela exportação do objeto para o excel.

Parâmetros

  • Json: Json que será enviado para o excel;
  • ExcelFileName: Nome do arquivo.

saveAsExcelFile

Método responsável pelo salvamento do objeto em excel, bem como definição do nome que será dado ao arquivo.

Parâmetros

  • Buffer: Xlsx gerado a partir do json;
  • FileName: Nome do arquivo).


Serviço responsável pelo CRUD de visões.

Métodos

getVisions

Método que retorna todas as visões.

postVision

Método responsável pela inclusão de visões.

Parâmetros:

  • Vision: Objeto json que será incluído.

putVision

Método responsável pela alteração de visões.

Parâmetros:

  • Vision: Objeto json alterado;
  • Id: Id do objeto que será alterado com informação passadas no parâmetro vision.

getById

Método responsável por retornar uma visão.

Parâmetros

  • Id: Id da visão que deseja retornar.

removeVision

Método responsável pela exclusão de visões.

Parâmetros

  • Id: Id da visão que deseja retornar.

filterAdvanced

Método responsável por retornar os campos que o usuário poderá filtrar na opção de “Busca avançada” das visões.



Serviço responsável tratar os dados referente aos gráficos.

Métodos


getChart

Método que realiza um Get genérico de acordo com o EndPoint especificado.

Parâmetros

  • Service: EndPoint que será realizado o Get.

getChartbyId

Método que retorna um gráfico específico

Parâmetros

  • Id: Id do gráfico que deseja consultar.

getTypeChartbyId

Método que retorna um tipo de gráfico específico

Parâmetros

  • Id: Id do tipo de gráfico que deseja consultar.

getTypeChart

Método que retorna uma lista de tipos de gráficos.

getCharts

Método que retorna uma lista de gráficos

Parâmetros

  • Filter: filtro que deseja realizar na busca dos gráficos.

deleteChart

Método que deleta um gráfico específico.

Parâmetros

  • Id: Id do gráfico que deseja deletar.

postChart

Método de inclusão de gráficos.

Parâmetros

  • Chart: Json contendo os dados utilizados para inclusão de um gráfico.

patchChart

Método alterar gráficos.

Parâmetros

  • Chart: Json contendo os dados utilizados para alteração de um gráfico.
  • Id: Id do gráfico que deseja alterar.


Serviço responsável tratar os dados referente aos cards.

Métodos


getServices

Método que realiza um Get genérico de acordo com o EndPoint especificado.

Parâmetros

  • Service: EndPoint que será realizado o Get.

getCards

Método que retorna uma lista de cards.

Parâmetros

  • Filter: filtro que deseja realizar na busca dos card.

getTypeCards

Método que retorna uma lista de tipos de cards.

Parâmetros

  • Filter: filtro que deseja realizar na busca dos tipos de card.

getTypeCardsbyId

Método que retorna um tipo de card específico

Parâmetros

  • Id: Id do tipo de card que deseja consultar.

getCardsbyId

Método que retorna um card específico

Parâmetros

  • Id: Id do card que deseja consultar.

deleteCard

Método que deleta um card específico.

Parâmetros

  • Id: Id do card que deseja deletar.

postCard

Método de inclusão de card.

Parâmetros

  • Card: Json contendo os dados utilizados para inclusão de um card.

patchCard

Método alterar cards.

Parâmetros

  • Card: Json contendo os dados utilizados para alteração de um card.

Id: Id do card que deseja alterar.

04. TABELAS

Tabela

Nome

A1N

Descrição

Tipo de Card

Campos

Nome

Descrição

Tipo

Tamanho

A1N_ID   

Número do ID

C

6

A1N_TITULO

Título do Tipo de Card

C

50

A1N_CARSER

Serviço do Card       

C

256

A1N_FLDSER

Serviço Campos          

C

256

A1N_ITSER

Serviço Itens           

C

256

A1N_CABSER

Serviço Cabeçalho       

C

256

A1N_LOGO 

Logo Code64

M

10

Índice

Número

Índice

1

A1N_FILIAL+A1N_ID

Tabela

Nome

A1O

Descrição

Cards

Campos

Nome

Descrição

Tipo

Tamanho

A1O_ID   

Número do ID

C

6

A1O_TITULO

Título do Card

C

50

A1O_DETALH

Título Detalhes

C

30

A1O_INFO1

Informação 01

C

30

A1O_INFO2

Informação 02

C

30

A1O_INFO3

Informação 03

C

30

A1O_INFO4

Informação 04

C

30

A1O_CAMPOS

Campos Card

C

256

A1O_EXPFIL

Filtro Expressão

C

256

A1O_ENDFIL

Filtro EndPoint

C

256

A1O_STATUS

Status

C

15

A1O_IDTIPO

ID Tipo Painel

C

6

A1O_LABEL1

Label 01

C

30

A1O_LABEL2

Label 02

C

30

A1O_LABEL3

Label 03

C

30

A1O_LABEL4

Label 04

C

30

A1O_VISAO

Código da Visão

C

6

Índice

Número

Índice

1

A1O_FILIAL+A1O_ID+A1O_IDTIPO

2

A1O_FILIAL+A1O_IDTIPO

Tabela

Nome

A1P

Descrição

Tipo de Gráfico

Campos

Nome

Descrição

Tipo

Tamanho

A1P_ID

ID

C

6

A1P_TITULO

Título do Tipo de Gráfico

C

50

A1P_SRVFOR

Serviço de Formulário        

C

256

A1P_SRVDAT

Serviço de Dados             

C

256

A1P_SRVFIL

Serviço de Filtro       

C

256

Índice

Número

Índice

1

A1P_FILIAL+A1P_ID

Tabela

Nome

A1Q

Descrição

Gráfico

Campos

Nome

Descrição

Tipo

Tamanho

A1Q_ID   

ID

C

6

A1Q_JSON 

Formulário Json

M

50

A1Q_TITULO

Título

C

256

A1Q_IDTIPO

ID Tipo Gráfico         

C

6

A1Q_EXPFIL

Filtro Expressao

C

256

A1Q_FILEND

Filtro EndPoint

C

256

A1Q_STATUS

Status

C

15

A1Q_VISAO

Visão

C

6

Índice

Número

Índice

1

A1Q_FILIAL+A1Q_ID

2

A1Q_FILIAL+A1Q_VISAO

Tabela

Nome

A1R

Descrição

Visões

Campos

Nome

Descrição

Tipo

Tamanho

A1R_ID   

ID

Caracter

6

A1R_TITULO

Título

Caracter

30

A1R_DESCRI

Descrição

Caracter

50

A1R_CARDS

Códigos dos Cards

Caracter

256

A1R_CHARTS

Códigos dos Gráficos

Caracter

256

Índice

Número

Índice

1

A1R_FILIAL+A1R_ID

05. ASSUNTOS RELACIONADOS