Linha RM

Atalhos

Páginas filhas
  • TOTVS Gateway Manager (TGM)
3 mais filhas

Versões comparadas

Versão antiga 58

changes.mady.by.user Carlos Philippe de Farias Marques

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Eduardo Junqueira de Matos

Gravado em

Chave

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

ÍNDICE

  • Visão Geral
  • Pré-Requisitos
    • Exemplo de utilização

    Índice

    01. VISÃO GERAL

    O TOTVS Gateway Manager é um centralizador de requisições (ponto único de acesso), que realiza a análise, a filtragem e redirecionamento do tráfego de terceiros entre os hosts ativos.

    As funções presentes no API Gateway permitem as mais diversas vantagens para quem o utiliza. Um único ponto de acesso, por exemplo, significa uma redução de esforço em administrar as "portas de entradas" dos serviços utilizados, podendo focar seus esforços em um único local.

    As funções presentes no API Manager fornecem uma camada de gestão para o API Gateway. Além de definir o comportamento do API Gateway, o API Manager lida com a análise de cada requisição.


    02.

     PRÉ-REQUISITOS
    • ASP.NET CORE 2.2.0

    Acesse o site https://dotnet.microsoft.com/download/thank-you/dotnet-runtime-2.2.0-windows-x64-asp.net-core-runtime-installer.

    Espere o download e execute o arquivo de instalação.

    Image Removed

    Marque a opção "I agree to the license terms and conditions".

    Clique em Install.

    Image Removed

    Aguarde a instalação do Asp.Net Core 2.2.0.

    Image Removed

    Clique em close.

    Image Removed

    • .NET CORE 2.2.0

    Acesse o site https://dotnet.microsoft.com/download/thank-you/dotnet-runtime-2.2.0-windows-x64-installer.

    Espere o download e execute o arquivo de instalação.

    Image Removed

    Clique em Install.

    Image Removed

    Espere o término da instalação do .NET CORE 2.2.0

    Image Removed

    Clique em Close

    Image Removed

    Expandir
    titleNode JS (Somente Desenvolvedores)

    Acesse o site https://nodejs.org/en/.

    Escolha a opção 10.16.0 LTS.

    Espere o download e execute o arquivo de instalação.

    Image Removed

    Espere as contagens e diagnósticos iniciais do sistema.

    Image Removed

    Clique em "Next".

    Image RemovedMarque a opção "I accept the terms  in the License Agreement".

    Clique em "Next".

    Image Removed

    Escolha uma pasta de destino da instalação.

    Image Removed

    Ignore as configurações da pagina abaixo e clique em "Next", serão instalados as funcionalidades padrões do Node.js.

    Image Removed

    Clique em Install.

    Image Removed

    Espere a instalação do Node.js.

    Image Removed

    Clique em Finish

    Image Removed

    VANTAGENS E POSSIBILIDADES DO TGM

          Haverá um ponto central de comunicação com os Serviços para requisições de portais web, sem que seja necessário implementar uma regra de balanceamento e descoberta em cada portal.

          Não é necessário mais re-configurar todas as aplicações clientes ao incrementar ou modificar o parque de Servers.

          Será possível visualizar todos os Servers disponíveis no parque,  além de poder testar a saúde de comunicação dos mesmos, é até reconfigurar cada server para que ele atenda a determinados tipos de serviços.

          Principais características de destaque do TGM:

    • A solução é de fácil implantação, tanto para novas instalações quanto para instalações já existentes. 
    • O sistema é modularizável e servirá à qualquer linha de produto da TOTVS.
    • Será possível que o administrador do ERP tenha uma visão completa de todo o parque de servidores.


    Image Added

    03. REQUISITOS

    A partir da versão 12.1.2406 do RM, não há pré-requisitos para a instalação do TGM.

    Para versões anteriores, consultar: Dependências de execução do TGM na versão 12.1.2402 e anteriores - Linha RM - TDN (totvs.com.br)

    04. INSTALANDO O TGM

    04.01 (MÁQUINA LOCAL)


    Abaixo iremos apresentar como instalar o TGM.


    Totvs custom tabs box
    tabsInstalador do TGM,RM.Host.ServiceManager.exe
    ids4,5
    Totvs custom tabs box items
    defaultyes
    referencia4

    A instalação do TGM pode ser feita via TOTVS Gateway Manager (TGM), basta informar os campos abaixo:

    Image Added

    03. EXEMPLO DE UTILIZAÇÃO

    Exemplo do Comportamento Antigo (até a versão 12.1.24):

    Acessar o aplicativo "RM.Host.ServiceManager.exe" e adicionar a quantidade de serviços desejada.
    Image RemovedEm seguida era necessário a configuração do arquivo "RM.exe.Config", configurando todos os hosts e portas adicionadas no "RM.Host.ServiceManager.exe", para que houvesse o balanceamento nativo (distribuição das requisições entre os hosts). 
    Image Removed
    Exemplo do Comportamento Atual (a partir da versão 12.1.25):
    Na instalação da Biblioteca o usuário poderá informar se usará o TGM, conforme parâmetro abaixo: 
    Image Removed
    E contará com o instalador do TOTVS Gateway Manager (TGM) terá um instalador exclusivo onde o usuário irá informar os campos abaixo:
    Image Removed


    Informações
    titleAtenção

    As configurações dos serviços serão inseridas no arquivo "appServerList.json" onde o mesmo será lido ao subir o serviço do TGM, adicionando as informações dos Serviços de Proxy na configuração do TGM.

    Após a instalação,  ao acessar o RM.Host.Service.manager observe que as informações de Porta WCF, Porta WebService e Porta WebApi serão preenchidas.
      
    Image Removed|


    Ao instalar o TGM via instalador, ao final verificar se o serviço do TGM está online.

    Image Added

    Totvs custom tabs box items
    defaultno
    referencia5

    O serviço do TGM  pode ser feita via RM.Host.ServiceManager, basta marcar o campo "Instalar TGM" e clicar no botão Instalar após informar o diretório onde o TGM foi instalado.

                                       Image Added


    Aviso
    titleAtenção

    Caso o serviço do TGM não inicie, verifique na documentação TGM Troubleshooting.

    Para mais informações sobre como alterar as portas WebApi ou WebService, acesse o link.

    Já na sub pasta TOTVS Gateway Manager o campo "Instalar TGM" virá marcado.

    Image Removed
      

    Descrição dos Campos:

    • Instalar TGM: Opção para que o serviço do Totvs Gateway Manager seja instalado na maquina que está sendo utilizada. 
      • Caminho completo do arquivo: Caminho onde está instalado o executável do Totvs Gateway Manager.
    • Portas de eonfiguração do TGM
      • Porta de
    WCF
      • serviço: Porta
    para disponibilização do endpoint do serviço rest para configuração do TGM.
    Porta de WebService
      • onde o TGM irá realizar o serviço de configuração.
      • Porta de resiliência: Porta onde o TGM irá realizar a resiliência do provider (NGINX).
    • Portas de escuta do TGM
      • Porta de WCF: Porta onde o TGM irá receber requisições
    HTTP
      • TCP e redirecionar para os Hosts cadastrados para responder
    HTTP
      • TCP.
      • Porta de
    WebApi
      • WebService: Porta onde o TGM irá receber requisições
    TCP
      • HTTP e redirecionar para os Hosts cadastrados para responder
    TCP
      • HTTP.
      • Porta de
    PING:
      • WebApi: Porta para disponibilização do endpoint do serviço rest para configuração do TGM.
      • Connect (s): Valor em segundos para aguardar a conexão com o Proxy.
      • Time-out (s): Valor em segundos para aguardar a resposta da requisição
    Porta onde o TGM irá realizar a resiliência do NGINX
      • .
    • Utilizar TGM em outra maquina: Opção dada ao usuário para que o Totvs Gateway Manager seja instalado em outra maquina (informando Host:Porta).

    Passo a passo para configuração do TGM (Totvs Gateway Manager):

    1. Acessar o aplicativo "RM.Host.ServiceManager.exe" e adicionar a quantidade de serviços desejada.
    2. Acessar a aba "Totvs Gateway Manager" e ,marcar a opção "Instalar TGM". 
    3. Informe o caminho onde o TGM foi instalado anteriormente.
    4. Em seguida, clique para
    instalar  nas operações do
    1. instalar o serviço do TGM em Operações no serviço TGM.
    2. Após realizada a instalação, configure as portas WebService e WebApi e clique em "Aplicar".
    3. Verifique que o TGM foi instalado corretamente, como mostra a imagem disponível abaixo:

                             Image Added

    Image Added

    Veja mais sobre a Configuração Plug and Play ou como configurar o TGM com Config Global


    04.02 EM OUTRA MÁQUINA

    Iremos apresentar como instalar o TGM em outra máquina.

    Utilização do TGM em outra máquina:

    Totvs custom tabs box
    tabsInstalador da Biblioteca RM,RM.Host.ServiceManager.exe
    ids6,7
    Totvs custom tabs box items
    defaultyes
    referencia6

    Na instalação da Biblioteca o usuário poderá informar se usará o TGM, conforme parâmetro abaixo: 


    Image Added


    Totvs custom tabs box items
    defaultno
    referencia7
    1. Marcar a opção "Utilizar TGM em outra maquina" e preencher o campo com "Host:Porta" da maquina que será utilizada para a instalação do TGM.
    2. Alterar o arquivo "RM.exe.config", apontar as tags do host e porta para maquina que está sendo utilizada.
    3. Verifique que a comunicação é feita corretamente entre as maquinas (através dos hosts ativos).

    Image Added


    Aviso
    iconfalse

    É necessário que seja feita a alteração no arquivo "RM.exe.config" quando utilizado o TGM em outra máquina (Alterar os tags "Port" e "Host").

    Aviso
    iconfalse

    Caso a sua empresa possua firewall e/ou restrições de acesso à internet, é necessário que o administrador da rede libere o acesso às portas configuradas.



    05. LOG DE ERROS

          

          Erros podem ocorrer no RM.Host ou no RM.Host.ServiceManager

    Totvs custom tabs box
    tabsTGM,RM.Host/RM.Host.Service,RM.Host.ServiceManager
    ids8,9,10
    Totvs custom tabs box items
    defaultyes
    referencia8
    Painel
    borderColor#ddd
    borderStylesolid
    titleTGM

    O log do TGM está centralizado no EventViewer (Visualizador de Eventos) do Windows.

    Image Added

    Totvs custom tabs box items
    defaultno
    referencia9
    Painel
    borderColor#ddd
    borderStylesolid
    titleRM.Host / RM.Host.Service

    Caso hajam erros nos serviços relacionados ao TGM no RM.Host, os mesmos serão apresentados no TraceFile.

    obs.: é necessário habilitar a Tag Tracefile no config (https://tdn.totvs.com/display/LRM/Habilitar+Tag+Tracefile)

    Image Added



    Totvs custom tabs box items
    defaultno
    referencia10
    Painel
    borderColor#ddd
    borderStylesolid
    titleRM.Host.ServiceManager

    Caso hajam erros nos serviços relacionados ao TGM no RM.Host.ServiceManager, os mesmos serão apresentados na tela.


    Image Added


    Painel
    borderColor#ddd
    borderWidth1
    borderStylesolid
    titleInformações do Documento

    Versionamento

    Versão: v1.0

    Karina Dos Santos Costa

    Versão: v1.1

    Carlos Philippe de Farias Marques


    Links Externos

    [1] https://dotnet.microsoft.com/download/thank-you/dotnet-runtime-2.2.0-windows-x64-asp.

    net-core-runtime-installer

    [2] https://dotnet.microsoft.com/download/thank-you/dotnet-runtime-2.2.0-windows-x64-installer

    [3] https://nodejs.org/en/.

    Painel
    borderColor#ddd
    borderWidth1
    borderStylesolid
    titleInformações Gerais do TGM

    Informações do instalador

    Nome: TOTVS Gateway Manager - {versao}.exe

    Versão: 12.1.25+

    Tamanho: ~ 4mb


    Pré-requisitos

    • ASP.NET Core 2.2.0
    • .NET Core 2.2.0
    • NODE.js (Publicação - somente desenvolvedores)

    Image Removed

    Informações sobre o documento
    Painel
    title