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

• O que é o WebAgent

• Pensado pra ser seguro

• As vantagens do WebAgent em conjunto com o WebApp

• Instalação (Camada Server e Client)

• WebAgent em linha de comando

  • Abrindo o navegador diretamente pelo Web-Agent

  • Executando aplicações sem interface através do WebAgent

• Entendendo as arquiteturas 32 e 64 bits para uso do WebAgent

• Registro do Certificado (SSL) para uso do WebAgent

• Habilitar WebAgent na Tela de Parâmetros

• Sistemas Operacionais homologados

• Exemplos de uso

Âncora
WebAgent WebAgent

O que é o WebAgent (topo)

O WebAgent é um serviço opcional necessário "apenas" nas estações de trabalho que precisem utilizar:

• 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.

Âncora
Seguranca Seguranca

Pensado pra ser seguro (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 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
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 (navegador) sempre atualizado, preparado para os mais novos Frameworks de mercado.

Â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 instaladores.

🚨 Após alterar as configurações abaixo é necessário reiniciar o/s AppServer/s.

1. Configurando à partir do AppServer.INI (recomendável)

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

[WEBAGENT]
VERSION=1.0.0
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 (prefira a configuração pelo AppServer.INI)

🚨 Neste 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 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"
}

Âncora
AgentPort AgentPort

3. Configurando uma porta específica para o WebAgent de todos os usuários

O parâmetro PORT(opcional) habilita uma porta específica para o WebAgent de todos os usuários, impedindo que eles alterem esta configuração.

[WebAgent]
Port=21021
...

Ao 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.

Para o usuário do ERP

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

O instalador vai sugerir o Sistema Operacional e a Arquitetura, caso utilize o Windows 64 bits, mas precise integrar o ERP com o Microsoft Office 32 bits, poderá instalar o WebAgent 32 bits, para permitir essa integração, mais detalhes aqui.

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.

O programa ficará disponível no menu, como neste exemplo utilizando o Windows 11.

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

Apenas para testes, você pode iniciar o WebAgent manualmente, será exibido o ícone na bandeja, como no exemplo abaixo.

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

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

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

Para Red hat 8.x

sudo dnf install libappindicator-gtk3

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

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

Â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: Abrindo o navegador diretamente pelo Web-Agent (topo)

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

web-agent launch...

Sintaxe:

web-agent launch "ip+porta+parâmetros<opcional>" --browser="caminho para o navegador"

Exemplos:

Nos exemplos abaixo será aberto o SIGAFAT e preenchidos os parâmetros de abertura (&A=), artificio utilizado em produtos como SIGALOJA, e ú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

Comando --headles: Executando aplicações sem interface através do WebAgent (topo)

A partir da versão 1.0.9 do WebAgent será possível executar programas 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
Arquitetura Arquitetura

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

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

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

Cenário 1

Utilizar o Windows 64 bits, porém ferramentas 32 bits, nesse caso será necessária a instalação do WebAgent 32 bits para integração com:

• 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).

Neste caso é possível instalar as duas versões do WebAgent, 32 e 64 bits, e executá-las em portas diferentes, 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:

🚨 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
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.

 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.

Para FireFox
O Firefox pode estar desabilitado para utilizar os certificados do sistema, caso isso aconteça, a conexão entre o browser e o webagent falhará. Para resolver, é necessário habilitar os certificados:

• Na barra de navegação digite: about:config
• Clicar em "Aceitar o risco e continuar"
  
• Na barra de pesquisa digite: security.enterprise_roots.enabled e mude a opção para true (verdadeiro) clicando no botão a direita.
  
  

Para usuários Linux

    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:
  

  Informações
  icon false title 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

  Informações
  icon false title 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

  Informações
  icon false title 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

    Red Hat 8.x

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

  Informações
  icon false title Para o Microsoft Edge
  O Edge utiliza o certificado do Sistema Operacional, proceda da seguinte forma para o registro: 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

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) , 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.
  
  

=> =>

• 🚨 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.

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

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

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.

Após dez tentativas de conexão mal sucedidas, ou caso a solicitação de autorização seja ignorada, será exibida a seguinte mensagem:

Âncora
Sistemas Sistemas

Sistemas Operacionais homologados (topo)

O WebAgent está disponível para os Sistemas Operacionais:

• Window 32 e 64 bits: 
  

  • Windows 10 Pro/Enterprise ou superior
  • Windows 11 Pro/Enterprise ou superior
    
    
• Linux 64 bits:
  • Ubuntu 20.04 LTS ou superior

  • Red Hat Enterprise Linux Desktop 8.x

    
    
• macOS x86_64 e Universal (ARM64 e x86_64) 
  • macOS 12.0 Monterey ou superior
    
    • A tentativa de utilizar a versão Universal em macOS anterior resultará no erro abaixo:
      
      

Âncora
Exemplos Exemplos

Exemplos de uso (topo)

Nesta seção listamos alguns exemplos de integração possíveis através do WebAgent:

Integração com o Microsoft Excel, mais informações aqui. (clique nas imagens para visualização full)

Consumindo uma DLL através da função ExeDllRun3:

Executando uma aplicação nativa através da função ShellExecute:

Retornando as pastas e arquivos de um diretório através da função Directory:

Recuperando a configuração da estação de trabalho através do Shift+F6.