Âncora
Top Top

import.css=/download/attachments/6062824/tecnologia.css

• WebAgent

• As vantagens do WebAgent em conjunto com o WebApp

• WebAgent em linha de comando

  • Abrindo o navegador diretamente pelo Web-Agent

  • Executando aplicações sem interface através do Web-Agent

• A evolução do WebApp

  • Configurando o WebApp a partir do Application Server

• Segurança

• Entendendo as arquiteturas

• WebApp - WebAgent

• Segurança

• Entendendo a arquitetura

  32 e 64 bits para uso do WebAgent

• Instalação (Camada Server e Client)

  • Habilitar automáticamente uma porta para o WebAgent de todos os usuários

• Registro do Certificado (SSL) para uso do WebAgent

• Habilitar WebAgent na Tela de Parâmetros

• Sistemas Operacionais homologados

• Configuração

• Exemplos de uso

...

Âncora
WebAgent WebAgent

WebAgent (topo)

...

O WebAgent

...

é um serviço opcional que precisa ser instalado "apenas" nas estações de trabalho, que necessitem liberar ao WebApp, os mesmos acessos

...

relativos à versão do SmartClient Desktop, dentre eles

...

:

• Leitura e gravação de arquivos locais;

...

• Integração com o pacote Microsoft Office;
• Consumo de DLLs (Windows), SOs (Linux) e Dylibs (MacOS), mais informações consulte ExecInDllOpen.

Consulte a lista dos navegadores homologados para o WebApp.

Image Added

Âncora
Vantagens Vantagens

As vantagens do WebAgent em conjunto com o WebApp (topo)

...

• Simplificação na montagem de ambientes;
• Instalação e atualização mais rápida, devido ao menor numero de arquivos do WebAgent;
• Ambiente HTML sempre atualizado, preparado para os mais novos Frameworks de mercado.

Âncora
command_line command_line

WebAgent em linha de comando (topo)

...

O WebAgent pode ser iniciado via linha de comando, os parâmetros podem ser usados em conjunto, as opções são:

• web-agent -h ou --help
  • Exibe help com essas opções
• web-agent -c ou --console
  • Abre o Agente em console e não no systray, nesse exemplo abrimos em console e subimos o WebAgent na porta 21023:
    • web-agent -c --port 21023
• web-agent -v ou --version
  • Exibe a versão do Agente
• web-agent -t ou --tray
  • Abre o agent via systray
• web-agent --locallog 1
  • Habilita a geração de log de execução do Agente
• web-agent --locallog 0
  • Desabilitar o log de execução

Âncora
Launch Launch

Comando Launch:

Permite abrir diretamente uma janela do navegador* a partir do WebAgent.

Sintaxe:

web-agent launch "ip+porta+*parâmetros" --browser="caminho para o navegador"
*Parâmetros são opcionais.

Exemplos:

No exemplo abaixo, em Windows e Linux, será aberto o SIGAFAT.

Apenas para o exemplo, na mesma linha de comando foram preenchidos os parâmetros de abertura (&A=), artificio muito usado, por exemplo, no SIGALOJA, e muito útil em algumas customizações.

C:\Users\Administrator\AppData\Local\Programs\web-agent\web-agent.exe launch "http://10.173.9.215:5011?E=padrao&P=SIGAFAT&A=param1&A=param2&A=param3" --browser="C:\Program Files\Google\Chrome\Application\chrome.exe"

/opt/web-agent/web-agent launch "http://10.173.9.215:5011?E=padrao&P=SIGAFAT&A=param1&A=param2&A=param3" --browser="/usr/bin/microsoft-edge"

Lista de parâmetros disponíveis:

Âncora
Headless Headless

Execução em Browser Headless:

A partir da versão 1.0.9 do WebAgent para Windows, Linux e MacOS, é possível executá-lo em linha de comando com um browser headless, isto é, o navegador será executado sem interface gráfica com o objetivo de dinamizar automações, testes e etc. Nesse modo, é recomendado o uso dos navegadores Google Chrome, Microsoft Edge ou Mozilla Firefox. 

Sintaxe:

webagent launch "ip+porta+parâmetros" --browser="caminho para o navegador" --headless

Exemplos:

O exemplo abaixo executa a função de usuário u_headless em um navegador sem interface gráfica.

C:\Users\Administrator\AppData\Local\Programs\web-agent\web-agent.exe launch "http://10.173.9.215:5011?E=padrao&P=u_headless" --browser="C:\Program Files\Google\Chrome\Application\chrome.exe" --headless

/opt/web-agent/web-agent launch "http://10.173.9.215:5011?E=padrao&P=u_headless" --browser="/usr/bin/microsoft-edge" --headless

