Índice
Objetivo:
Orientar com um passo a passo para instalação do TReports Agent
Visão Geral
O TReports Agent é gerenciador de configurações para a inicialização do TReports e um controlador para atualização automática de versões.
Possui uma interface responsável por efetuar os passos de instalação do TReports:
- Configuração do provedor de segurança
- Configuração do servidor de licenças
- Configuração do SGDB à ser usado
O TReports Agent é uma aplicação que roda como serviço, no Windows e no Linux, ficando exposto por padrão na porta 7019, podendo ser acessado pelo endereço local, http://localhost:7019.
Esta porta poderá ser configurada usando o arquivo appsettings.Production.json , e adicionando apenas a variável que configura a porta, exe: "urls": "http://*:7019"
Download do arquivo de instalação
Realize o download no link: [a ser definido]
Instalação no Windows
Para todas as operações poderá ser necessário que o usuário tenha privilégios de Administrador.
Visão Geral
Para realizar a instalação e configuração do Smart View, deve-se utilizar o seu Agent, o qual é de simples e rápida instalação, possuindo uma interface web amigável ao usuário.
Além disso, o Agent realiza verificações recorrentes no servidor de gerenciador de atualizações e, caso exista alguma nova versão do Smart View, o download é automaticamente realizado e a nova versão é instalada, de forma que o Administrador do sistema não precise realizar nenhuma ação.
Informações |
---|
No instalador do Agent, é necessário apenas informar o diretório da instalação. O Agent será instalado e o Serviço iniciado, assim prosseguindo para as configurações do Smart View. |
Após sua instalação, o Agent seguirá para um assistente, que é a interface responsável por efetuar a instalação e configuração do Smart View,
O Smart View Agent possui também uma interface de diagnóstico com seguintes ações:
- Monitoramento da Versão Atual
O Agent identifica qual é a versão atual que esta sendo utilizada e monitora se o Smart View está Iniciado ou Parado - Gerenciamento de parâmetros e Configurações do Smart View
Informa o endereço usado para acesso Web ao Smart View
Onde estão as pastas de instalação e de log
E quais são os parâmetros configurados para o Smart View - Monitoramento de Versões Instaladas
Mantem as três últimas versões instaladas
Permite escolher qual versão a ser utilizada e parar ou iniciar o Smart View - Histórico de Atualizações
Mantém um registro do monitoramento automático de atualizações
Identifica se foi encontrada nova versão e se foi ou não atualizada
Instalação no Windows
Instalação simplificada
- Faça download do Instalador do Smart View Agent clicando neste link;
- Extrair todo o conteúdo do arquivo zip e execute o arquivo
Estado |
---|
subtle | true |
---|
title | SmartView.AgentInstaller.exe |
---|
|
; Selecione o diretório de instalação e prossiga para a próxima etapa. Recomendamos que a instalação seja feita no diretório ;
- O instalador irá realizar a instalação na pasta
Estado |
---|
subtle | true |
---|
title | smart-view |
---|
|
, criada automaticamente no diretório selecionado; - Caso o diretório
Estado |
---|
subtle | true |
---|
title | smart-view |
---|
|
já exista, o instalador perguntará se deseja sobrescrever a instalação anterior, caso não queira, um novo diretório deverá ser informado; - Após conclusão, o Smart View já se encontra disponível em seu ambiente e já pode ser configurado via navegador no endereço
Estado |
---|
| |
---|
subtle | true |
---|
colour | Blue |
---|
title | http://localhost:7019 |
---|
|
(ver Configurações do Smart View).
Instalação manual
- Faça download do Agent do Smart View clicando neste link;
Extrair todo o conteúdo do arquivo zip para o diretório de instalação. Recomendamos que a instalação seja feita no diretório Estado |
---|
subtle | true |
---|
title | C:\TOTVS\smart-view |
---|
|
;
- Copie o arquivo zip de instalação para a pasta, ex: C:\TOTVS\TReports
- Realize a extração do conteúdo do arquivo na raiz desta pasta
- Abra o Powershell ou Prompt de comando com permissão de Administrador;
Execute o
seguinte comando abaixo para criar o serviço do
TReports AgentSmart View;
Bloco de código |
---|
language | powershell |
---|
theme | RDark |
---|
|
sc.exe create |
TReports SmartView.Agent binpath="{path-do-arquivo}\TReports.Agent.exe |
start=demand --urls http://*:7019" start=auto |
substitua Substitua este texto pelo caminho da pasta de instalação
, exe: C. Ex.:
TReports;
Execute o
próximo comando abaixo para iniciar o serviço;
Bloco de código |
---|
language | powershell |
---|
theme | RDark |
---|
|
sc.exe start |
TReports
Instalação no LinuxPronto! O Smart View já se encontra disponível em seu ambiente e já pode ser configurado via navegador no endereço
Estado |
---|
| |
---|
subtle | true |
---|
colour | Blue |
---|
title | http://localhost:7019 |
---|
|
(ver Configurações do Smart View).
será - poderá ser necessário que o usuário tenha
|
acesso ao arquivo/pasta mencionado, utilizar o chmod para fazer tais alterações.- privilégios de Administrador.
|
Instalação no Linux
Copie o arquivo zip de instalação para a
pasta, ex: pasta
Bloco de código |
---|
|
/usr/sbin/ |
treportsPode ser necessário utilizar o
chmod comando, chmod
- Realize a extração do conteúdo do arquivo na raiz desta pasta
Crie o arquivo do serviço na rota e com o nome abaixo:
Criação e configuração do serviçoCrie o seguinte arquivo, treportsAdicione a configuração abaixo:Abra o arquivo criado e adicione as configurações abaixo:
treports
Environment="DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1"
WorkingDirectory=/usr/sbin/ |
treportssmart-view
ExecStart=/usr/sbin/ |
treportssmart-view/TReports.Agent |
--urls http://*:7019
[Install] |
WantedBy=multi-user.target |
Informações |
---|
title | Atenção para as seguintes propriedades |
---|
|
Environment, configura a variável de ambiente para o serviço
WorkingDirectory, define a pasta de trabalho do TReports Agent
ExecStart, caminho onde o arquivo zip foi instalado
Atualize
4. Atualize a lista de serviços do SO com o comando
, sudo systemctl Bloco de código |
---|
|
sudo systemctl daemon-reload |
5. Inicie Inicie o serviço
, sudo systemctl start treportscriado
Bloco de código |
---|
|
sudo systemctl start smart-view-agent |
6. Execute Execute o comando para conferir o status
, sudo systemctl status treports-agentLiberação de portas
As seguintes portas deverão ser liberadas para utilização do TReports
- 7019, porta utilizada pelo TReports Agent, escopo local
- Deverá ser utilizada apenas no próprio servidor onde o TReports foi instalado, para instalação, configuração e diagnóstico
- 7017, utilizada pelo TReports, escopo público
- Será utilizada por todos usuários do TReports
- Porta definida para o Servidor de Licenças da TOTVS
- Porta para a integração com o Protheus
Informações |
---|
|
A porta utilizada pelo Agent que por padrão usa a 7019 não realiza permissionamento, portanto ela não deve ser acessível publicamente na rede por questões de segurança Bloco de código |
---|
|
sudo systemctl status smart-view-agent |
- Pronto! O Smart View já se encontra disponível em seu ambiente e já pode ser configurado via navegador no endereço
Estado |
---|
| |
---|
subtle | true |
---|
colour | Blue |
---|
title | http://localhost:7019 |
---|
|
(ver Configurações do Smart View).
Nota |
---|
- Para todas as operações será necessário que o usuário tenha privilégios de Administrador.
- É importante que o servidor consiga resolver o nome do host para um endereço IP, garantindo assim a disponibilização correta do endereço público do Smart View.
|
Configuração de Proxy
Caso o servidor onde o Smart View está sendo instalado possua um proxy para acesso à web é necessário realizar uma configuração adicional, conforme indicado abaixo:
Windows
Configurar variáveis de ambiente via terminal (como administrador) executando os comandos abaixo:
Bloco de código |
---|
|
setx http_proxy http://username:password@proxyaddress:port /m
setx https_proxy http://username:password@proxyaddress:port /m |
Linux
Defina variáveis de ambiente via terminal (como administrador) executando os comandos abaixo:
Bloco de código |
---|
|
export http_proxy="http://username:password@proxyaddress:port"
export https_proxy="http://username:password@proxyaddress:port" |
Em seguida é necessário tornar as variáveis definidas como persistentes em sessões de terminal futuras. Para isso é necessário adicioná-las ao seu arquivo de configuração do shell (~/.bashrc, ~/.bash_profile ou ~/.profile para usuários do Bash).
Exemplo - abra o arquivo com um editor de texto e adicione os comandos export no final:
Bloco de código |
---|
|
nano ~/.bashrc |
Adicione as seguintes linhas ao final do arquivo:
Bloco de código |
---|
|
export http_proxy="http://username:password@proxyaddress:port"
export https_proxy="http://username:password@proxyaddress:port" |
Liberação de Portas & Rotas
Porta 7019
O Smart View disponibiliza uma interface para configuração, atualização e diagnóstico. Esta interface pode ser acessada pela porta 7019.
Dica |
---|
O Agent roda como serviço, podendo ser iniciado automaticamente pelo boot do SO quando o computador é ligado, não precisando de um usuário logado para ser executado. O Agent fica exposto por padrão na porta 7019, podendo ser acessado pelo endereço local, http://localhost:7019. Para acesso ao ambiente de diagnóstico, basta acessar a rota http://localhost:7019/diagnostic. |
Caso seja necessário a substituição da porta padrão do agente, exclua o atual serviço e crie um novo alterando a atual porta pela desejada. Alterações de domínio e tipo de protocolo, http ou https, são realizadas da mesma forma.
Bloco de código |
---|
|
sc.exe create SmartView.Agent binpath="{path-do-arquivo}\TReports.Agent.exe --urls {protocolo-desejado}://{dominio-desejado}:{porta-desejada}" start=auto |
Bloco de código |
---|
language | powershell |
---|
theme | RDark |
---|
title | Exemplo |
---|
|
sc.exe create SmartView.Agent binpath="c:\DiretorioDeInstalacao\TReports.Agent.exe --urls https://*:9077" start=auto |
Aviso |
---|
A interface Web do Agent não realiza controle de acesso via login, assim qualquer usuário com acesso a esta porta terá acesso. Dessa forma, por questões de segurança, essa porta não deve ser acessível publicamente na rede e deverá ser exposta apenas dentro do próprio servidor onde foi realizada a instalação, sendo acessível apenas pelo Administrador do Smart View. |
Porta 7017
Esta é a porta padrão de acesso ao Smart View e por isso deve ser acessível por todos os usuários da rede.
Caso seja necessário alterar a porta de acesso ao Smart View, na interface de diagnóstico do Agent, clicar em "Configuração do Smart View" e, na etapa de Configuração da Integração, clicar em "Configurações avançadas" e alterar a porta em "Configuração de Rede":
Image Added
Servidor de Licenças TOTVS
O Smart View precisa comunicar com um servidor de licença TOTVS para seu pleno funcionamento.
Integração com o ERP
Para que a integração com o ERP TOTVS seja possível, o Smart View precisa se comunicar com os endpoints do ERP e, por isso, o acesso a estes endpoints devem estar liberados que a comunicação com o ERP possa ser estabelecida.
Atualização do Sistema
O Smart View busca sua atualizações diretamente no servidor TOTVS. Para que sistema se mantenha atualizado, é necessário que o acesso ao domínio
Estado |
---|
| |
---|
subtle | true |
---|
colour | Blue |
---|
title | https://SMART-VIEW.totvs.app/ |
---|
|
seja liberado no servidor.