...

• O que é o WebAgent

• Pensado pra ser seguro

• Vantagens no uso do WebAgent em conjunto com o WebApp

• Instalação

  • Para o administrador do sistema

    • 1. Configurando o download do WebAgent a partir do arquivo AppServer.INI

      (recomendado)

    • 2. Configurando o download do WebAgent a partir do arquivo WebAgent.json

      (descontinuado)

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

  • Para o usuário do ERP: Baixando o instalador para seu SO

    • Image Added Instalando no Windows

    • Image Added Instalando no Linux

      • Habilitando o icone da bandeja | Para Red Hat, Oracle Linux e Fedora 

    • Image Added Instalando no macOS

• Registrando o certificado SSL para uso do WebAgent

  • Image Added Para usuários Windows (automático)

  • Image Added Para usuários Linux

  • Image Added Para usuários macOS

• Habilitando o WebAgent na Tela de Parâmetros

• Executando o WebAgent em linha de comando

  • Comando launch: Abrindo o navegador diretamente pelo WebAgent

  • Comando --headless: Executando aplicações sem interface através do WebAgent

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

  Sistemas Operacionais homologados

• Exemplos de integração utilizando o WebAgent

• Sistemas Operacionais homologados

• Sistemas Operacionais em homologação

Âncora
WebAgent WebAgent

O que é o WebAgent (topo)

...

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

...

Os navegadores atuais possuem um ambiente de execução segura, chamado Sandbox, que impede o acesso ao dispositivoà sua estação de trabalho.

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

...

Baixe os instaladores do WebAgent a partir da Central de Downloads.Vamos configurar os caminhos para os instaladores

...

...

Âncora
InstAdmin1 InstAdmin1

...

1. Configurando o download do WebAgent a partir do arquivo AppServer.INI

...

(topo)

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

Os parâmetros abaixo representam o Sistema Operacional e a Arquitetura(32/64 bits) do WebAgent:

...

Âncora
InstAdmin2 InstAdmin2

2. Configurando o download do WebAgent a partir do arquivo WebAgent.json (

...

topo)

...

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:

...

Parâmetro	Descrição	Observações
PORT(opcional)	Habilita uma porta específica para o WebAgent de todos os usuários	Essa configuração impede que os usuários alterem a porta do WebAgent. 🚨 Importante: Essa configuração impede que os usuários utilizem o ERP sem o WebAgent instalado/registrado em suas estações.

Bloco de código
language c# theme RDark title Trecho do arquivo AppServer.ini
[WEBAGENT] Port=21021 ...

...

Nota
title Importante
O popup para instalação deixará de ser exibido assim que a primeira conexão entre o WebAgent e o Navegador for bem sucedida, para que não induza o usuário a instalar mais de uma vez a ferramenta. O checkbox "Não mostrar novamente" pode ser usado caso o usuário não precise instalar o WebAgent, e também não queira que esta opção continue sendo exibida. 🚨 A atualização do WebAgent será automática após sua intalação, e acontecerá sempre que o Administrador do ERP atualizar a versão.

O instalador vai sugerir o Sistema Operacional e a Arquitetura(32/64 bits).
Caso utilize o Windows 64 bits, mas precise integrar o ERP com o Microsoft Office 32 bits, poderá baixar o WebAgent 32 bits, mais detalhes aqui.

...

Bloco de código
language bash theme RDark title Caso tenha problema durante a instalação, o comando abaixo define o arquivo como um instalador, execute e na sequencia repita o comando acima
sudo chmod +x ./web-agent<versao>.deb

Image Removed Red hat 8.x

Image Added Red hat 8.x

sudo 

sudo dnf install libappindicator-gtk3

...

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

...

...

...

Image Removed 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.

Âncora
InstMacOS InstMacOS

Image Added Instalando no macOS (topo)

Na configuração do Firefox pode estar desabilitada a utilização de certificados do sistema, causando falha na conexão com o WebAgent, é necessário habilitar os certificados da seguinte maneira:

Na barra de navegação digite: about:config
Image Removed
Clicar em "Aceitar o risco e continuar"
Image Removed

Na barra de pesquisa digite: security.enterprise_roots.enabled e mude a opção para true (verdadeiro) clicando no botão a direita.
Image Removed

Image Removed Para usuários Linux

    Image Removed Ubuntu    

• Após a instalação o 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 Image Removed

  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 Image Removed

  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 Image Removed

   Image Removed Red Hat 8.x