/Applications/web-agent.app/Contents/MacOS/web-agent launch "http://10.173.9.215:5011?E=padrao&P=u_headless" --browser="/Applications/Google Chrome.app/Contents/MacOS/Google Chrome" --headless

{
"policies": {
"Certificates": {
    "ImportEnterpriseRoots": true,
    "Install" [
               "/opt/web-agent/totvs_certificate_CA.crt"
               ]
         }
    }
}

Âncora
WebApp WebApp

A evolução do WebApp (topo)

...

O WebAgent irá trabalhar em conjunto com o WebApp versão 9.0.0 ou superior.

O Front-end do WebApp 9.0.0 foi reescrito utilizando o conceito de Web Components, trazendo melhorias significativas de performance, e uma experiência mais fluida no uso do nosso ERP a partir dos navegadores.

Âncora
Seguranca Seguranca

Segurança (topo)

...

Os

...

navegadores atuais possuem um ambiente de execução segura, chamado Sandbox, que impede o acesso ao dispositivo

...

.

O WebAgent

...

permite esses acessos de forma muito segura, utilizando os seguintes mecanismos:

• Conexão entre o

...

• navegador e o WebAgent exclusivamente via Websocket Secure (wss);
• Conexão entre o

...

• navegador e o WebAgent exclusivamente através do endereço localhost,

...

• bloqueando ataques de IPs externos;

...

• Uso do mesmo protocolo de comunicação

...

• utilizado entre SmartClient Desktop e o Appserver, um motor utilizado a mais de 20 anos, e conhecidamente seguro.

Âncora
Arquitetura Arquitetura

Entendendo

...

as arquiteturas 32 e 64 bits para uso do WebAgent (topo)

Duas integrações dependem do uso da correta arquitetura do WebAgent:

• Integração com o pacote Microsoft Office;
• Integração com DLLs/SOs.

...

O WebAgent para Linux e macOS será distribuido apenas na versão 64 bits.

No caso do Windows ele será distribuido também na versão 32 bits, devido a dois cenários possiveis:

Cenário 1

Utilizar o Windows 64 bits, porém ferramentas 32 bits (exemplos abaixo), nesse caso será necessária a instalação do WebAgent 32 bits para integração.

• Pacote Microsoft Office 32bits;
• DLLs 32 bits, para por exemplo, integração de equipamentos, como impressoras, balanças, caixas registradoras, etc.

Cenário 2

Utilizar o Windows 64 bits, o Office 32 bits e uma integração com DLLs 64 bits (o inverso pode ocorrer).

Nesta caso, é possível instalar as duas versões do WebAgent, 32 e 64 bits, e executá-las em portas separadas, a partir da configuração da Tela de Parâmetros, usando, por exemplo, o WebAgent 32 bits na porta 21021 e o 64 bits na porta 21022:

Image Added

🚨 Para que este segundo cenário funcione será necessário abrir duas sessões distintas do WebApp no navegador, mesmo procedimento adotado caso precisasse utilizar simultaneamente as versões do SmartClient Desktop 32 e 64 bits.

Mais alguns detalhes sobre arquitetura clique aqui.

Âncora
Instalacao Instalacao

Instalação (topo)

...

Para o Administrador do Sistema

Para disponibilizar a opção de download do WebAgent na

...

Tela de

...

Parâmetros do

...

WebApp é necessário configurar a origem dos

...

Para tanto, o Administrador do Sistema deve criar ou editar o arquivo webagent.json na mesma pasta do AppServer.

...

instaladores.

1. Configurando à partir do AppServer.INI

Para consultar todas as opções de configuração acesse o esse link .

[WEBAGENT]
VERSION=1.0.0
Port=21021
Windows_x86=C:\totvs\files\web-agent-1.0.0-windows-x86.setup.exe
Windows_x64=C:\totvs\files\web-agent-1.0.0-windows-x64.setup.exe
Darwin_universal=C:\totvs\files\web-agent-1.0.0-darwin-universal.dmg
Linux_x64_deb=C:\totvs\files\web-agent-1.0.0-linux-x64.deb
Linux_x64_rpm=C:\totvs\files\web-agent-1.0.0-linux-x64.rpm

2a. Configurando a partir do arquivo WebAgent.json - Definindo no AppServer.INI o arquivo que conterá os instaladores para download

🚨 No nosso exemplo utilizaremos o arquivo de configuração com o nome webagent.json, na mesma pasta do AppServer, mas tanto o nome do arquivo quanto o diretório são de sua escolha, ajuste então a configuração de acordo com sua necessidade, por exemplo:

agentJsonUpdate=/home/admin/file_config/installers.json

Para definir o caminho dos instaladores inclua o parâmetro agentJsonUpdatena seção [WebApp] em seu arquivo AppServer.INI.

