Índice
Índice |
---|
outline | true |
---|
exclude | .*ndice .pré requisitos |
---|
style | square |
---|
|
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
Aplicação do patch do BAInstaller obtido no Portal do Cliente.
- Dispor do projeto padrão TOTVS Fast Analytics®, que deve ser criado e exportado pelo time Comercial/ Customer Success.
Possuir o Java® com o JRE versão 8 ou superior instalado na máquina em que o programa será executado.
Liberação da porta 443 e algumas URL's no servidor do cliente.
Caso o Agent seja executado pelo Schedule do Protheus®, é necessário criar a pasta biextractor dentro do diretório Rootpath utilizado pelo Protheus® e adicionar os arquivos do Agent.
![](/download/attachments/318605315/image2017-12-7_15-18-40.png?version=1&modificationDate=1512670721000&api=v2)
O TOTVS Fast Analytics® por padrão, é instalado por empresa, porém é possível executar a instalação por Empresa\Filial. Para isso, é necessário configurar no appserver.ini o parâmetro BAFILIALEXEC para o valor igual á 1.
Passo-a-Passo
Protheus®
Inicie o TOTVS SmartClient®.
No campo "Programa Inicial", preencha com BAInstaller e os demais campos com suas respectivas informações de ambiente. Em seguida, clique em "Ok".
![](/download/attachments/318605315/image2017-12-5_17-46-55.png?version=1&modificationDate=1512507901000&api=v2)
Selecione a(s) área(s) que deseja instalar e clique em "Confirmar" ou "Cancelar", para interromper a instalação.
![](/download/thumbnails/318605315/image2018-3-23_9-25-35.png?version=1&modificationDate=1521807936000&api=v2)
Aguarde o processo ser concluído e clique em "Ok".
![](/download/attachments/318605315/image2017-12-8_16-18-51.png?version=1&modificationDate=1512760732000&api=v2)
Dica |
---|
Para conferir a conclusão da instalação, realize uma consulta na tabela de processos I01. Serão listadas as consultas instaladas. ![](/download/attachments/318605315/image2017-12-7_14-38-55.png?version=1&modificationDate=1512668338000&api=v2)
|
Agent
A atualização dos dados no Gooddata® pode ser efetuada via arquivo .properties ou Interface.
Deck of Cards |
---|
|
Card |
---|
| Configure o arquivo .properties. Dica |
---|
O seguinte documento apresenta todas as informações necessárias para o correto preenchimento do arquivo my.properties: Configuração do my.properties. |
Execute o Run.bat. ![](/download/attachments/318605315/image2017-12-6_14-27-40.png?version=1&modificationDate=1512581261000&api=v2)
Dica |
---|
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. |
Aviso |
---|
Se for retornado algum erro que impediu o fim da execução do processo do Agent, ou se ainda possui dúvidas, acesse: Agent |
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. 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. |
Card |
---|
| 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: Nota |
---|
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
Expandir |
---|
title | Cadastro de Projetos |
---|
| 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.
Selecione o produto Fast Analytics no item Linha de Produto. Informe o usuário e senha para conexão ao projeto do Gooddata® e clique em Carregar Projetos. Se os parâmetros de conexão estiverem corretos, na aba Projeto será carregado o primeiro projeto da lista. Ao selecionar o Processo URL a aba de Graph será carregado com a Main. 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. 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. É 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. É 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.
![](/download/attachments/318605315/image2019-2-8_9-22-50.png?version=1&modificationDate=1549628732570&api=v2)
As opções que podem ser executadas pelo usuário são:
Expandir |
---|
| Permite ao usuário cadastrar um projeto para execução pelo Agent. |
Expandir |
---|
| Apresenta ao usuário as informações do projeto e permite ajustá-las. |
Expandir |
---|
| Remove o projeto do cadastro e do processo de atualização no Gooddata® |
Expandir |
---|
| A opção de exportação gera dentro da estrutura do Agent por Interface as queries instaladas no Protheus® e permite ao usuário customizá-las, quando necessário. Selecione o projeto e clique em Exportar Queries. Ao final do processo será apresentado o caminho onde os arquivos foram armazenados.
![](/download/attachments/318605315/image2019-1-22_17-15-14.png?version=1&modificationDate=1548188120213&api=v2) |
Expandir |
---|
| Remove os arquivos de queries armazenados na estrutura do Agent por Interface. |
|
Expandir |
---|
| A tela Cadastrar Banco de Dados permite informar as configurações de acesso à base de dados que serão utilizadas pelo Agent. Informe um identificador para a base de dados em Nome da Configuração. Selecione o tipo de banco de dados na opção Banco de Dados e informe o usuário e senha para conexão. Ajuste o item URL para o caminho correto do banco de dados. 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. - Clique em Testar Conexão para verificar se os dados informados estão corretos.
- Clique em Salvar.
![](/download/attachments/318605315/image2019-1-29_18-54-30.png?version=1&modificationDate=1548798870570&api=v2)
|
Expandir |
---|
| A tela Parâmetros JAVA para execução do Agent permite informar configurações adicionais que serão utilizadas pelo Agent. Clique em Nova. Adicione um identificador para a configuração e clique em Adicionar. Informe todos os parâmetros que farão parte da configuração e clique em Configurar.
![](/download/attachments/318605315/image2019-1-22_17-21-59.png?version=1&modificationDate=1548188519203&api=v2)
Nota |
---|
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. |
Dica |
---|
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
![](/download/attachments/318605315/image2019-1-22_17-23-0.png?version=1&modificationDate=1548188580957&api=v2)
|
|
Expandir |
---|
| 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
![](/download/attachments/318605315/image2019-2-8_10-48-13.png?version=1&modificationDate=1549633858443&api=v2)
Nota |
---|
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. - Em Nome do Agendamento adicione um identificador.
- Selecione qual projeto na opção Projetos.
Configure os Parâmetros SQL que serão utilizados nas consultas.
Nota |
---|
Ao informar um parâmetro fixo é necessário desabilitar a opção Expressão para que o processo seja executado corretamente. |
Configure os Parâmetros ETL Informe a frequência que o processo deve ser executado na sessão Agent e clique em Salvar.
![](/download/attachments/318605315/image2019-2-8_10-56-52.png?version=1&modificationDate=1549634378623&api=v2)
![](/download/attachments/318605315/image2019-2-8_10-57-29.png?version=1&modificationDate=1549634414723&api=v2)
![](/download/attachments/318605315/image2019-2-8_10-59-24.png?version=1&modificationDate=1549634530787&api=v2)
As opções que podem ser executadas pelo usuários são:
Expandir |
---|
| Permite ao usuário cadastrar um Agendamento para execução do Agent. |
Expandir |
---|
| Apresenta ao usuário as informações do agendamento e permite ajustá-las. |
Expandir |
---|
| Remove o agendamento do processo de atualização no Gooddata® |
Expandir |
---|
| 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. Aviso |
---|
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. |
|
|
Expandir |
---|
| A tela Log apresenta ao usuário as informações do processo.
Abrir Arquivo Log: Efetua a abertura do log completo do Agent. ![](/download/attachments/318605315/image2019-1-29_18-56-28.png?version=1&modificationDate=1548798988703&api=v2)
|
Expandir |
---|
| No menu Configurações é apresentada a tela de configurações do serviço do Agent. ![](/download/attachments/318605315/image2019-2-13_13-52-33.png?version=1&modificationDate=1550076753640&api=v2)
Nessa tela é exibida a porta do servidor da aplicação. Aviso |
---|
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. Dica |
---|
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. |
|
|
|