Índice


Objetivo

TOTVS Fast Analytics® é um produto de Business Analytics, que proporciona tomada de decisão orientada por dados. Este produto é responsável por extrair os dados dos diversos módulos suportados pelo Microsiga Protheus® e levá-los até a plataforma GoodData®, nas quais serão processados e as informações sumarizadas são apresentadas em relatórios e/ou dashboards. Este guia apresenta os procedimentos para implantação de App/Área a seleção e configuração do TOTVS Fast Analytics®.

Guia de Implementação

Pré Requisitos

Passo-a-Passo

Protheus®

  1. Inicie o TOTVS SmartClient®.

  2. No campo "Programa Inicial", preencha com BAInstaller e os demais campos com suas respectivas informações de ambiente. Em seguida, clique em "Ok".



  3. Selecione a(s) área(s) que deseja instalar e clique em "Confirmar" ou "Cancelar", para interromper a instalação.



  4. Aguarde o processo ser concluído e clique em "Ok".


    Para conferir a conclusão da instalação, realize uma consulta na tabela de processos I01.

    Serão listadas as consultas instaladas.

Agent

A atualização dos dados no GoodData® pode ser efetuada via arquivo .properties ou Interface.


  1. Configure o arquivo .properties.

    O seguinte documento apresenta todas as informações necessárias para o correto preenchimento do arquivo my.properties: Configuração do my.properties.

  2. Execute o Run.bat.

    Lembre-se que este arquivo deve estar apontando para o arquivo .properties configurado e o Agent (arquivo jar) desejado. Consulte o seguinte documento para mais informações: Verificar versão do Agent.

    Se for retornado algum erro que impediu o fim da execução do processo do Agent, ou se ainda possui dúvidas, acesse: Agent

  3. Ao finalizar a execução, abra o arquivo agent.log (contido na pasta log  do Agent) para verificar se ocorreram erros durante o processo de ETL.

  4. Após a execução com sucesso do Agent, acesse os dashboards na plataforma GoodData® para visualizar os valores processados.

Agendamento da execução do Agent

A execução do Agent poderá ser agendada via Schedule do Protheus®.

Para informações sobre como configurar o agendamento, acesse: Execução do Agent via Schedule.

O Agent por Interface permite a configuração e execução do processo do agent de forma mais fácil e intuitiva, minimizando o tempo de implantação e eventuais erros de configuração. Este processo é realizado através do arquivo totvs-agent.exe e suas principais funcionalidades são descritas a seguir:

Ao utilizar o Agent por Interface não é necessário efetuar a configuração do agent no Scheduler do Windows, pois todo o processo é controlado pela ferramenta.


Pré Requisitos

  • O processo de instalação das queries executado - BAINSTALLER;

  • Pacote do Agent Interface baixado do Portal do Cliente ( Protheus - TOTVSTEC-FRAMEWORK - BA - AGENT_INTERFACE-X.0.0.ZIP ) e descompactado.

  • Executar o arquivo totvs-agent.exe como Administrador para permitir a correta instalação e execução dos serviços.


O Cadastro de Projetos armazena as informações necessárias para a conexão com o projeto do GoodData®, conexão com o banco de dados e agendamento do processo.


  1. Inicialmente  aperte o botão Cadastrar Projeto e selecione o produto no item Linha de Produto. Atualmente existem 3 tipos ( Protheus, Datasul, RM)

  2. Selecione o agent Fast Analytics no item Tipo Agent.

  3. Informe o usuário e senha para conexão ao projeto do GoodData® e clique em Carregar Projetos.

  4. Se os parâmetros de conexão estiverem corretos, na aba Projeto será carregado o primeiro projeto da lista.

  5. Ao selecionar o Processo URL a aba de Graph será carregado com a Main.

  6. A seguir, serão apresentadas as informações do Arquivo.zip e a URL para upload do arquivo .zip. Caso seja necessário, estas informações podem ser ajustadas.

  7. Selecione o Banco de Dados que será utilizado no projeto. Este cadastro pode ser efetuado pelo botão ( + ), ou na opção Banco de Dados do menu lateral.

  8. É possível informar configurações adicionais para a execução do JAVA. Este item pode ser cadastrado à partir do botão ( + ), ou na opção Configuração JAVA no menu lateral.

  9. É possível adicionar arquivos externos ao arquivo .zip enviado ao GoodData®. Basta utilizar as opções Diretório de arquivos para upload e informar a extensão dos arquivos no campo Tipo de Arquivo.

      

      

       

Para o cadastro de projetos das linhas RM e Datasul, é necessário informar alguns dados adicionais:

  • Diretório de Queries: Caminho onde se encontram os arquivos a serem executados pelo Agent.
  • Pasta de Scripts: Nome da pasta onde os scripts estão armazenados. Esta informação é específica para a linha RM.


Tela do projeto para a linha RM

Tela do projeto para a linha Datasul


As opções que podem ser executadas pelo usuário são:


Permite ao usuário cadastrar um projeto para execução pelo Agent.

Apresenta ao usuário as informações do projeto e permite ajustá-las.

Remove o projeto do cadastro e do processo de atualização no GoodData®

Remove os arquivos de queries armazenados na estrutura do Agent por Interface.