...

Este exemplo de instalação/autorização se baseia no macOS Sequoia. (💡 Dica: Clique nas imagens para melhor visualização )

Após baixar o arquivo de instalação para macOS (Universal), com a extenção .dmg, execute o instalador e na sequencia arraste o web-agent para pasta Aplicações (Applications)

Image Added

Caso esteja atualizando o web-agent, pressione o botão Atualizar (Replace)

Image Added

Abra o web-agent na pasta Aplicações e pressione o botão Done

Image Added

Acesse as configurações do seu Mac e na sequencia Privacidade e Segurança (Privacy & Security)

Role até localizar a seção Segurança (Security) e na sequencia clique em Abrir Mesmo Assim (Open Anyway)

Image Added

Confirme, cliquando em Abrir Mesmo Assim (Open Anyway)

Image Added

Clique em Use sua Senha (Use Password)

Image Added

Digite o usuário e senha de um usuário com autorização de Administrador do equipamento

Clique no botão OK para autorizar a execução do WebAgent

Image Added

Âncora
Certificado Certificado

Registrando o certificado SSL para uso do WebAgent (topo)

...

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

Âncora
CertWin CertWin

Image Added Para usuários Windows (automático) (topo)

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

...

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

...

Registre o certificado

...

• trust list | grep TO    
  label: TOTVS certificate CA

...

• https://docs.fedoraproject.org/en-US/quick-docs/using-shared-system-certificates/
• https://www.redhat.com/sysadmin/ca-certificates-cli

Âncora
CertLinux CertLinux

Image Added Para usuários Linux(topo)

    Image Added Ubuntu    

• Após a instalação o

Image Removed Para usuários macOS

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

• Após instalar do WebAgent
• Localize o arquivo totvs_certificate_CA.crt na pasta /Applicationsopt/web-agent.app/Contents/MacOS
  Image Removed
  No App Acesso às Chaves (Keychain Access) Image Removed, selecione Sistema (System), e nasequência Certificados (Certificates).
  Image Removed
  Arraste o arquivo do certificado para o App Acesso às Chaves (Keychain Access).
  Image Removed
  Configure a confiança do certificado, clicando com o botão direito do mouse sobre o arquivo, e escolhendo a opção Obter Informações (Get Info).
  Image Removed
  Expanda a opção Confiança (Trust), e coloque Confiar Sempre (Always Trust)para todas as opções disponíveis.
  Image Removed
  
• Ao confirmar as informações, se for solicitado usuário e senha, utilize um usuário com acesso de administrador.

...

Para habilitar o uso do WebAgent pelo WebApp, na Tela de Parâmetros, selecione o botão de configuração.

Image Removed

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

Image Removed

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

Image Removed

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

Caso a conexão com o WebAgent falhe ou a solicitação de autorização seja ignorada, será exibida a mensagem de erro a seguir:

Image Removed

...

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

...

Exibe help com essas opções

...

Inicia o WebAgent em console(linha de comando) omitindo o systray(icone na bandeja), nesse exemplo iniciamos o WebAgent em console na porta 21023:

web-agent -c --port 21023

...

Exibe a versão do WebAgent, exemplo:

web-agent -v
v1.0.9-RC3 - x64

...

Abre o WebAgent via systray (default)

...

Define uma porta específica para o WebAgent (a porta padrão é a 21021)

...

0 (default):  Desabilita o log de execução;
1: Habilita a geração de log de execução (necessário apenas quando solicitado por nosso Suporte).

...

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

Image Removed

web-agent launch...

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

...

...

• 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 Image Added

  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 Image Added

  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 Image Added

   Image Added 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

Âncora
CertMacOS CertMacOS

Image Added Para usuários macOS(topo)

Este exemplo de registro do certificado se baseia no macOS Sequoia.  (💡 Dica: Clique nas imagens para melhor visualização )

Após instalar o WebAgent, localize o arquivo totvs_certificate_CA.crt na pasta /Applications/web-agent.app/Contents/MacOS
Image Added
No App Acesso às Chaves (Keychain Access) Image Added, selecione Sistema (System), e nasequência Certificados (Certificates).
Image Added

Arraste o arquivo do certificado para o App Acesso às Chaves (Keychain Access).
Image Added

Configure a confiança do certificado, clicando com o botão direito do mouse sobre o arquivo, e escolhendo a opção Obter Informações (Get Info).
Image Added

