Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Âncora
Top
Top

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

Pagetitle
TOTVS | WebAgent
TOTVS | WebAgent


Nota
titleNota de Liberação

📢  O desenvolvimento do WebAgent já foi concluído, e tem liberação prevista para inicio dos testes por nossos Clientes até o final do 1o Trimestre de 2022.
       Data que pode ser revista de acordo com os testes já em execução para sua liberação definitiva.

📢  O WebAgent irá trabalhar em conjunto com o SmartClient WebApp versão 9.0.0 ou superior, também com liberação prevista para final do 1o Trimestre de 2022.

Informações importantes
  • 🚨 O WebAgent é compatível com o WebApp 9.0 ou superior e o Application Server 20.3.0.x (Harpia) ou superior.
  • 🚨 Para utilizar o WebApp 9.0 na release 12.1.33 é necessário atualizar seu ambiente com a Lib Protheus 20221010 ou superior.
  • 🚨 O WebAgent ainda passará por homologação para uso com o Logix. (informação atualizada em Out/2022)

📢 Assista esse episódio do Explica aí pra Gente! para conhecer mais sobre a configuração e utilização do WebAgent.

...

Â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

...

Image Removed

Informações

Para uso das rotinas padrão, como cadastros e relatórios, não existe impedimento no uso do ERP sem a utilização do WebAgent.

Consulte a lista dos navegadores homologados para o WebApp.

Image Added

Âncora
Vantagens
Vantagens

As vantagens do WebAgent

...

em conjunto com o

...

O Front-end da versão 9.0.0 do WebApp foi reescrita utilizando o conceito de Web Components, trazendo melhorias significativas de performance.

Em conjunto com o WebAgent, esta melhoria de performance tem como objetivo trazer uma usabilidade mais fluida do nosso ERP a partir dos navegadores, aproximando-se da experiência obtida hoje com o SmartClient Desktop.

...

Os Navegadores modernos (ex: Edge, Chrome e Firefox) possuem um ambiente de execução segura, chamado Sandbox, que impede o acesso ao dispositivo onde está sendo executado.

O WebAgent é um aplicativo seguro, que permitirá ao Smartclient HTML acesso às operações bloqueadas, citadas acima.

🔍Os mecanismos de segurança para execução do WebAgent são:

  • 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, impedindo acesso ao dispositivo, via Navegador, a partir de ataques externos;
  • O protocolo de comunicação entre o Navegador e o WebAgent é o mesmo utilizado entre SmartClient Desktop e o Appserver, um motor utilizado a mais de 20 anos, e conhecidamente seguro.

...

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.

Caso utilize o Microsoft Office 32 bits, no Windows 64 bits, será necessário utilizar o WebAgent 32 bits, o mesmo vai acontecer caso utilize DLLs/SOs 32 bits, mais informações clique aqui.

Nota
titleImportante

🚨Para verificar se seu pacote Microsoft Office é 32 ou 64 bits clique aqui ou acione o suporte da Microsoft.

🚨Para verificar se a DLL/SO que utiliza é 32 ou 64 bits acione o suporte do equipamento ou ferramenta que precisa integrar com nosso ERP.

...

Instalação (topo)

Para o Administrador do Sistema

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

1. Definindo o arquivo que conterá os instaladores para download

O Administrador do Sistema deve alterar o arquivo AppServer.ini de seu ambiente, utilizando a tag [WebApp] e o parâmetro agentJsonUpdate, mais detalhes em sobre a configuração do WebApp, clique aqui

Neste exemplo utilizaremos o arquivo webagent.json para a configuração, porém o nome deste arquivo é de sua escolha.

Bloco de código
languagec#
themeRDark
titleExemplo de Configuração do WebAgent (webagent.json)
[WebApp]
Port=5002
ENABLE=1
agentJsonUpdate=webagent.json

2. Criando o arquivo webagent.json

O Administrador do Sistema deve criar agora o arquivo webagent.json na mesma pasta do AppServer, este arquivo conterá o caminhos para download dos instaladores.

No exemplo abaixo os arquivos para download serão disponibilizados em uma subpasta do AppServer, por exemplo: /home/admin/totvs/appserver/webagent/

🚨 Importante: No caso do Windows devem ser utilizadas barras duplas \\ para configuração do Json, pois a primeira barra é considerada um caracter de escape, e não permitirá o download do instalador.

Nota
titleImportante

🚨 Os arquivos de instalação do WebAgent serão disponibilizados no Portal de Clientes assim que os testes estiverem concluídos. 

As Tags do arquivo webagent.json representam o Sistema Operacional e a Arquitetura do WebAgent a ser baixado, 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)

...

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.

Informações
titleDica importante

