Árvore de páginas

Versões comparadas

Chave

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

...

...

Nota
iconfalse

📢  Existem dois modelos de configuração para download do WebAgent:

  1. Configurando a partir do AppServer.INI
    1. Está liberado a partir do WebApp 9.0.3 ou superior
    2. Segue o padrão já conhecido pelos Administradores do Protheus
    3. A configuração precisa ser replicada para cada AppSever.INI do balanceamento de ambientes

  2. Configurando a partir do arquivo JSON
    1. Esta liberado à partir do WebApp 9.0.0
    2. O arquivo JSON pode ser configurado uma única vez e compartilhado entre vários AppServers
Aviso
iconfalse
titleImportante

🚨 Após ajustar as configurações abaixo, é necessário reiniciar o/s AppServer/s.

...

Nota

...

icon

...

false

A partir da versão 1.

...

0.15 do WebAgent, seu instalador será distribuido também no formato MSI para Windows, que permite a instalação remota a partir do serviço de GPO, mais informações acesse aqui.

Aviso
iconfalse
titleImportante

🚨 Para atualização automática aceitar o instalador no formato MSI, a versão mínima do WebAgent deve obrigatoriamente ser a 1.0.15.

Âncora
InstAdmin1
InstAdmin1

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

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

Parâmetro

...

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

ParâmetroDescriçãoObservações
VERSION
Define a versão dos instaladores do WebAgent disponíveis pra download
  • 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.
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.
  • 🚨 Importante: Essa configuração impede que os usuários utilizem o ERP sem o WebAgent instalado/registrado em suas estações.

...