[WebApp]
Port=5002
ENABLE=1
agentJsonUpdate=webagent.json

2b. Criando o arquivo webagent.json

Seguindo nosso exemplo, crie agora o arquivo webagent.json na mesma pasta do AppServer.

Aqui os arquivos para download serão disponibilizados em uma subpasta do AppServer,

...

exemplo: /home/admin/totvs/appserver/webagent/

🚨 Importante: 
Caso esteja utilizando um AppServer Windows é necessário utilizar barras duplas \\ para configuração do arquivo, pois a primeira barra é considerada um caracter de escape pelo formato .json, e não permitirá o download do instalador.

As Tags abaixo representam o Sistema Operacional e a Arquitetura do WebAgent

...

, as opções são:

• windows_x86: Windows 10/11 32 bits

• windows_x64: Windows 10/11 64 bits

• darwin_x64: macOS 64 bits Intel

...

• darwin_universal: masOS 64 bits Universal Apps (mais informações aqui)

• linux_x64_deb: Linux 64 bits pacote DEB (

...

• Ubuntu

...

• )

• linux_x64_rpm: linux 64 bits pacote RPM (Red Hat

...

• )
  
  

{
    "version": "1.0.0

",
   
    "windows_x86": "webagent

\\web-agent-

1.0.0-

windows-x86-release.setup.exe",
    "windows_x64": "webagent

\\web-agent-

1.0.0-

windows-x64-release.setup.exe",

    "darwin_

universal": "

20-10-10-p12_smartclient_web-agent

_1.0.0_mac-universal.dmg",

    "linux_x64_deb": "webagent\\web-agent.deb",  
    "linux_x64_rpm": "webagent\\web-agent.rpm"
}

{
    "version": "1.0.0

",
   
    "

windows_

x86": "webagent/web-agent-

1.0.0-

windows-

x86-release.

setup.exe",
    "

windows_

x64": "webagent/web-agent-

1.0.0-

windows-

x64-release.setup.

exe",

    "

darwin_

universal": "

20-10-10-p12_smartclient_web-agent

_1.0.0

_mac-universal.dmg",

    "linux_x64_deb": "webagent/web-agent.deb",  
    "linux_x64_rpm": "webagent/web-agent

.

rpm"

}

3. Habilitar automáticamente uma porta para o WebAgent de todos os usuários 

Âncora
AgentPort AgentPort

É possivel habilitar automáticamente uma porta para o WebAgent de todos os seus usuários, impedindo que ele altere esta configuração.

Basta insterir o parâmetro Port na configuração do WebAgent, no arquivo AppServer.ini, no exemplo abaixo configuramos a porta 21021 como padrão,

[WebAgent]
Port=21021

Após habilitar essa chave, a opção "Habilita/Desabilita o Agente Local" não será mais exibida na tela de configuração para o usuário.

Image Added

🚨 Após a configuração deve-se reiniciar o

...

/s AppServer/s.

Para o usuário do ERP

Acessando a Tela de Parâmetros do WebApp, agora será exibida a tela para download

...

dos instaladores:

Image Added

...

O instalador vai sugerir o Sistema Operacional

...

, caso

...

utilize o Windows 64 bits, mas possua o Microsoft Office 32 bits, poderá instalar

...

o WebAgent 32 bits para garantir

...

essa integração,

...

mais

...

detalhes aqui.

...

Image Added

Para instalação no Windows

Após o download

...

do instalador, basta iniciar sua instalação, que irá

...

seguir sem

...

intervenção do usuário.

Image Modified

...

O programa ficará disponível no menu, como neste exemplo

...

utilizando

...

o Windows 11.

Image Modified

...

O WebApp irá iniciar o WebAgent sempre que necessário a partir deste momento, mais detalhes consulte a seção Habilitar WebAgent na Tela de Parâmetros.

Apenas para testes, você pode iniciar a aplicação, será exibido o ícone na bandeja

...

, como no exemplo abaixo.

Image Added

Para instalação no Linux

Após baixar o arquivo para o seu respectivo Linux, sendo o arquivo .deb para Ubuntu e .rpm para o Red Hat.

Para Ubuntu Image Added

sudo apt install ./web-agent<versao>.deb

sudo chmod +x ./web-agent<versao>.deb

Para Red hat 8.x Image Added

sudo dnf install libappindicator-gtk3

sudo dnf install ./web-agent<versao>.rpm

sudo chmod +x ./web-agent<versao>.rpm

Âncora
Certificado Certificado

Registro do Certificado (SSL) para uso do WebAgent (topo)

...

Para utilizar o Websocket Secure (wss) é necessário registrar o TOTVS Certificate em seu sistema operacional.