Na primeira vez que o comando "launch" for executado, como exemplificado abaixo, o navegador será exibido em sua janela original, sem estar maximizado. Para obter a melhor experiência, recomendamos que você maximize a janela do navegador antes de entrar no sistema. Nas próximas vezes em que o comando for executado, o navegador irá respeitar o estado em que foi fechado pela última vez.coman

Importante: O comando launch deve obrigatóriamente ser o primeiro da linha de comando, exemplo: web-agent launch...

* Quando utilizado o comando launch, o webagent sempre iniciará em uma porta aleatória, pois, nesse momento, ainda não temos acesso ao arquivo appserver.ini do ambiente.

* Para execução de aplicações que não utilizam interface, como processamentos e execução de jobs, utilize a opção --headless, mais informações acesse aqui.

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.

Bloco de código
languagebash
themeRDark
titleExemplo de abertura do WebAgent em linha de comando em Windows
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"
Bloco de código
languagebash
themeRDark
titleExemplo de abertura do WebAgent em linha de comando em Linux
/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:

Parâmetro de linha para a URLDescriçãoObservações
&E=
Indica o nome do ambiente que será utilizado para definições gerais.

&P=Identifica o programa inicial que será executado.
&A=Identifica um parâmetro que será passado para o programa inicial.

(seleção) Esse parâmetro de linha pode ser especificado mais de uma vez.

(informação) O valor recebido pelo programa, através do parâmetro de linha, é do tipo caractere.

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

Bloco de código
languagebash
themeRDark
titleExemplo de execução headless do WebAgent em Windows
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
Bloco de código
languagebash
themeRDark
titleExemplo de execução headless do WebAgent em Linux
/opt/web-agent/web-agent launch "http://10.173.9.215:5011?E=padrao&P=u_headless" --browser="/usr/bin/microsoft-edge" --headless
Bloco de código
languagebash
themeRDark
titleExemplo de execução headless do WebAgent em MacOS
/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
Informações
titleDica importante

O navegador Safari do MacOS não suporta modo headless.

No Linux, o Mozilla Firefox em modo headless pode recusar os certificados de autoridade CA nele já registrados, impossibilitando o uso do WebAgent nesse modo. No entanto é possível utilizar policies.json do navegador para contornar o problema:

  • Na pasta de instalação do Firefox (que depende do Linux utilizado, por exemplo /opt/firefox/ ou /usr/lib/firefox/) localize a pasta distribution e nela crie um arquivo com o nome de policies.json com o seguinte conteúdo apontando para o arquivo totvs_certificate_CA.crt da pasta de instalação do WebAgent:
Bloco de código
languagexml
themeRDark
titleConteúdo do arquivo distribution\policies.json
{
"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)

...

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.

Nota
titleImportante

🚨 Para verificar a arquitetura de seu pacote Microsoft Office clique aqui ou acione o suporte da Microsoft.

🚨 Para verificar a arquitetura da/s DLL/s de alguma ferramenta que utilize, acione o suporte do equipamento ou ferramenta em questão.


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

Nota
iconfalse

📢 Em builds do WebApp iguais ou superiores à 9.0.3 é possível, e recomendável, configurar o download do WebAgent à partir do arquivo AppServer.INI, caso ele não seja configurado, será utilizada a configuração à partir do arquivo WebAgent.json.

1. Configurando à partir do AppServer.INI

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

Nota
titleImportante

🚨 A propriedade version: Define a versão dos instaladores do WebAgent disponíveis pra download, dois pontos importantes:

  • Sempre que atualizar os instaladores é necessário também atualizar a versão no arquivo AppServer.INI;
  • O versão pode ser alterada tanto para update quanto para downgrade, caso seja necessário.

🚨 A propriedade Port: Habilita automáticamente uma porta para o WebAgent de todos os seus usuários impedindo que ele altere esta configuração.

Bloco de código
languagec#
themeRDark
titleExemplo de Configuração do WebAgent via AppServer.INI
[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.

Bloco de código
languagec#
themeRDark
titleTrecho do 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.

Nota
titleImportante

🚨 A propriedade version: define a versão dos instaladores do WebAgent disponíveis pra download, dois pontos importantes:

  • Sempre que atualizar os instaladores é necessário também atualizar a versão no arquivo json;
  • O versão pode ser alterada tanto para update quanto para downgrade, caso seja necessário.

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)

Bloco de código
languagec#
themeRDark
titleExemplo de Configuração do WebAgent (webagent.json) - AppServer Windows
{
    "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"
}


Bloco de código
languagec#
themeRDark
titleExemplo de Configuração do WebAgent (webagent.json) - AppServer Linux
{
    "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,

Bloco de código
languagec#
themeRDark
titleTrecho do arquivo AppServer.ini
[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:


Nota
titleImportante

🚨O Popup para instalação do WebAgent deixará de ser exibido assim que a primeira conexão entre ele 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" deve 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.

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

Bloco de código
languagebash
themeRDark
titleNo diretório onde o arquivo .deb foi copiado
sudo apt install ./web-agent<versao>.deb
Bloco de código
languagebash
themeRDark
titleCaso 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

Para Red hat 8.x Image Added

Bloco de código
languagebash
themeRDark
titlePré requisito: Necessário instalar a biblioteca libappindicator
sudo dnf install libappindicator-gtk3
Bloco de código
languagebash
themeRDark
titleNo diretório onde o arquivo .rpm foi copiado
sudo dnf install ./web-agent<versao>.rpm
Bloco de código
languagebash
themeRDark
titleCaso 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>.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:

Resultado de imagem para logo apple 2020 pngImage 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
Bloco de código
languagec#
themeRDark
titleExemplo de Configuração do WebAgent (webagent.json)
{
    "version": "0.0.4",
   
    "windows_x86": "webagent\\web-agent-1.0.0-RC1-windows-x86-release.setup.exe",
    "windows_x64": "webagent\\web-agent-1.0.0-RC1-windows-x64-release.setup.exe"

    "darwin_x64": "webagent/web-agent-1.0.0-SNAPSHOT-darwin-x64-release.dmg",
    "darwin_arm64": "webagent/web-agent-1.0.0-SNAPSHOT-darwin-x64-release.dmg",
    "darwin_universal": "webagent/web-agent-1.0.0-SNAPSHOT-darwin-x64-release.dmg",

    "linux_x64_deb": "webagent/web-agent-1.0.0-SNAPSHOT-linux-x64-release.deb",  
    "linux_x64_rpm": "webagent/web-agent-1.0.0-SNAPSHOT-linux-x64-release.rpm",
}

🚨 Após a configuração do arquivo webagent.json, deve-se reiniciar o/s AppServer/s de seu ambiente para que as configurações sejam iniciadas.

Para o usuário do ERP

Após a configuração acima, ao acessar a Tela de Parâmetros do WebApp, será exibida a tela para download, conforme exemplo abaixo:

Image Removed

O instalador vai sugerir o Sistema Operacional, porém, caso use o Windows 64 bits, mas possua o Microsoft Office 32 bits, poderá instalar a versão 32 para garantir sua integração, veja mais informações aqui.

Image Removed

Após o download basta clicar no arquivo de instalação, que irá prosseguir sem qualquer outra intervenção do usuário.

Image Removed

Após a instalação o programa estará disponível no menu, como neste exemplo, utilizando o Windows 11.

Image Removed

Iniciando a aplicação será exibido o ícone na bandeja em destaque abaixo, informando a porta para conexão com o WebAgent, no exemplo, a 21021.

Image Removed

...

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

...

Para o Microsoft Edge

...

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

...

Acesse: Authorities (autoridades)

...

Na sequencia: Import (importar)

...

Para o Firefox

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

  • Acesse: View Certificates… (verificar certificados)

  • Acesse: Authorities (autoridades)

  • Na sequencia: Import (importar)

  • Selecione o totvs_certificate_CA.crt na pasta /opt/web-agent
  • Selecione todos os Trusts e OK
    Image Removed

Resultado de imagem para logo apple 2020 pngImage Removed Para usuários macOS

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

...

  • na pasta /Applications/web-agent.app/Contents/MacOS


    Informações
    titleImportante

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

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 Added

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



Âncora
Sistemas
Sistemas

Sistemas Operacionais homologados (topo)

...

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

  • Window 32 e 64 bits: 
    • Image AddedWindows 10 Pro/Enterprise ou superior
    • Image AddedWindows 11 Pro/Enterprise ou superior

  • Linux 64 bits:
    • Image AddedUbuntu 20.04 LTS ou superior
    • Image Added Red Hat Enterprise Linux Desktop 8.x


  • Resultado de imagem para logo apple 2020 pngImage Added 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:
        Image Added


Aviso
titleNão homologado para uso em Metaframes

O uso do WebAgent não é homologado em navegadores utilizados a partir de Metaframes, RDPs ou Web enablers, como:

  • Citrix;
  • Windows Remote Desktop;
  • Go Global.

Devido à simplificação na montagem do WebApp, nossa arquitetura não depende das ferramentas acima para utilização dos ERPs Protheus/Logix.

Habilitar Web-Agent na Tela de Parâmetros (topo)

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

Sistemas Operacionais homologados (topo)

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
    • Resultado de imagem para logo redhatImage RemovedRed Hat Enterprise Linux Desktop 8.0 ou superior
    Resultado de imagem para logo apple 2020 pngImage RemovedmacOS 11.0 Big Sur ou superior.
    Aviso

    O WebAgent não está homologado nos sistemas operacionais :

    • ChromeOS
    • iOS
    • iPadOs
    • Android
  • 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.
  • Âncora
    ConfiguracaoConfiguracao
    Âncora
    SistemasSistemas

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

    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