ParâmetroDescrição
Windows_x86
Windows 10/11 32 bits
Windows_x64
Windows 10/11 64 bits
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 (Fedora, Oracle Linux e Red Hat)
Bloco de código
languagec#
themeRDark
titleExemplo de Configuração do WebAgent via AppServer.INI - Linux - Usando path relativo (diretório atual do 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.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

...

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 Modified

Âncora

...

InstAdmin4

...

InstAdmin4

4. Atualização automática de arquivos extras, exemplo, SIGALOJA.DLL (topo)

Acessando a Tela de Parâmetros do WebApp, agora será exibida a tela para download dos instaladores:

Nota
titleImportante

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

🚨 A atualização do WebAgent será automática após sua intalação, e acontecerá sempre que o Administrador do ERP atualizar a versão.

Image Removed

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 Removed

...

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

O programa ficará disponível no menu, como neste exemplo utilizando o Windows 11.

Image Removed

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 Removed

...

Image Removed 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 Removed Ubuntu

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
Aviso
iconfalse
title🚨 Importante

Caso esteja instalando pela primeira vez o WebAgent, será necessário proceder com o registro do Certificado SSL, mais detalhes acesse aqui.

...

A partir do WebAgent 1.0.15,é possivel definir a atualização automática de arquivos extras, como por exemplo, os arquivos do FrontLoja.

Esta implementação foi feita exclusivamente para Windows.

As chaves a seguir definem o caminho para um arquivo ZIP, que deverá conter a estrutura de diretórios e arquivos que o cliente deseja descompactar na pasta do WebAgent.

📢 Estas chaves estão disponiveis tanto no arquivo AppServer.INI quanto no arquivo JSON de configuração.

ParâmetroDescrição
Windows_x86_extras
Caminho para o arquivo ZIP que deverá conter a estrutura de diretórios e arquivos, na arquitetura 32 bits, que será descompactada na pasta do WebAgent.
Windows_x64_estras
Caminho para o arquivo ZIP que deverá conter a estrutura de diretórios e arquivos, na arquitetura 64 bits, que será descompactada na pasta do WebAgent.
Bloco de código
languagec#
themeRDark
titleTrecho do arquivo AppServer.ini
[WEBAGENT]
Windows_x86_extras=C:\totvs\files\DLL_SIGALOJA_Win32.zip
Windows_x64_extras=C:\totvs\files\DLL_SIGALOJA_Win64.zip

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

Nota
titleImportante

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

🚨 A atualização do WebAgent será automática após sua intalação, e acontecerá sempre que o Administrador do ERP atualizar a versão.

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 Fedora, Oracle Linux e Red Hat.

Image Added Ubuntu

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

🚨 Na sequencia, será necessário habilitar o system tray para o WebAgent, mais informações acesse aqui.

deb
Aviso
iconfalse
title🚨 Importante

Caso esteja instalando pela primeira vez o WebAgent, será necessário proceder com o registro do Certificado SSL, mais detalhes acesse aqui.

...

Resultado de imagem para logo apple 2020 pngImage Removed Instalando no macOS (topo)

Aviso
iconfalse
title🚨 Importante

O WebAgent, como qualquer aplicação que não seja disponibilizada via Apple Store, precisa ser autorizado manualmente para execução.

Este é o link para documentação oficial para o macOS Sequoia 15: https://support.apple.com/pt-br/guide/mac-help/mh40616/mac

Para consultar outra versão do sistema operacional, selecione a versão correta:

Image Removed

Este exemplo de instalação/autorização se baseia no macOS Sequoia. (💡 Dica: Clique nas imagens para melhor visualização )

Após baixar o arquivo de instalação para macOS (Universal), com a extenção .dmg, execute o instalador e na sequencia arraste o web-agent para pasta Aplicações (Applications)

Image Removed

Caso esteja atualizando o web-agent, pressione o botão Atualizar (Replace)

Image Removed

Abra o web-agent na pasta Aplicações e pressione o botão Done

Image Removed

Acesse as configurações do seu Mac e na sequencia Privacidade e Segurança (Privacy & Security)

Role até localizar a seção Segurança (Security) e na sequencia clique em Abrir Mesmo Assim (Open Anyway)

Image Removed

Confirme, cliquando em Abrir Mesmo Assim (Open Anyway)

Image Removed

Clique em Use sua Senha (Use Password)

Image Removed

Digite o usuário e senha de um usuário com autorização de Administrador do equipamento

Clique no botão OK para autorizar a execução do WebAgent

Image Removed

Aviso
iconfalse
title🚨 Importante

Caso esteja instalando pela primeira vez o WebAgent, será necessário proceder com o registro do Certificado SSL, mais detalhes acesse aqui.

...

Image AddedFedora, Image AddedOracle Linux e Image Added Red Hat (utilizando o desktop GNOME) 

Bloco de código
languagebash
themeRDark
titlePré requisito EXCLUSIVO para o Oracle Linux 9.x, antes da instalação da libappindicator
sudo dnf install oracle-epel-release-el9
sudo dnf update
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
Informações
iconfalse

🚨 Na sequencia, será necessário habilitar o system tray para o WebAgent, mais informações acesse aqui.

Aviso
iconfalse
title🚨 Importante

Caso esteja instalando pela primeira vez o WebAgent, será necessário proceder com o registro do Certificado SSL, mais detalhes acesse aqui.

Âncora
InstMacOS
InstMacOS

Resultado de imagem para logo apple 2020 pngImage Added Instalando no macOS (topo)

Aviso
iconfalse
title🚨 Importante

O WebAgent, como qualquer aplicação que não seja disponibilizada via Apple Store, precisa ser autorizado manualmente para execução.

Este é o link para documentação oficial para o macOS Sequoia 15: https://support.apple.com/pt-br/guide/mac-help/mh40616/mac

Para consultar outra versão do sistema operacional, selecione a versão correta:

Image Added

Este exemplo de instalação/autorização se baseia no macOS Sequoia. (💡 Dica: Clique nas imagens para melhor visualização )

Após baixar o arquivo de instalação para macOS (Universal), com a extenção .dmg, execute o instalador e na sequencia arraste o web-agent para pasta Aplicações (Applications)

Image Added

Caso esteja atualizando o web-agent, pressione o botão Atualizar (Replace)

Image Added

Abra o web-agent na pasta Aplicações e pressione o botão Done

Image Added

Acesse as configurações do seu Mac e na sequencia Privacidade e Segurança (Privacy & Security)

Role até localizar a seção Segurança (Security) e na sequencia clique em Abrir Mesmo Assim (Open Anyway)

Image Added

Confirme, cliquando em Abrir Mesmo Assim (Open Anyway)

Image Added

Clique em Use sua Senha (Use Password)

Image Added

Digite o usuário e senha de um usuário com autorização de Administrador do equipamento

Clique no botão OK para autorizar a execução do WebAgent

Image Added

Aviso
iconfalse
title🚨 Importante

Caso esteja instalando pela primeira vez o WebAgent, será necessário proceder com o registro do Certificado SSL, mais detalhes acesse aqui.

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

Aviso

Para utilizar o Websocket Secure (wss) é necessário registrar o TOTVS Certificate em seu sistema operacional.

Aviso
iconfalse
title🚨 Importante

Utilize os certificados disponibilizados na pasta de instalação do WebAgent, não utilize os certificados da pasta de instalação do AppServer.

...

Image Removed Para usuários Windows (automático) (topo)

O registro é automático para Windows 10/11, 32 ou 64 bits, e será efetivado na primeira execução do WebAgent.

Informações
iconfalse
title🚨 Importante

Utilize os certificados disponibilizados na pasta de instalação do WebAgent, não utilize os certificados da pasta de instalação do AppServer.

Âncora
CertWin
CertWin

Image Added Para usuários Windows (automático) (topo)

O registro é automático para Windows 10/11, 32 ou 64 bits, e será efetivado na primeira execução do WebAgent.

Informações
iconfalse
title🚨 Importante

Durante a primeira execução do WebAgent, Durante a primeira execução do WebAgent, caso seja apresentada a tela de confirmação para o registro do certificado, selecione a opção "SIM", "OK" ou "CONFIRMAR", essa opção que pode variar dependendo da versão do Windows em uso.

Informações
titleDicas para configuração do Firefox

Na configuração do Firefox pode estar desabilitada a utilização de certificados do sistema, causando falha na conexão com o WebAgent, é necessário habilitar os certificados da seguinte maneira:

  • Na barra de navegação digite: about:config


  • Clicar em "Aceitar o risco e continuar"
    Image Modified

  • Na barra de pesquisa digite: security.enterprise_roots.enabled e mude a opção para true (verdadeiro) clicando no botão a direita.
    Image Modified

Âncora
CertLinux
CertLinux

Para usuários Linux(topo)

    Image Removed Ubuntu    

Informações
iconfalse
title🚨 Importante

A partir da versão 1.0.15 do WebAgent, seu instalador fará automaticamente o registro do certificado, não sendo mais necessários os passos abaixo.

    Image Added Ubuntu    

  • Após a 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
    iconfalse
    titlePara 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
    iconfalse
    titlePara 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
    iconfalse
    titlePara 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 AddedFedora, Image AddedOracle Linux e Image Modified Red Hat

...

  • Para Google Chrome e Firefox o registro do certificado segue os mesmos passos do Ubuntu.

    Informações
    iconfalse
    titlePara 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:

...

Após instalar o WebAgent, localize o arquivo totvs_certificate_CA.crt na pasta /Applications/web-agent.app/Contents/MacOS

No App Acesso às Chaves (Keychain Access) , selecione Sistema (System), e nasequência Certificados (Certificates).Image Removed

Aviso
iconfalse
titleImportante

🚨 No macOS Sequoia, o atalho pro Keychain mudou, sendo acessado pelo caminho: /System/Library/CoreServices/Applications/Keychain Access.app
Image Added


Image Added

Arraste o arquivo do certificado para o App Acesso às Chaves (Keychain Access).
Image Added

Configure a confiança do certificadoArraste o arquivo do certificado para o App Acesso às Chaves (Keychain Access).
Image Removed
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).