Image Added Para usuários Windows

O registro é automático para Windows 10/11, 32 ou 64 bits, e será efetivado na primeira execução do WebAgent.

🚨 Importante:
Na primeira execução do WebAgent, caso seja apresentada a tela de confirmação para o registro do certificado, selecione a opção Sim.

Image AddedPara usuários Linux

    Image Added Ubuntu    

• Após a instalação do WebAgent
• Localize o arquivo totvs_certificate_CA.crt na pasta /opt/web-agent
• Acesse seu navegador e efetue o registro:
  • Para o Google Chrome
    • Na barra de navegação digite: chrome://settings/certificates
    • Acesse: Authorities (autoridades)
    • Na sequência: Import (importar)
    • Selecione o totvs_certificate_CA.crt na pasta /opt/web-agent
    • Selecione todos os Trusts, e por fim, o botão OK
      Image Added
      
      

  • Para o Microsoft Edge

    • Na barra de navegação digite: edge://settings/privacy/manageCertificates

    • Acesse: Authorities (autoridades)

    • Na sequência: Import (importar)

    • Selecione o totvs_certificate_CA.crt na pasta /opt/web-agent

    • Selecione todos os Trusts e Okay
      Image Added
      
      

  • Para o Firefox

    • Na barra de navegação digite: about:preferences#privacy

    • Acesse: View Certificates… (verificar certificados)

    • Acesse: Authorities (autoridades)

    • Na sequência: Import (importar)

    • Selecione o totvs_certificate_CA.crt na pasta /opt/web-agent

    • Selecione todos os Trusts e OK
      Image Added
      

   Image Added Red Hat 8.x

• • Para Google Chrome e o Firefox o registro do certificado segue os mesmos passos do Ubuntu.
    

  • Para o Microsoft Edge:

    • O Edge utiliza o certificado do Sistema Operacional, utilize os comandos abaixo para resgistrar:

      • Copie o certificado da pasta do web-agent para a pasta de certificados

        • sudo cp /opt/web-agent/totvs_certificate_CA.crt /etc/pki/ca-trust/source/anchors/

      • Registre o certificado

        • sudo update-ca-trust

      • Verifique se o certificado foi instalado
        • trust list | grep TO   
          label: TOTVS certificate CA
          
          
    • Acesse os links abaixo para mais informações:
      • https://docs.fedoraproject.org/en-US/quick-docs/using-shared-system-certificates/
      • https://www.redhat.com/sysadmin/ca-certificates-cli

Image Added Para usuários macOS

Para mais detalhes acesse a documentação oficial da Apple aqui:

• Após a instalação do WebAgent
  
  
• Localize o arquivo totvs_certificate_CA.crt na pasta /Applications/web-agent.app/Contents/MacOS
• No app Acesso às Chaves (keychain access) Image Added, selecione as chaves de início de sessão ou de Sistema.
  
• Arraste o arquivo do certificado para o app Acesso às Chaves.
• Configure a confiança do certificado clicando com o botão direito sobre o mesmo e escolhendo a opção Get Info. Na interface aberta expanda a opção Trust e coloque Always Trust para todas as opções disponíveis, conforme as imagens abaixo. Se for solicitado que você forneça um usuário, utilize um usuário com acesso de administrador.
  
  

Image AddedImage AddedImage Added

• 🚨 Repita o mesmo processo de registro do Certificado acima para o arquivo totvs_certificate.crt também na pasta /Applications/web-agent.app/Contents/MacOS
  

  
  

  Informações
  title Importante
  Atente-se à utilização dos certificados disponibilizados na pasta de instalação do WebAgent, não utilize os certificados da pasta de instalação do AppServer

...

Âncora
Configuracao Configuracao

...

Habilitar WebAgent na Tela de Parâmetros (topo)

...

Para habilitar o uso do WebAgent pelo

...

WebApp, na Tela de Parâmetros, selecione o botão de configuração.

Image Modified

Escolha a porta de inicialização do WebAgent (por padrão é a 21021).

Image Modified

Na sequencia feche essa janela clicando no X na parte superior da janela de configuração.

Image Modified

🚨Importante: A inicialização do WebAgent pode ser feita de duas formas:

1a - Conforme explicado na seção Instalação, ao iniciar o WebAgent via menu, ele ficará disponível nos ícones da bandeja.

...

Assim que confirmar os dados na Tela de Parâmetros, será

...

exibida a mensagem abaixo, solicitando autorização para abertura

...

do WebAgent, basta clicar no

...

botão Abrir.

Image Modified

Após dez tentativas de conexão malsucedidas ou caso a solicitação de autorização seja ignorada, será exibida a seguinte mensagem: Falha ao conectar com o WebAgent!

Image Added