Árvore de páginas

Versões comparadas

Chave

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

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

Painel
titleListagem de componentes
Expandir
titleMenuComponent

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á.


Expandir
titleHomeComponent

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


Expandir
titleChartComponent

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


Expandir
titleChartsComponent

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


Expandir
titleChartFormComponent

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


Expandir
titleCardComponent

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


Expandir
titleCardsComponent

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


Expandir
titleCardFormComponent

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


Expandir
titleDetailsCardComponent

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


Expandir
titleVisionsComponent

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


Expandir
titleVisionFormComponent

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


Expandir
titleFilterComponent

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

Painel
titleListagem de Serviços
Expandir
titleExcelService

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).


Expandir
titleVisionService

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.



Expandir
titleChartService

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.


Expandir
titleCardService

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.

Expandir
titleDetailsService

Serviço responsável pelos Detalhes dos Cards/Gráficos.

Métodos


putDetails

Método responsável pela alteração dos detalhes dos Cards/Gráficos.

Parâmetros

  • header: Campos referente ao formulário de Card/Gráfico.
  • item: Item referente ao serviço do Card/Gráfico.
  • title: Título do Card/Gráfico.
  • filter: Filtro do Card.
  • chartFilter: filtro do Gráfico.
  • detailFilter: detalhamento do filtro.
  • chart: código do Gráfico.
  • card: código do Card.


getDetailsServices

Método responsável por retornar os detalhes dos Cards/Gráficos.

getDetailJson

Método responsável por retornar um JSON com as propriedades chartFilter e detailFilter.

postService

Método responsável por realizar o POST no ENDPOINT do Card/Gráfico de acordo com as informações do objeto JSON enviado.

Parâmetros

  • json: Objeto JSON com as informações que serão enviadas.
  • endPoint: serviço que receberá as informações do objeto JSON.


putDetailsFilter

Método responsável pela alteração dos detalhes do filtro.

Parâmetros

  • detailFilter: Detalhes do Filtro.


putChart

Método responsável pela alteração do Gráfico.

Parâmetros

  • chart: Código do Gráfico para atualização.


putCard

Método responsável pela alteração do Card.

Parâmetros

  • card: Código do Card para atualização.
Expandir
titleGroupsService

Serviço responsável pelos Grupos de Usuários associados as visões.

Métodos


getGroups

Método responsável por retornar os grupos de usuários associados as visões.

Parâmetros

  • pageSize: Tamanho de itens a retornar por página.



getGroupId

Método responsável por retornar os dados referente a um grupo de usuário.

Parâmetros

  • cGroup: Código do grupo de usuário para retornar as informações.
Expandir
titleLiteralsService

Serviço responsável por retornar os textos referentes as traduções.

Métodos


getLiteralModule

Método responsável por retornar um módulo com as traduções para ser utilizado nas rotinas.

Expandir
titleSharedService

Serviço responsável por carregar a visão selecionada pelo Usuário.

Métodos


putVision

Método responsável por atualizar a Visão selecionada pelo Usuário.

Parâmetros

  • combo: Combo com as visões disponíveis para o usuário.
  • Visions: Visões cadastradas no Dashboard.



getSelectVision

Método responsável por retornar as visões disponíveis para o Usuário através de um combo.

getVision

Método responsável por retornar as informações de Card/Gráfico de acordo com a visão escolhida pelo usuário.

Expandir
titleUsersService

Serviço responsável pelos Usuários associados as visões.

Métodos


getUsersDash

Método responsável por retornar os dados referente aos Usuários do Dash.


getGroups

Método responsável por retornar os dados referente aos Grupos de Usuário do Dash.

 

getUserIdDash

Método responsável por retornar os dados referente a um Usuário do Dash.


getGroupsIdDash

Método responsável por retornar os dados referente a um grupo de usuário do Dash.

04. TABELAS

Painel
titleListagem de Serviços
10
Expandir
titleA1N - Tipo de Card

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

251

A1N_CARSER

Serviço do Card       

C

256

254

A1N_FLDSER

Serviço Campos          

C

256

251

A1N_ITSER

Serviço Itens           

C

256

251

A1N_CABSER

Serviço

Cabeçalho       

Cabeçalho        

C

256

A1N_LOGO 

Logo Code64

M

254

Índice

Número

Índice

1

A1N_FILIAL+A1N_ID

Expandir
titleA1O - Cards

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

29

A1O_DETALH

Título Detalhes

C

30

15

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

251

A1O_EXPFIL

Filtro Expressão

C

256

251

A1O_ENDFIL

Filtro EndPoint

C

256

251

A1O_STATUS

Status

C

15

1

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_

VISAOCódigo da Visão

FILTRO

Exibe Filtro

C

6

1

Índice

Número

Índice

1

A1O_FILIAL+A1O_ID+A1O_IDTIPO

2

A1O_FILIAL+A1O_IDTIPO

Expandir
titleA1P - Tipo de Gráfico

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

251

A1P_SRVDAT

Serviço de Dados             

C

256

251

A1P_SRVFIL

Serviço de Filtro       

C

256

251

Índice

A1P_TITULO

Titulo

C

50

A1P_MAXNIV

Nível Máximo

N

2

A1P_ITSERV

Item Serviço

C

254

A1P_CABSER

Serviço Cabeçalho

C

254

Índice

Número

Índice

1

A1P_FILIAL+A1P_ID

Expandir
titleA1Q - Gráfico

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

251

A1Q_IDTIPO

ID Tipo

Gráfico         

Chart         

C

6

A1Q_EXPFIL

Filtro Expressao

C

256

251

A1Q_FILEND

Filtro EndPoint

C

256

251

A1Q_

STATUS

HELP

Status

A1Q_VISAO

Visão

C

6

Help

C

15

M

10

Índice

Número

Índice

1

A1Q_FILIAL+A1Q_ID

2

A1Q_FILIAL+A1Q_VISAO

Expandir
titleA1R - Visões

Tabela

Nome

A1R

Descrição

Visões

Campos

Nome

Descrição

Tipo

Tamanho

A1R_ID   

ID

Caracter

6

A1R_TITULO

Título

Caracter

30

50

A1R_DESCRI

Descrição

Caracter

50

A1R_CARDS

Códigos dos Cards

Caracter

256

254

A1R_CHARTS

Códigos dos Gráficos

Caracter

254

A1R_USERS

Usuários da Visão

Caracter

254

A1R_GRUPOS

Grupos da Visão

Caracter

256

254

A1R_STATUS

Status da Visão

Caracter

1

Índice

Número

Índice

1

A1R_FILIAL+A1R_ID

05. ASSUNTOS RELACIONADOS