Instalação (topo)

Para o Administrador do Sistema

Para disponibilizar a opção de download do WebAgent na tela de parâmetros do SmartClient WebApp é necessário configurar a origem dos instaladores.

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

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

2. 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: 
No caso do Windows devem ser utilizadas 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_arm64: macOS 64 bits ARM

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

linux_x64_deb: Linux 64 bits pacote DEB (Debian, Ubuntu, etc)

[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

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

Como explicado no tópico Segurança, a conexão com o WebAgent é feita através de um protocolo seguro, o Websocket Secure (wss), para tanto é necessário registrar o TOTVS Certificate em seu sistema operacional.

Image Removed Para usuários Windows

Esse registro é automático para Windows 10/11, 32 ou 64 bits, e será efetivado na primeira abertura do WebAgent.

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

Image Removed Para usuários Linux

Image Removed

Para o Microsoft Edge

Image Removed

Image Removed Para usuários macOS

Para 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) do Mac Image Removed , selecione as chaves de início de sessão ou de Sistema.
• Arraste o arquivo do certificado para o app Acesso às Chaves.
• Se for solicitado que você forneça um nome e senha, digite o nome e a senha de um usuário administrador nesse computador.

Para habilitar o uso do WebAgent pelo SmartClient 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

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

2a - Caso o WebAgent não tenha sido iniciado, ao clicar no botão OK da Tela de Parâmetros, será solicitada autorização para abertura da aplicação, basta clicar no botão Abrir.

Image Removed

Em sua primeira liberação o WebAgent estará disponível para os Sistemas Operacionais:

• Window 32 e 64 bits: 
• Image RemovedWindows 10 Pro/Enterprise ou superior
• Image RemovedWindows 11 Pro/Enterprise ou superior
• Linux 64 bits:
• Image RemovedUbuntu 20.04 LTS ou superior
• Image RemovedRed Hat Enterprise Linux Desktop 8.0 ou superior
• Image RemovedmacOS 11.0 Big Sur ou superior.

windows-x86.setup.exe
Windows_x64=C:\totvs\files\web-agent-1.x.x-windows-x64.setup.exe
Darwin_universal=C:\totvs\files\web-agent-1.x.x-darwin-universal.dmg
Linux_x64_deb=C:\totvs\files\web-agent-1.x.x-linux-x64.deb
Linux_x64_rpm=C:\totvs\files\web-agent-1.x.x-linux-x64.rpm

[WEBAGENT]
VERSION=1.x.x "<ajuste esta opção com a versão correta do WebAgent que será disponibilizado>"
Windows_x86=C:\totvs\files\web-agent-1.

x.

x-

Âncora
InstAdmin2 InstAdmin2

2. Configurando o download do WebAgent a partir do arquivo WebAgent.json (descontinuado)(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:

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

Criando o arquivo WebAgent.json

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

Os arquivos para download serão disponibilizados em uma subpasta do AppServer, exemplo: /home/admin/totvs/appserver/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-release.setup.exe",
    "windows_x64": "webagent\\web-agent-1.x.x-windows-x64-release.setup.exe",
    "darwin_universal": "20-10-10-p12_smartclient_web-agent_1.x.x_mac-universal.dmg",
    "linux_x64_deb": "webagent\\web-agent.deb",  
    "linux_x64_rpm": "webagent\\web-agent.rpm"
}

{
    "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-release.setup.exe",
    "windows_x64": "webagent/web-agent-1.x.x-windows-x64-release.setup.exe",
    "darwin_universal": "20-10-10-p12_smartclient_web-agent_1.x.x_mac-universal.dmg",
    "linux_x64_deb": "webagent/web-agent.deb",  
    "linux_x64_rpm": "webagent/web-agent.rpm"
}

Âncora
InstAdmin3 InstAdmin3

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

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

Image Added

Â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 Red Hat.

Image Added Ubuntu

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

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

Image Added Red hat 8.x

sudo dnf install libappindicator-gtk3

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

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

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

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.

Image Added Para usuários Linux

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

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

Sistemas Operacionais homologados (topo)

...

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

Âncora
Exemplos Exemplos

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 Modified

Consumindo uma DLL

...

através da função ExeDllRun3:

Image Modified

Executando uma aplicação nativa

...

através da função ShellExecute:

Image Modified

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

Image Modified

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

Image Modified