...

Informações
iconfalse

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

📢 Este processo não é necessário no Ubuntu, ou em distros Linux com suporte ao KDE, como o Fedora Linux KDE..

💡 Dica: Clique nas imagens para melhor visualização

...

Escolha a porta de inicialização do WebAgent (por padrão é a 21021).

Image Modified

Na sequencia feche essa janela clicando no X na parte superior da janela de configuração.

Image Modified

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 Modified

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 Modified

Âncora
command_line
command_line

Executando o WebAgent em linha de comando (topo)

...

Aviso

O WebAgent não é homologado para sistemas operacionais :

  • ChromeOS/ChromeOS Flex
  • iOS
  • iPadOs
  • Android

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

Informações
iconfalse

Image Removed Window 32 e 64 bits

  • Windows 10 Pro/Enterprise ou superior
  • Windows 11 Pro/Enterprise ou superior
Nota
titleImportante

A homologação de uma distro base Linux permite o uso se suas flavors e spins Oficiais, pois essas variantes mantém as mesmas bibliotecas que sua base, exemplo:

  • Ao homologar o Ubuntu 24.04, que utiliza o GNOME como interface/desktop, permite o uso de suas flavors, como Xubuntu, Kubuntu, etc, mais informações no link abaixo:
  • Ao homologar o Fedora 41,que também utiliza o GNOME como interface/Desktop, permite o uso de suas seus spins, como Fedora XFCE ou Fedora KDE Plasma, mais informações no link abaixo:

🚨Isso não significa que os spins são Homologados, eles serão mantidos como "Suportados", havendo diferenças de comportamentos nos flavors e spins, cada caso será avaliado, podendo impedir o suporte a essa determinada distro.

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

Informações
iconfalse

Image Added Window 32 e 64 bits

  • Windows 10 Pro/Enterprise ou superior
  • Windows 11 Pro/Enterprise ou superior
Informações
iconfalse

Image Removed Linux 64 bits

  • Image Removed Ubuntu 22.04 LTS ou superior
  • Image Removed Red Hat Enterprise Linux Desktop 8.x

Resultado de imagem para logo apple 2020 pngImage Removed macOS x86_64 e Universal(ARM64) 

  • macOS 12.0 Monterey ou superior
🚨 A tentativa de utilizar a versão Universal em macOS anterior resultará no erro abaixo:
Image Removed
Informações
iconfalse

...

Aviso

Esta seção manterá informações sobre os Sistemas Operacionais em processo de homologação para o WebAgent.

As datas de inicio e finalização da homologação poderão sofrer alterações dependendo do processo.

Image RemovedProcesso de homologação do Fedora 41

Previsão de inicio em 04/11/2024 previsão de finalização em 02/12/2024.

Após instalar o WebAgent (mais informações acesse aqui), siga os passos abaixo.

Bloco de código
languagebash
themeRDark
// Instale as dependencias do WebAgent para o Fedora 41
sudo dnf install libappindicator-gtk3

// Registre o certificado do WebAgent
sudo cp /opt/web-agent/totvs_certificate_CA.crt /etc/pki/ca-trust/source/anchors/
sudo update-ca-trust
Informações
iconfalse

🚨 Na sequencia, será necessário habilitar o system tray para o WebAgent, mais informações acesse aqui.

Image RemovedProcesso de homologação do Oracle Linux 9.x

Previsão de inicio em 04/11/2024 previsão de finalização em 02/12/2024.

Após instalar o WebAgent (mais informações acesse aqui), siga os passos abaixo.

Bloco de código
languagebash
themeRDark
// Instale as dependencias do WebAgent para Oracle Linux 9.x
sudo dnf install oracle-epel-release-el9
sudo dnf update
sudo dnf install libappindicator-gtk3

// Registre o certificado do WebAgent
sudo cp /opt/web-agent/totvs_certificate_CA.crt /etc/pki/ca-trust/source/anchors/
sudo update-ca-trust

Image Added Linux 64 bits

  • Image Added Ubuntu 22.04 LTS (recomendamos o uso do Ubuntu 24.04 LTS)
  • Image Added Ubuntu 24.04 LTS ou superior (a partir do WebAgent 1.0.15)
  • Image AddedFedora 41 (a partir do WebAgent 1.0.15)

  • Image AddedOracle Linux 9.x (a partir do WebAgent 1.0.15)

  • Image Added Red Hat Enterprise Linux Desktop 8.x

    • 🚨 Recomendamos o uso do Fedora ou do Oracle Linux, ambas distros gratuitas, e com a mesma base do Red Hat.

Informações
iconfalse

Resultado de imagem para logo apple 2020 pngImage Added macOS x86_64 e Universal(ARM64) 

  • macOS 12.0 Monterey ou superior

🚨 A tentativa de utilizar a versão Universal em macOS anterior resultará no erro abaixo:

Image Added

Âncora
EmHomolog
EmHomolog

Sistemas Operacionais em homologação (topo)

...

Aviso

Esta seção manterá informações sobre os Sistemas Operacionais em processo de homologação para o WebAgent.

As datas de inicio e finalização da homologação poderão sofrer alterações dependendo do processo

Informações
iconfalse

🚨 Na sequencia, será necessário habilitar o system tray para o WebAgent, mais informações acesse aqui.