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

• WebApp - WebAgent

• Segurança

• Sistemas Operacionais

• Configuração

• WebApp - WebAgent

...

O WebAgent permitirá utilizar o Smartclient HTML, através dos Navegadores homologados, disponibilizando os mesmos acessos à estação de trabalho hoje só possiveis através do SmartClient Desktop, dentre eles:

• 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 (deprecado)

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

  • Para o usuário do ERP

    • Instalando no Windows

    • Instalando no Linux

• Registrando o certificado SSL para uso do WebAgent

• 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

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

Image Added

Â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 a partir 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

...

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.

...

O WebAgent estará acessível à estação de trabalho através de um ícone na bandeja do usuário, facilitando seu acesso e uso:

Image Removed

Para habilitar o uso pelo SmartClient HTML, na tela de configuração do WebApp no navegador, é possível escolher a porta de inicialização e conexão com o WebAgent (por padrão a porta é a 21021).

Vantagens Vantagens

Vantagens no uso 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)

...

Âncora
InstAdmin InstAdmin

Para o administrador do sistema (topo)

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.

Âncora
InstAdmin1 InstAdmin1

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

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

Âncora
InstAdmin2 InstAdmin2

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

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

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

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.

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

Image Added

Âncora
InstWindows InstWindows

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, será exibido o ícone na bandeja, como no exemplo abaixo.

Image Added

Âncora
InstLinux InstLinux

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.

Para Ubuntu Image Added

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

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

Para Red hat 8.x Image Added

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.

🚨 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 Added Para 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:
  

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

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

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

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 mal sucedidas, ou caso a solicitação de autorização seja ignorada, será exibida a seguinte mensagem:

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 -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 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 para os Sistemas Operacionais:

...

• Image Added Window 32 e 64 bits: 
  

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

  • Image Added Red Hat Enterprise Linux Desktop 8.x

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

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