Histórico da Página
...
O que é o WebAgent
Pensado pra ser seguro
Vantagens no uso do WebAgent em conjunto com o WebApp
Instalação
Registrando o certificado SSL para uso do WebAgent
Habilitando o WebAgent na Tela de Parâmetros
Executando o WebAgent em linha de comando
Entendendo as arquiteturas 32 e 64 bits para uso do WebAgent
Sistemas Operacionais homologados
Exemplos de integração utilizando o WebAgent
...
Para o administrador do sistema (topo)
Baixe os instaladores do WebAgent a partir da Central de Downloads.
Vamos configurar os caminhos para os instaladores a partir do arquivo AppServer.INI, após essa configuração, eles ficarão disponíveis para download na tela de parâmetros do ERP. Para disponibilizar a opção de download do WebAgent para seus usuários na Tela de Parâmetros do WebApp é necessário configurar a origem dos instaladores.
Nota | ||
---|---|---|
| ||
📢 Em builds A partir do WebApp iguais ou superiores à 9.0.3 3 ou superior, é recomendável configurar o download do WebAgent à partir do arquivo AppServer.INI. 🚨 Após alterar ajustar as configurações abaixo, é necessário reiniciar o/s AppServer/s. |
...
Parâmetro | Descrição | Observações |
---|---|---|
VERSION | Define a versão dos instaladores do WebAgent disponíveis pra download |
|
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. |
Os parâmetros abaixo representam o Sistema Operacional e a Arquitetura(32/64 bits) do WebAgent:
Parâmetro | Descrição |
---|---|
Windows_x86 | Windows 10/11 32 bits |
Windows_x64 | Windows 10/11 64 bits |
Darwin_universal | |
Linux_x64_deb | Linux 64 bits pacote DEB (Ubuntu) |
Linux_x64_rpm | Linux 64 bits pacote RPM (Red Hat) |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
[WEBAGENT]
| ||||||
Bloco de código | ||||||
| ||||||
[WEBAGENT] VERSION=1.x.x "<ajuste esta opção com a versão correta do WebAgent que será disponibilizado>" Windows_x86=C:\totvs\files\webagent/web-agent-1.x.x-windows-x86.setup.exe Windows_x64=C:\totvs\files\webagent/web-agent-1.x.x-windows-x64.setup.exe Darwin_universal=C:\totvs\files\webagent/web-agent-1.x.x-darwin-universal.dmg Linux_x64_deb=C:\totvs\files\webagent/web-agent-1.x.x-linux-x64.deb Linux_x64_rpm=C:\totvs\files\webagent/web-agent-1.x.x-linux-x64.rpm |
...
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
...
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
[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-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 |
Âncora InstAdmin2 InstAdmin2
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.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
[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/
Parâmetro | Descrição | Observações |
---|---|---|
VERSION | Define a versão dos instaladores do WebAgent disponíveis pra download |
|
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
[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/
...
...
- Sempre que atualizar os instaladores na pasta de download é necessário atualizar também sua versão no arquivo AppServer.INI;
- O versão pode ser alterada tanto para update quanto para downgrade do WebAgent.
- 🚨 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(32/64 bits) do WebAgent:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "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" } |
...
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "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" } |
...
Para utilizar o Websocket Secure (wss) é necessário registrar o TOTVS Certificate em seu sistema operacional.
Informaçõeswarning | ||||
---|---|---|---|---|
| ||||
Utilize os certificados disponibilizados na pasta de instalação do WebAgent, não utilize os certificados da pasta de instalação do AppServer. |
...
Ubuntu
- Após a instalação do 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
...
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:
Para usuários macOS
Para mais detalhes acesse a documentação oficial da Apple aqui:
Para usuários macOS
Para mais detalhes acesse a documentação oficial da Apple aqui.
Informações | ||||
---|---|---|---|---|
| ||||
Este processo deve ser executado para dois arquivos, o totvs_certificate_CA.crt e o arquivo totvs_certificate.crt. |
- Após instalar Após a instalação do WebAgent
- Localize o arquivo totvs_certificate_CA.crt na pasta /Applications/web-agent.app/Contents/MacOS
- No app App Acesso às Chaves (keychain accessKeychain Access) , selecione as chaves de início de sessão ou de Sistema.
Sistema (System), e nasequência Certificados (Certificates). - Arraste o arquivo do certificado para o app App Acesso às Chaves(Keychain Access).
- Configure a confiança do certificado, clicando com o botão direito do mouse sobre o mesmo arquivo, e escolhendo a opção Obter Informações (Get Info).
- Expanda a opção Confiança (Trust), e coloque Confiar Sempre (Always Trust)para todas as opções disponíveis, conforme as imagens abaixo.
- Ao confirmar as informações, se Se for solicitado que você forneça um usuário e senha, utilize um usuário com acesso de administrador.
↪ ↪
...
- usuário com acesso de administrador.
ÂncoraConfiguracao Configuracao
Habilitando o WebAgent na Tela de Parâmetros (topo)
Configuracao | |
Configuracao |
...
Na sequencia feche essa janela clicando no X na parte superior da janela de configuração.
Assim que 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.
Após dez tentativas de conexão mal sucedidas, ou caso Caso a conexão com o WebAgent falhe ou a solicitação de autorização seja ignorada, será exibida a seguinte mensagem de erro a seguir:
Âncoracommand_line command_line
Executando o WebAgent em linha de comando (topo)
command_line | |
command_line |
...
Parâmetro | Descrição |
---|---|
web-agent -h ou --help | Exibe help com essas opções |
web-agent -c ou --console | 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-port 21023 |
web-agent -v ou --version | Exibe a versão do WebAgent, exemplo: web-agent -v |
web-agent -v t ou --versiontray | Abre o WebAgent via systray (default)Exibe a versão do WebAgent |
web-agent -t ou --trayport | Define uma porta específica para Abre o WebAgent via systray (default(a porta padrão é a 21021) |
web-agent --locallog <n> | 0 (default): Desabilita o log de execução; |
...
Permite abrir uma janela destacada do navegador a partir do WebAgent.
Informações | ||
---|---|---|
| ||
Durante a primeira execução com comando launch, a janela pode não ser exibida de forma maximizada, impedindo uma melhor experiência, maximize a janela, e nas próximas execuções o navegador irá respeitar o estado em que foi encerrado. 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 iniciará em uma porta aleatória, permitindo multiplas execuções, cada uma em sua porta específica. *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. |
...
Parâmetro de linha para a URL | Descrição | Observaçõ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. |
|
Âncora | ||||
---|---|---|---|---|
|
Comando --headless: Executando aplicações sem interface através do WebAgent (topo)
...
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
/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çõeswarning | ||||
---|---|---|---|---|
| ||||
O navegador Safari, no MacOS, não suporta o modo headless. |
...
Aviso |
---|
O WebAgent não é homologado para sistemas operacionais :
|
O WebAgent está disponível e homologado para os seguintes Sistemas Operacionais:
Informações | ||
---|---|---|
| ||
Window 32 e 64 bits |
Informações | ||
---|---|---|
| ||
Linux 64 bits
|
Informações | ||
---|---|---|
| ||
macOS x86_64 e Universal(ARM64e x86_64)
🚨 A tentativa de utilizar a versão Universal em macOS anterior resultará no erro abaixo: |
...