Este documento descreve os processos necessários para realizar a instalação do TOTVS Agro API Hub em ambientes Windows.


Banco de Dados

  • PostgreSQL 15
    • Permissão de Banco 
      • GRANT CONNECT ON DATABASE <NOME_DO_BANCO> TO <NOME_DO_USUARIO>;,
      • GRANT CREATE, USAGE ON SCHEMA <NOME_DO_SCHEMA> TO <NOME_DO_USUARIO>;,
      • GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA <NOME_DO_SCHEMA> TO <NOME_DO_USUARIO>;,
      • ALTER DEFAULT PRIVILEGES IN SCHEMA <NOME_DO_SCHEMA> GRANT ALL ON TABLES TO <NOME_DO_USUARIO>;,
      • GRANT ALL PRIVILEGES ON ALL SEQUENCES IN SCHEMA <NOME_DO_SCHEMA> TO <NOME_DO_USUARIO>;,
      • ALTER DEFAULT PRIVILEGES IN SCHEMA <NOME_DO_SCHEMA> GRANT ALL ON SEQUENCES TO <NOME_DO_USUARIO>;,
      • ALTER DEFAULT PRIVILEGES IN SCHEMA <NOME_DO_SCHEMA> GRANT ALL ON FUNCTIONS TO <NOME_DO_USUARIO>;


  • ⚠️ Base de Dados do Produto: Versão mínima requirida do banco de dados  Oracle 12c, ou superior 
    • Permissão de Banco 
      • GRANT CONNECT TO "NOME_OWNER";
      • GRANT RESOURCE TO "NOME_OWNER";
      • GRANT UNLIMITED TABLESPACE TO "NOME_OWNER";
      • GRANT CREATE SYNONYM TO "NOME_OWNER";
      • GRANT CREATE VIEW TO "NOME_OWNER";
      • GRANT CREATE PROCEDURE TO "NOME_OWNER";
      • GRANT CREATE TRIGGER TO "NOME_OWNER";
      • GRANT CREATE SEQUENCE TO "NOME_OWNER";
      • GRANT CREATE MATERIALIZED VIEW TO "NOME_OWNER
      • GRANT CREATE ANY TABLE TO ""NOME_OWNER";
      • GRANT ALTER ANY TABLE  TO "NOME_OWNER";
      • GRANT INSERT ANY TABLE TO "NOME_OWNER";
      • GRANT UPDATE ANY TABLE TO "NOME_OWNER";
      • GRANT DELETE ANY TABLE TO "NOME_OWNER";
      • GRANT SELECT ANY TABLE TO "NOME_OWNER";
      • GRANT CREATE ANY TRIGGER TO "NOME_OWNER";


