TOTVSTEC

Árvore de páginas

Versões comparadas

Versão antiga 363

changes.mady.by.user Ricardo Mansano Godoi

Gravado em

comparado com

Nova versão 364

changes.mady.by.user Ricardo Mansano Godoi

Gravado em

Chave

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

...

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

...

Informações
iconfalse

Este processo é necessário em distros Linux como Red Hat, Fedora e Oracle Linux, que utilizam o GNOME como desktop padrão, mas não possuem suporte nativo ao system tray.

*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
languagebash
themeRDark
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:

ParâmetroDescriçã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
web-agent -v ou --version

Exibe a versão do WebAgent, exemplo:

web-agent -v
v1.0.9-RC3 - x64
web-agent -t ou --tray

Abre o WebAgent via systray (default)

web-agent --port

Define uma porta específica para o WebAgent (a porta padrão é a 21021)

web-agent --locallog <n>

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

Â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

Aviso
iconfalse
title🚨 Importante

O Firefox não respeita a instrução para ser instanciado sem as Abas e endereço de URL, seja em Windows ou Linux, mas sua operação ocorre normalmente utilizando o launch.

Informações
titleDicas importantes

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.

Bloco de código
languagebash
themeRDark
titleSintaxe
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.

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"

...

Permite abrir uma janela destacada do navegador a partir do WebAgent.

Image Removed

Aviso
iconfalse
title🚨 Importante

O Firefox não respeita a instrução para ser instanciado sem as Abas e endereço de URL, seja em Windows ou Linux, mas sua operação ocorre normalmente utilizando o launch.

Informações
titleDicas importantes

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.

Bloco de código
languagebash
themeRDark
titleSintaxe
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.

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:

...

Indica o nome do ambiente que será utilizado para definições gerais.

...

(seleção) O parâmetro de linha &A pode ser utilizado multiplas vezes.

(informação) O valor recebido pelo programa através do parâmetro é do tipo caractere, mesmo que seja preenchido um valor numérico.

...

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. 

Bloco de código
languagebash
themeRDark
titleSintaxe
webagent launch "ip+porta+[parâmetros<opcional>]" --browser="caminho para o navegador" --headless

Exemplos:

...

 Bloco de código
languagebash
themeRDark
titleExemplo de execução headless abertura do WebAgent em linha de comando em WindowsLinux
/opt/C:\Users\Administrator\AppData\Local\Programs\web-agent\/web-agent.exe  launch "http://10.173.9.215:5011?E=padrao&P=u_headless=SIGAFAT&A=param1&A=param2&A=param3" --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
 Aviso
iconfalse
title🚨 Importante
O navegador Safari, no MacOS, não suporta o modo headless.
 Informações
titleDica importante
O Mozilla Firefox, em Linux e modo headless, pode recusar os certificados de autoridade CA já registrados, impossibilitando o uso.
É possível utilizar policies.json do navegador para contornar esse 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
  • Crie nessa pasta um arquivo com o nome de policies.json com o conteúdo abaixo, 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"
               ]
         }
    }
}
...
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:
 Informações
iconfalse
titleCenário 1
Utilizar o Windows 64 bits, porém ferramentas 32 bits, nesse caso será necessária a instalação do WebAgent 32 bits para integração com:
  • Pacote Microsoft Office 32bits;
  • DLLs 32 bits, para por exemplo, integração de equipamentos, como impressoras, balanças, caixas registradoras, etc.
 Informações
iconfalse
titleCenário 2
Utilizar o Windows 64 bits, o Office 32 bits e uma integração com DLLs 64 bits (o inverso pode ocorrer).
Neste caso é possível instalar as duas versões do WebAgent, 32 e 64 bits, e executá-las em portas diferentes, 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 Removed
🚨 Para que este segundo cenário funcione será necessário abrir duas sessões distintas do WebApp no navegador.
      Mesmo procedimento adotado caso fosse necessário 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 das DLLs de alguma ferramenta que utilize, acione o suporte do equipamento ou ferramenta em questão.
...
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
...
/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) O parâmetro de linha &A pode ser utilizado multiplas vezes.
(informação) O valor recebido pelo programa através do parâmetro é do tipo caractere, mesmo que seja preenchido um valor numérico.
 Â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. 
 Bloco de código
languagebash
themeRDark
titleSintaxe
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.
 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
 Aviso
iconfalse
title🚨 Importante
O navegador Safari, no MacOS, não suporta o modo headless.
 Informações
titleDica importante
O Mozilla Firefox, em Linux e modo headless, pode recusar os certificados de autoridade CA já registrados, impossibilitando o uso.
É possível utilizar policies.json do navegador para contornar esse 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
  • Crie nessa pasta um arquivo com o nome de policies.json com o conteúdo abaixo, 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
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:
 Informações
iconfalse
titleCenário 1
Utilizar o Windows 64 bits, porém ferramentas 32 bits, nesse caso será necessária a instalação do WebAgent 32 bits para integração com:
  • Pacote Microsoft Office 32bits;
  • DLLs 32 bits, para por exemplo, integração de equipamentos, como impressoras, balanças, caixas registradoras, etc.
 Informações
iconfalse
titleCenário 2
Utilizar o Windows 64 bits, o Office 32 bits e uma integração com DLLs 64 bits (o inverso pode ocorrer).
Neste caso é possível instalar as duas versões do WebAgent, 32 e 64 bits, e executá-las em portas diferentes, 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 fosse necessário 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 das DLLs de alguma ferramenta que utilize, acione o suporte do equipamento ou ferramenta em questão.
 Âncora
Exemplos
Exemplos

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 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
Image Removed
...
Habilitando o icone da bandeja (topo)
 Informações
iconfalse
Este processo é necessário em distros Linux como Red Hat, Fedora e Oracle Linux, que utilizam o GNOME como desktop padrão, mas não possuem suporte nativo ao system tray.
*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 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 Permitir esta extensão em janelas privativas, 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:
 Bloco de código
languagebash
themeRDark
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 Linux estará pronto para testes.
Image Removed
 Âncora
Sistemas
Sistemas

Sistemas Operacionais homologados (topo)
...