A tela Cadastrar Banco de Dados permite informar as configurações de acesso à base de dados que serão utilizadas pelo Agent.

  1. Informe um identificador para a base de dados em Nome da Configuração.

  2. Selecione o tipo de banco de dados na opção Banco de Dados e informe o usuário e senha para conexão.

  3. Ajuste o item URL para o caminho correto do banco de dados.

  4. Se o banco de dados utilizado for Oracle, é possível informar o schema que será utilizado pelo processo através do item Schema do banco de dados.

  5. Clique em Testar Conexão para verificar se os dados informados estão corretos.
  6. Clique em Salvar.

A tela Parâmetros JAVA para execução do Agent permite informar configurações adicionais que serão utilizadas pelo Agent.

  1. Clique em Nova.

  2. Adicione um identificador para a configuração e clique em Adicionar.

  3. Informe todos os parâmetros que farão parte da configuração e clique em Configurar.

Os parâmetros de execução do JAVA devem ser cadastrados um por linha. Para incluir um novo parâmetro no cadastro, clique em Adicionar.

Exemplo de configuração

  • Alterar o caminho do diretório temporário: -Djava.io.tmpdir=F:\temp\fast
  • Valor mínimo de memória utilizada pelo JAVA: -Xms256m
  • Valor máxima de memória utilizada pelo JAVA:-Xmx2048m

A tela Agendamento engloba os itens para o processo, como o serviço do Agent, Parâmetros SQL, Parâmetros ETL e execução do Agent.

Serviço do Agent

  • Iniciar Serviço: Instala e inicia o serviço do Agent

  • Parar Serviço: Interrompe o serviço do Agent

  • ...: Apresenta as seguintes opções

    • Remover Serviço: Remove o serviço do Agent do sistema.

Ao utilizar o Agent por Interface não é necessário realizar a configuração do agent no Scheduler do Windows, pois todo o processo é controlado pela ferramenta.


Agendamento

Selecione o botão + Novo para cadastrar Agendamento.

  1. Em Nome do Agendamento adicione um identificador.
  2. Selecione qual projeto na opção Projetos.

  3. Configure os Parâmetros SQL que serão utilizados nas consultas.

    Ao informar um parâmetro fixo é necessário desabilitar a opção Expressão para que o processo seja executado corretamente.


  4. Configure os Parâmetros ETL

  5. Informe a frequência que o processo deve ser executado na sessão Agent e clique em Salvar.




As opções que podem ser executadas pelo usuários são:


Permite ao usuário cadastrar um Agendamento para execução do Agent.

Apresenta ao usuário as informações do agendamento e permite ajustá-las.

Remove o agendamento do processo de atualização no GoodData®

Permite executar de forma imediata o processo de atualização no GoodData®.

O acompanhamento do processo pode ser efetuado através do menu lateral Log.

Para utilizar esta opção, é necessário que o serviço do agent esteja iniciado. Para iniciá-lo, acesse o menu lateral Agendamento e clique em Iniciar Serviço.

A tela Query apresenta ao usuário as queries cadastradas e já exportadas pela aplicação.


As opções que podem ser executadas pelo usuários são:

Permite ao usuário exportar as queries disponíveis na tabela I01 do banco de dados atrelado ao projeto.


Na lista Projetos, serão apresentados somente os projetos do Fast Analytics cadastrados na aplicação.

Os arquivos exportados ficam armazenados na estrutura do Agent por Interface.

Permite ao usuário cadastrar novas queries para execução no processo. Estas informações serão armazenadas fisicamente, dentro da estrutura do Agent Interface.

  1. Selecione no campo Projeto para qual projeto a query será disponibilizada.
  2. Informe no campo Nome do Arquivo a identificação da query com extensão .txt
  3. No campo Tipo, selecione o tipo de informação a ser gerada, podendo ser uma fato ou dimensão.
  4. Para queries do tipo Fato, selecione a Recorrência:
    • Período:  será executado de acordo com o período informado.
    • Mensal: a query respeitará o período informado, porém será executada mês a mês..



A lista Projeto, apresenta apenas os projetos que possuem itens exportados.

As informações passadas na tela, durante o cadastro, são importantes para determinar como será o comportamento do Agent.


Para cada item exportado, é possível:

  • Editar: permite a edição da query para eventuais ajustes.
  • Remover: remove o arquivo fisicamente do disco, assim, ele não será mais executado.


Na opção Editar, somente o campo de conteúdo da query pode ser modificado.

A tela Monitor apresenta ao usuário as informações do processos que foram executados.


Ao clicar no botão Detalhar: Efetua a abertura detalhada da execução do Agent.

No menu Configurações é apresentada a tela de configurações do serviço do Agent.

Nessa tela é exibida a porta do servidor da aplicação.

Caso a porta do servidor seja alterada é necessário reinstalar o serviço do Agent e reiniciar a aplicação.

Também é possível alterar a frequência em minutos com que o serviço é executado, além de habilitar a exibição das consultas a serem efetuadas na extração dos dados para o projeto.

As consultas só serão exibidas caso a opção de exibição esteja habilitada e se o projeto do GoodData® conter um token que permita exíbi-las.