Acesso à internet (com acesso liberado ao endereço http://engenharia.agro.totvs.com.br:8080/*)

Liberações de IPs do TOTVS iPaaS

Requisitos de Hardware

  • Recomendado (Equivalente ou superior): CPU Intel® Xeon® Gold 5415+ Processor (22.5M Cache, 2.90 GHz) / 4 vCPU
  • Recomendado (inicial): 12 GB de RAM disponível (somente para TOTVS Agro API Hub + PostgreSQL);

  • Recomendado: 30 GB espaço em disco disponível (somente para TOTVS Agro API Hub + PostgreSQL);


Observações de instalação (ambiente/infraestrutura)

  • Os requisitos de hardware (memória RAM e espaço em disco) podem ser superiores aos inicialmente recomendados, devido ao volume de dados monitorado/integrado entre as aplicações que estão sendo integradas por ele (para isto, será necessário monitorar e validar a necessidade de subida destes requisitos durante uma homologação);
  • Na instalação, os componentes/serviços do TOTVS API Hub devem estar o mais próximo das bases de dados de Oracle/Bioenergia, reduzindo assim questões de latência e/ou instabilidade com a base de dados monitorada/sincronizada;
  • Também recomendamos a separação entre ambiente/infraestrutura de TOTVS Agro API Hub e demais aplicações (por exemplo, TOTVS Agro Bioenergia, TOTVS Agro PIMSServer e/ou TOTVS Agro Portal Agrícola) - desta forma, seguir a recomendação mencionada no quadro "Infraestrutura e ambientes" (abaixo);
  • A latência (ping) entre ambiente de instalação dos componentes/serviços do TOTVS Agro API Hub e as bases de dados deve ser inferior aos valores recomendados (em milissegundos);
    • "<= 3 ms": Uso de "ping" via comando "ping HOSTNAME";
      • Importante: O teste de ping não reflete diretamente na latência durante a comunicação com o banco de dados, mas sim na indicação geral da conectividade/latência entre cliente e servidor de banco de dados.
    • "<= 3 ms": Uso de "tnsping" via comando "tnsping SERVICE_NAME";
      • Importante: O teste com tnsping não reflete diretamente na latência durante a comunicação com o banco de dados, mas sim para testar a latência na resolução de nomes de serviço e na conexão inicial com o banco de dados Oracle.
  • A latência durante as operações de banco de dados entre ambiente de instalação dos componentes/serviços do TOTVS Agro API Hub e as bases de dados deve ser inferior aos valores recomendados
    • "<= 1 ms": Para execução de consultas simples, como exemplo:
      • Oracle: "SELECT 1 FROM DUAL"


Esta página apresenta os requisitos recomendados para uma instalação e configuração padrões.

⚠️ Como TOTVS Agro API Hub é uma plataforma de comunicação com TOTVS Agro Bioenergia, tais requisitos podem ser revistos e sinalizados aos clientes, a qualquer momento, pois seu uso (TOTVS Agro API Hub) tem relação com volume de dados e poder computacional necessário para chamadas HTTP/REST.

Recomenda-se a separação entre ambiente/servidor (TOTVS Agro API Hub) - com seus componentes (por exemplo, PostgreSQL) e ambientes/servidores das demais soluções/ferramentas TOTVS Agro que farão uso da plataforma.

Por exemplo:

  • 1 ambiente/servidor para TOTVS Agro API Hub + 1 ambiente/servidor para TOTVS Agro Bioenergia (avaliar requisitos recomendados separados); ou
  • 1 ambiente/servidor para TOTVS Agro API Hub + 1 ambiente/servidor para TOTVS Agro PIMSServer (avaliar requisitos recomendados separados);

* Em situações específicas (desde que alinhado com time TOTVS Agro), tais ambientes/servidores podem ser unificados, desde que os requisitos separados sejam atendidos em sua totalidade. Importante mencionar que a separação física/lógica destes ambientes/servidores otimiza aspectos de análise, investigação, disponibilidade e otimização de configurações.


O TOTVS Agro API Hub é compatível com a versão 12.1.2412 ou superior do TOTVS Agro Bioenergia.





O instalador do TOTVS Agro API Hub está disponível no servidor de Downloads da Engenharia Agro e pode ser acessado por meio da URL abaixo:


Os dados de acesso ao servidor devem ser solicitados por meio da abertura de um chamado na Central de Atendimento da TOTVS, disponível em: https://suporte.totvs.com/


  • Descompacte o arquivo ta-api-hub-installer.zip e mova seu conteúdo para uma pasta com um nome sugestivo, como C:\TOTVS-Agro\API-HUB.


  • Execute o arquivo install.bat como administrador, pois o processo exige permissão para criação de um serviço do Windows.


  • A primeira tela exibirá uma solicitação de confirmação para iniciar o processo de instalação. Caso esteja de acordo, pressione Enter para dar continuidade à instalação.


    • Informe o nome da instância do serviço do TOTVS Agro API Hub
      • Exemplo: Nome do Cliente - PRD
        • Sugestão: Producao/Homologacao. Na nomenclatura, não deve conter acentos, caracteres especiais ou espaços.


    • Informe o IP do serviço do TOTVS Agro API Hub
      • Default: 127.0.0.1
        • Insira o IP do servidor onde o serviço estará acessível.
        • (aviso) Usar localhost restringirá o acesso apenas à máquina local.
    •  
  •  
    • Informe a porta do serviço do TOTVS Agro API Hub
      • Default: 8080
      • (aviso) Escolha uma porta disponível no servidor


    • Informe o código do banco de dados do TOTVS Agro API Hub
      • Valor: 1
        • Atualmente, o API Hub está disponível apenas para PostgreSQL.


    • Informe o usuário com permissão para conexão e uso da base de dados do API Hub (Postgres).
    •  
    • Informe a senha com permissão para conexão e uso da base de dados do API Hub (Postgres).
    •  
    • Dados de conexão com o banco Oracle do TOTVS Agro Bioenergia
      • String de conexão JDBC modelo SID: Exemplo: jdbc:oracle:thin:@127.0.0.1:1521:ORCL
      • String de conexão JDBC modelo Services Name: Exemplo: jdbc:oracle:thin:@//127.0.0.1:1521/ORCL


    • Informe o usuário com permissão para conexão e uso da base de dados do Produto (Oracle)



    • Informe a senha com permissão para conexão e uso da base de dados do Produto (Oracle).

 


      • Informe a instância padrão utilizado no produto BIOENERGIA
        • Informar a instância padrão do produto


    • Informe se deseja incluir a integração com o TOTVS Agro Middleware
      • Esta opção deve ser utilizada apenas quando houver integração com o aplicativo TOTVS Agro Middleware.


    • Tela de conclusão do processo de instalação do TOTVS Agro API Hub



Nesta seção, serão apresentadas algumas orientações para o processo de configuração do TOTVS API Hub.


Obtenção do certificado SSL
Adquira um certificado SSL válido, emitido e assinado por uma autoridade certificadora no formato .pfx (PKCS#12). 


Localização do arquivo de configuração
Acesse o arquivo ta-api-hub.xml, localizado no diretório de instalação do TOTVS Agro API Hub. 


Configuração das propriedades SSL
Antes da instrução -jar do arquivo de configuração, adicione as seguintes propriedades:

-Dserver.ssl.enabled=true → Habilita o protocolo SSL no servidor.

-Dserver.ssl.key-store → Define o caminho absoluto do arquivo .pfx que será utilizado.

-Dserver.ssl.key-store-password → Informa a senha do arquivo .pfx .

-Dserver.ssl.key-store-type=PKCS12 → Especifica o formato do arquivo de keystore utilizado (PKCS12)


A imagem abaixo apresenta um exemplo do processo de configuração.

O processo de conexão com a base do produto pode ser realizado por meio dos seguintes modelos:

  • Utilização do Owner do próprio produto
    Conectar-se utilizando o mesmo Owner do produto, acessando diretamente seus objetos na base de dados.


  • Utilização de um Owner diferente do produto
    Nesse cenário, é necessário utilizar o recurso do Oracle Logon Trigger. Esse mecanismo permite que o Owner definido acesse, de forma transparente, os objetos da base de dados do TOTVS Agro Bioenergia.


    CREATE OR REPLACE TRIGGER TRIGGER_NOME_EXEMPLO
  AFTER LOGON ON USUARIO_ORIGEM.SCHEMA
BEGIN
     EXECUTE IMMEDIATE 'ALTER SESSION SET CURRENT_SCHEMA = USUARIO_DESTINO';
END;