...

• 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

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

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

    • 4. Atualização automática de arquivos extras, exemplo, SIGALOJA.DLL

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

    • Instalando no Windows

    • Instalando no Linux

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

    • Instalando no macOS

• Registrando o certificado SSL para uso do WebAgent

  • Para usuários Windows (automático)

  • Para usuários Linux

  • 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 32 e 64 bits para uso do WebAgent

• Exemplos de integração utilizando o WebAgent

• Sistemas Operacionais homologados

• Sistemas Operacionais em homologação

...

...

...

...

Âncora
InstAdmin1 InstAdmin1

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

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

...

[WEBAGENT]
VERSION=1.x.x "<ajuste esta opção com a versão correta do WebAgent que será disponibilizado>"
Windows_x86=webagent/web-agent-1.x.x-windows-x86.setup.exe
Windows_x64=webagent/web-agent-1.x.x-windows-x64.setup.exe
Darwin_universal=webagent/web-agent-1.x.x-darwin-universal.dmg
Linux_x64_deb=webagent/web-agent-1.x.x-linux-x64.deb
Linux_x64_rpm=webagent/web-agent-1.x.x-linux-x64.rpm

...

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.

Image Modified

Âncora

...

InstAdmin4

...

InstAdmin4

4. Atualização automática de arquivos extras, exemplo, SIGALOJA.DLL (topo)

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

Image Removed

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.

Image Removed

...

Image Removed Instalando no Windows (topo)

Após o download do instalador, basta iniciar sua instalação, que irá seguir sem intervenção do usuário.

Image Removed

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

Image Removed

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, ele será exibido na bandeja de ícones:

Image Removed

...

Image Removed Instalando no Linux (topo)

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

Image Removed Ubuntu

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

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

Image Removed Red hat 8.x

...

...

A partir do WebAgent 1.0.15 e WebApp 10.0.6 (apenas Onça Preta),é possivel definir a atualização automática de arquivos extras, como por exemplo, os arquivos do FrontLoja.

Esta implementação foi feita exclusivamente para Windows.

As chaves a seguir definem o caminho para um arquivo ZIP, que deverá conter a estrutura de diretórios e arquivos que o cliente deseja descompactar na pasta do WebAgent.

📢 Estas chaves estão disponiveis tanto no arquivo AppServer.INI quanto no arquivo JSON de configuração.

[WEBAGENT]
Windows_x86_extras=C:\totvs\files\DLL_SIGALOJA_Win32.zip
Windows_x64_extras=C:\totvs\files\DLL_SIGALOJA_Win64.zip

Âncora
InstUser InstUser

Para o usuário do ERP (topo)

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

Image Added

Âncora
InstWindows InstWindows

Image Added Instalando no Windows (topo)

Após o download do instalador, basta iniciar sua instalação, que irá seguir sem intervenção do usuário.

Image Added

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

Image Added

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, ele será exibido na bandeja de ícones:

Image Added

Âncora
InstLinux InstLinux

Image Added Instalando no Linux (topo)

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

Image Added Ubuntu

sudo dnfapt install ./web-agent<versao>.rpmdeb

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

...

Image Removed Instalando no macOS (topo)

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, com a extenção .dmg, execute o instalador e na sequencia arraste o web-agent para pasta Aplicações (Applications)

Image Removed

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

Image Removed

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

Image Removed

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 Removed

Confirme, cliquando em Abrir Mesmo Assim (Open Anyway)

Image Removed

Clique em Use sua Senha (Use Password)

Image Removed

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 Removed

...

Image AddedFedora, Image AddedOracle Linux e Image Added Red Hat (utilizando o desktop GNOME) 

sudo dnf install oracle-epel-release-el9
sudo dnf update

sudo dnf install libappindicator-gtk3

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

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

Âncora
InstMacOS InstMacOS

Image Added Instalando no macOS (topo)

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 AddedPara utilizar o Websocket Secure (wss) é necessário registrar o TOTVS Certificate em seu sistema operacional.

Â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
CertLinux CertLinux

Para usuários Linux(topo)

    Image Removed Ubuntu    

    Image Added Ubuntu    

• Após 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

  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

        Image AddedFedora, Image AddedOracle Linux e Image Modified Red Hat

...

• 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

...

Aviso
icon false title 🚨 Importante
Importante: O processo de registro do certificado deve ser feito uma unica vez, atualizações do WebAgent assumirão o certificado já registrado automaticamente. O WebAgent, como qualquer aplicação que não seja disponibilizada via Apple Store, precisa ter seus certificados instalados manualmente para execução. Este é o link para documentação oficial para o macOS Sequoia 15: https://support.apple.com/pt-br/guide/keychain-access/kyca2431/mac Para consultar outra versão do sistema operacional, selecione a versão correta:

...

Após instalar o WebAgent, localize o arquivo totvs_certificate_CA.crt na pasta /Applications/web-agent.app/Contents/MacOS

No App Acesso às Chaves (Keychain Access) , selecione Sistema (System), e nasequência Certificados (Certificates).

Aviso
icon false title Importante
🚨 No macOS Sequoia, o atalho pro Keychain mudou, sendo acessado pelo caminho: /System/Library/CoreServices/Applications/Keychain Access.app Image Added

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

...

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)

...

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.

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:

...

...

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.

...

Informações
icon false
Este processo é necessário em distros Linux como Fedora, Oracle Linux e Red Hat, que utilizam o GNOME como desktop padrão, mas não possuem suporte nativo ao system tray, caso utilize, por exemplo, o Fedora com Desktop XFCE, este processo não é necessário. 📢 Este processo não é necessário no Ubuntu.

💡 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:

Bloco de código
language bash theme RDark
cd /opt/web-agent ./web-agent

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"

...

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.

...

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.

/opt/web-agent/web-agent launch "http:

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_headlessSIGAFAT&A=param1&A=param2&A=param3" --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.

...

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

...

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. 

Image Removed

...

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
  

...

Processo 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. (💡 Dica: Clique nas imagens para melhor visualização )

Passos para instalação do WebAgent

Faça login no Portal de Clientes e baixe o WebAgent para Linux: https://suporte.totvs.com/portal/p/10098/download#all/all/all/search/web-agent

Image Removed

Navegue até a pasta de download do WebAgent e siga os passos.

// Descompacte o arquivo tar.gz contendo o WebAgent
tar -xvf web-agent-1.0.12-linux-x64-release.packages.tar.gz

// Instale o RPM
sudo dnf install ./web-agent-1.0.12-linux-x64-release.rpm

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

Habilitando o system tray (icone da bandeja) do WebAgent

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

Image Removed

Selecione GNOME Shell integration

Image Removed

Pressione Adicionar ao Firefox (Add to Firefox)

Image Removed

Pressione Adicionar (Add)

Image Removed

Selecione a opção Permite uso dessa extensão em janelas privadas, e na sequência, pressione Okay

Image Removed

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 Removed

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

Image Removed

Pressione Instalar (Install).

Image Removed

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

Image Removed

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

cd /opt/web-agent
./web-agent

Image Removed

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

Image Removed

A partir deste ponto, seu Oracle Linux esta pronto para testes.

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)

...

...