Linha RM

Atalhos

Páginas filhas
  • Painel de Documentos Eletrônicos


Conteúdo


01. Visão Geral


O painel de documentos fiscais tem como objetivo trazer uma visão detalhada, através de dashboards, dos documentos fiscais eletrônicos, permitindo que o usuário filtre os documentos por tipo, filial, coligada e período. O painel apresenta as informações necessárias para uma rápida consulta de dados.

É importante salientar que o RM só terá acesso as API's do Painel de Documentos Eletrônicos após algumas configurações nos arquivos do Host:


Importante

Essa documentação se aplica somente as páginas em PO-UI da linha RM, e é essencial para o correto funcionamento dos módulos.

Conteúdo totalmente técnico, direcione para o time de TI da empresa.

CONFIGURAÇÃO PARA ACESSO ÀS API's

As evoluções da Linha RM, utilizam a integração da MDI atual com telas em HTML, tudo isso de forma transparente ao usuário. 

Para utilizar esse novo recurso, é necessária a realização de algumas configurações que irão habilitar o uso das APIs que fazem a execução das ações e processos da nova interface.


Configurando as portas API

O aplicativo RM.Host é responsável por hospedar e expor os serviços de APIs. 

Como visto na documentação sobre a configuração da porta webApi., nos arquivos RM.Host.exe.config e RM.Host.Service.exe.config devem ser adicionadas as TAGS relacionadas a porta 8051.

A tag ApiPort configurada nesta etapa será utilizada para acessar as APIs que fazem parte das rotinas das páginas.


Importante

A execução do Host precisa ser como administrador:

  • Caso o Host seja iniciado como aplicativo (RM.Host.exe), certifique-se que ao executá-lo, tenha selecionado a opção "Executar como Administrador".
  • Caso o Host tenha sido instalado como serviço, o usuário do sistema operacional vinculado ao serviço deve ser um administrador.

Para validar se as configurações de portas das APIs foram realizadas corretamente, acesse o browser e digite a URL  http://{IP ou domínio}:{porta}/api/swagger/.

Exemplo: http://10.173.17.242:8051/api/swagger

Importante na validação usar o IP, nome da máquina ou domínio.

Verifique se a página abaixo foi carregada


       


Conectando com o banco de dados

Para que a API saiba em qual banco de dados conectar quando for acionada pelo Módulo, deve-se configurar os arquivos do Host.

Como visto na documentação sobre a Configurando DefaultDB., nos arquivos RM.Host.exe.config e RM.Host.Service.exe.config devem ser adicionadas a TAG DefaultDB.

Para validar se a configuração da comunicação com o banco de dados das APIs foi realizada corretamente, acesse a API via browser.

Exemplo: http://10.173.17.242:8051/api/financial/v1/paymenttypes/1

Neste exemplo estamos buscando do cadastro de Meios de Pagamento todos os que são pertencentes à coligada 1, ao acessar será solicitado um usuário do sistema que tenha acesso a este cadastro dentro do sistema.


Você deverá ter um resultado semelhante a este, onde lista os registros do cadastro de meios de pagamento da coligada 1.


Permissões de Acesso

A funcionalidade "Painel de Documentos Eletrônicos" conta com controle de segurança, sem ele o usuário não conseguirá visualizar as informações do Painel.


02. Vídeos de demonstração

      Vídeo How To - Demonstração

      03. Exemplo de Utilização


      O painel de Documentos Eletrônicos é acessado através do modulo "Gestão de Estoque Compras e Faturamento" > Utilitários > Painel de Documentos Eletrônicos.


      04. Filtros do Painel

      Ação

      Descrição

      1 - Tipo de DocumentoO campo permite que o usuário filtre as informações que serão apresentadas no dashboard pelos tipos de Documentos Fiscais Eletrônicos, sendo este um campo de seleção única.
      2 - Coligada

      O campo permite que o usuário filtre as informações que serão apresentadas no dashboard pelas coligadas, sendo este um campo de multiseleção.

      3 - FilialO campo permite que o usuário filtre as informações que serão apresentadas no dashboard pelas filiais, sendo este um campo de multiseleção.
      4 - EstadoO campo permite que o usuário filtre as informações que serão apresentadas no dashboard pelos Estados, sendo este um campo de multiseleção.
      5 - PeríodoO campo permite que o usuário filtre as informações que serão apresentadas no dashboard dentro de um período, sendo este um campo de intervalo de datas.

      Detalhes



      05. Componente do Gráfico

      AçãoDescrição
      1 - Total de Documentos

      O campo traz a visualização a soma total dos documentos fiscais eletrônicos demonstrados no gráfico;

      2 - Valor TotalO campo traz a visualização a soma do valor total dos documentos fiscais eletrônicos demonstrados no gráfico;
      3 - Qtd. e Valor de cada statusO campo traz a visualização específica de cada status do gráfico, sendo possível visualiza-los ao passar o mouse em uma cor específica;
      4 - Legenda com as cores e os statusO espaço traz a visualização de cada status com cada cor que o representa no gráfico.



      06. Widgets - Visualização por status de documento

      Será apresentado na tela um widget para cada status de documento retornado.

      Ação

      Descrição

      1 - Título do StatusO componente trará a descrição de um dos status de documento retornados, de acordo com o filtro aplicado.Sua cor será a mesma apresentada no gráfico.
      2 - QuantidadeSomatório da quantidade de documentos com o referido status que foi retornada pelo filtro especificado.
      3 - ValorSomatório do valor dos documentos com o referido status que foi retornado pelo filtro especificado.



      07. Listagem de Status por Coligada

      Ação

      Descrição

      1 - Nome e CNPJ
      da coligada      		O componente trará o nome da coligada, seguido pelo CNPJ logo abaixo.
      2 - Quantidades por status Quantidade específica de cada status de documento daquela coligada, separado pelas mesmas coresdo widget. 
      3 - Quantidade e Valor TotalQuantidade e Valor total dos status da respectiva coligada.



      08. Listagem de Status por Filial 

      Ação

      Descrição

      1 - Colunas da TabelaO componente trará o Código da filial, o Nome da filial e os status que possuem alguma nota;
      2 - Itens da TabelaO componente trará os dados especificados de cada filial da coligada correspondente; São tragos para a tabela somente 10 itens por vez;
      3 - Gerenciador de ColunasO componente permite com que o usuário configure a disposição de colunas da tabela;
      4 - Barra de PesquisaUma barra de texto que permite com que o usuário busque um item específico pelo código ou nome da filial;
      5 - Botão para carregar mais itensO componente faz com que seja carregado mais 10 itens para tela, e estará habilitado para acionamento até que não haja itens a serem carregados.