Expanda a opção Confiança (Trust), e coloque Confiar Sempre (Always Trust)para todas as opções disponíveis.
Image Added

Ao confirmar as informações, se for solicitado usuário e senha, utilize um usuário com acesso de administrador.

Âncora
AbleSystray AbleSystray

Habilitando o icone da bandeja (topo)

...

💡 Dica: Clique nas imagens para melhor visualização

Abra o Firefox, digite about:addons na barra de endereços, e na sequencia procure por GNOME.

Image Added

Selecione GNOME Shell integration

Image Added

Pressione Adicionar ao Firefox (Add to Firefox)

Image Added

Pressione Adicionar (Add)

Image Added

Selecione a opção Permitir esta extensão em janelas privativas, e na sequência, pressione Okay

Image Added

Na barra de endereços do Firefox digite https://extensions.gnome.org/ , busque por appindicator e selecione a opção AppIndicator and KStatusNotifierItem Support.

Image Added

Selecione a opção OFF para instalar a extensão.

Image Added

Pressione Instalar (Install).

Image Added

Na sequência, a opção mudará automáticamente para ON.

Image Added

Apenas para teste, já que o proprio navegador irá instanciar o WebAgent, siga os passos a seguir:

cd /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:

...

...

O parâmetro de linha &A pode ser utilizado multiplas vezes.

O valor recebido pelo programa através do parâmetro é do tipo caractere, mesmo que seja preenchido um valor numérico.

...

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. 

webagent launch "ip+porta+[parâmetros<opcional>]" --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"
               ]
         }
    }
}

...

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:

Mais alguns detalhes sobre arquitetura clique aqui.

...

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

...

Image Removed macOS x86_64 e Universal(ARM64) 

• macOS 12.0 Monterey ou superior
  

...

Image Added

Para visualizar as opções do WebAgent, basta clicar em seu ícone.

Image Added

A partir deste ponto, seu Linux estará pronto para testes.

Image Added

Âncora
Configuracao Configuracao

Habilitando o 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 Added

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

Image Added

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

Image Added

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

Caso a conexão com o WebAgent falhe ou a solicitação de autorização seja ignorada, será exibida a mensagem de erro a seguir:

Image Added

Âncora
command_line command_line

Executando o 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 -c --port 21023

web-agent -v
v1.0.9-RC3 - x64

Âncora
Launch Launch

Comando launch: Abrindo o navegador diretamente pelo WebAgent (topo)

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

Image Added

web-agent launch...

webagent 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 --headless: 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. 

webagent launch "ip+porta+[parâmetros<opcional>]" --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:

Mais alguns detalhes sobre arquitetura clique aqui.

Âncora
Exemplos Exemplos

Exemplos de integração utilizando o WebAgent (topo)

...

Integração com o Microsoft Excel, mais informações aqui.  (💡 Dica: Clique nas imagens para melhor visualização )

Image Added

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

Image Added

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

Image Added

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

Image Added

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

Image Added

Âncora
Sistemas Sistemas

Sistemas Operacionais homologados (topo)

...

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

Âncora
EmHomolog EmHomolog

Sistemas Operacionais em homologação (topo)

...

Image AddedProcesso de homologação do Fedora 41

Previsão de inicio em 04/11/2024 previsão de finalização em 02/12/2024.

Após instalar o WebAgent (mais informações acesse aqui), siga os passos abaixo.

// Instale as dependencias do WebAgent para o Fedora 41
sudo dnf install libappindicator-gtk3

// Registre o certificado do WebAgent
sudo cp /opt/web-agent/totvs_certificate_CA.crt /etc/pki/ca-trust/source/anchors/
sudo update-ca-trust

Image AddedProcesso de homologação do Oracle Linux 9.x

Previsão de inicio em 04/11/2024 previsão de finalização em 02/12/2024.

Após instalar o WebAgent (mais informações acesse aqui), siga os passos abaixo.

// Instale as dependencias do WebAgent para Oracle Linux 9.x
sudo dnf install oracle-epel-release-el9
sudo dnf update
sudo dnf install libappindicator-gtk3

// Registre o certificado do WebAgent
sudo cp /opt/web-agent/totvs_certificate_CA.crt /etc/pki/ca-trust/source/anchors/
sudo update-ca-trust

...

Exemplos de integração utilizando o WebAgent (topo)

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

Image Removed

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

Image Removed

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

Image Removed

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

Image Removed

...