Páginas filhas
  • TOTVS Agro API Hub (silencioso e gráfico)

Versões comparadas

Chave

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

Índice


VISÃO GERAL

Abordaremos as etapas necessárias para o processo de instalação do TOTVS Agro API Hub, por meio da ferramenta Instalador em modo silencioso (modo não interativo) e modo padrão.


...

PRÉ-REQUISITOS

1. Versão Mínima para Instalação

A versão mínima necessária do TOTVS Agro API Hub, para o processo de instalação, para utilizar o instalador é a 12.1.2512.


...

PACOTE DE INSTALAÇÃO

O pacote do instalador do TOTVS Agro API Hub está disponível na Central de Download da TOTVS, o modo de instalação silencioso está disponível a partir da Release 12.1.2512.


...

ESTRUTURA DE ARQUIVOS NO INSTALADOR

Ao baixar e descompactar o instalador do TOTVS Agro API Hub, haverá a seguinte estrutura de arquivos:

...

  • install.bat: Utilizado para executar o instalador em modo interativo.
  • install-silent.bat: Utilizado para executar o processo de instalação em modo silencioso.
  • totvs-agro-ta-api-hub-oracle.properties: Utilizado para configurar os parâmetros para o processo de instalação em modo silencioso.

EXECUÇÃO DO INSTALADOR EM MODO SILENCIOSO

O instalador em modo silencioso visa permitir a instalação automatizada do software sem a necessidade de interação do usuário. Isso facilita a implantação em ambientes corporativos, reduz erros humanos, agiliza o processo e garante consistência nas instalações. Além disso, o modo silencioso é ideal para integrações com scripts e ferramentas de gerenciamento de sistemas.

ARQUIVO DE CONFIGURAÇÃO DA INSTALAÇÃO (.properties)

Antes de executar o instalador em modo silencioso, é necessário que o totvs-agro-ta-api-hub-windows-oracle.properties ou totvs-agro-ta-api-hub-linux-oracle.properties, dependendo do sistema operacional utilizado,esteja corretamente preenchido. Este arquivo define os parâmetros para a instalação do TOTVS Agro API Hub.

...

Bloco de código
languagetext
firstline1
titleArquivo totvs-agro-ta-api-hub-windows-oracle.properties
linenumberstrue
collapsetrue
#TOTVS Agro Java Spring - Windows + Oracle

target.os=windows

bioenergia.selected=${INSTALL_BIOENERGIA}
industria.mi.selected=${INSTALL_INDUSTRIA_MI}
industria.pi.selected=${INSTALL_INDUSTRIA_PI}

iz.api.hub.path=${CAMINHO_DA_INSTALACAO}

## TOTVS Api Hub
# Network
api.hub.service.address=${API_HUB_IP_APLICACAO}
api.hub.service.port=${API_HUB_PORT_APLICACAO}
api.hub.service.name=${API_HUB_SERVICE_NAME}
api.hub.service.description=${API_HUB_SERVICE_DESCRIPTION}
api.hub.server.context=${API_HUB_SERVER_CONTEXT}

# Database
api.hub.database.dbms=oracle
api.hub.database.oracle.connection.type=${API_HUB_TIPO_CONEXAO_DATABASE}
api.hub.database.connection.dialect=org.hibernate.dialect.Oracle11cDialectOracleDialect
api.hub.database.user=${API_HUB_USER_DATABASE}
api.hub.database.password=${API_HUB_PASSWORD_DATABASE}
api.hub.database.host=${API_HUB_IP_DATABASE}
api.hub.database.port=${API_HUB_PORTA_DATABASE}
api.hub.database.name=${API_HUB_NAME_DATABASE}
api.hub.database.url=jdbc:oracle:thin:@//${API_HUB_IP_DATABASE}:${API_HUB_PORTA_DATABASE}/${API_HUB_NAME_DATABASE}

# Additional info
api.hub.default.instance=${API_HUB_DEFAULT_INSTANCE}
api.hub.default.company=${API_HUB_DEFAULT_COMPANY}

# Database Products
## Bioenergia - Database
bioenergia.database.dbms=oracle
bioenergia.database.oracle.connection.type=${BIOENERGIA_TIPO_CONEXAO_DATABASE}
bioenergia.database.connection.dialect=org.hibernate.dialect.Oracle11cDialect
bioenergia.database.user=${BIOENERGIA_USER_DATABASE}
bioenergia.database.password=${BIOENERGIA_PASSWORD_DATABASE}
bioenergia.database.host=${BIOENERGIA_IP_DATABASE}
bioenergia.database.port=${BIOENERGIA_PORTA_DATABASE}
bioenergia.database.name=${BIOENERGIA_NAME_DATABASE}
bioenergia.database.url=jdbc:oracle:thin:@//${BIOENERGIA_IP_DATABASE}:${BIOENERGIA_PORTA_DATABASE}/${BIOENERGIA_NAME_DATABASE}

## Industria MI - Database
industria.mi.database.dbms=oracle
industria.mi.database.oracle.connection.type=${INDUSTRIA_MI_TIPO_CONEXAO_DATABASE}
industria.mi.database.connection.dialect=org.hibernate.dialect.Oracle11gDialect
industria.mi.database.user=${INDUSTRIA_MI_USER_DATABASE}
industria.mi.database.password=${INDUSTRIA_MI_PASSWORD_DATABASE}
industria.mi.database.host=${INDUSTRIA_MI_IP_DATABASE}
industria.mi.database.port=${INDUSTRIA_MI_PORTA_DATABASE}
industria.mi.database.name=${INDUSTRIA_MI_NAME_DATABASE}
industria.mi.database.url=jdbc:oracle:thin:@//${INDUSTRIA_MI_IP_DATABASE}:${INDUSTRIA_MI_PORTA_DATABASE}/${INDUSTRIA_MI_NAME_DATABASE}

## Industria PI - Database
industria.pi.database.dbms=oracle
industria.pi.database.oracle.connection.type=${INDUSTRIA_PI_TIPO_CONEXAO_DATABASE}
industria.pi.database.connection.dialect=org.hibernate.dialect.Oracle11gDialect
industria.pi.database.user=${INDUSTRIA_PI_USER_DATABASE}
industria.pi.database.password=${INDUSTRIA_PI_PASSWORD_DATABASE}
industria.pi.database.host=${INDUSTRIA_PI_IP_DATABASE}
industria.pi.database.port=${INDUSTRIA_PI_PORTA_DATABASE}
industria.pi.database.name=${INDUSTRIA_PI_NAME_DATABASE}
industria.pi.database.url=jdbc:oracle:thin:@//${INDUSTRIA_PI_IP_DATABASE}:${INDUSTRIA_PI_PORTA_DATABASE}/${INDUSTRIA_PI_NAME_DATABASE}

# Middleware
middleware.enabled=false
middleware.ip=
middleware.port=

# SSL / HTTPS
ssl.enabled=${SSL_ENABLED}
ssl.keystore.path=${SSL_KEYSTORE_PATH}
ssl.keystore.password=${SSL_KEYSTORE_PASSWORD}

# Memory JVM
memory.initial=${MEMORY_INITIAL}
memory.max=${MEMORY_MAX}

# Credentials API
credentials.client.id=${CREDENTIALS_CLIENT_ID}
credentials.client.secret=${CREDENTIALS_CLIENT_SECRET}

##

...

Bloco de código
languagetext
firstline1
titleArquivo totvs-agro-ta-api-hub-linux-oracle.properties
linenumberstrue
collapsetrue
#TOTVS Agro Java Spring - Linux + Oracle

target.os=unix
unix.distro=RedHat

bioenergia.selected=${INSTALL_BIOENERGIA}
industria.mi.selected=${INSTALL_INDUSTRIA_MI}
industria.pi.selected=${INSTALL_INDUSTRIA_PI}

iz.api.hub.path=${CAMINHO_DA_INSTALACAO}

## TOTVS Api Hub
# Network
api.hub.service.address=${API_HUB_IP_APLICACAO}
api.hub.service.port=${API_HUB_PORT_APLICACAO}
api.hub.server.context=${API_HUB_SERVER_CONTEXT}

# Database
api.hub.database.dbms=oracle
api.hub.database.oracle.connection.type=${API_HUB_TIPO_CONEXAO_DATABASE}
api.hub.database.connection.dialect=org.hibernate.dialect.Oracle11cDialectOracleDialect
api.hub.database.user=${API_HUB_USER_DATABASE}
api.hub.database.password=${API_HUB_PASSWORD_DATABASE}
api.hub.database.host=${API_HUB_IP_DATABASE}
api.hub.database.port=${API_HUB_PORTA_DATABASE}
api.hub.database.name=${API_HUB_NAME_DATABASE}
api.hub.database.url=jdbc:oracle:thin:@//${API_HUB_IP_DATABASE}:${API_HUB_PORTA_DATABASE}/${API_HUB_NAME_DATABASE}

# Additional info
api.hub.default.instance=${API_HUB_DEFAULT_INSTANCE}
api.hub.default.company=${API_HUB_DEFAULT_COMPANY}

# Database Products
## Bioenergia - Database
bioenergia.database.dbms=oracle
bioenergia.database.oracle.connection.type=${BIOENERGIA_TIPO_CONEXAO_DATABASE}
bioenergia.database.connection.dialect=org.hibernate.dialect.Oracle11cDialect
bioenergia.database.user=${BIOENERGIA_USER_DATABASE}
bioenergia.database.password=${BIOENERGIA_PASSWORD_DATABASE}
bioenergia.database.host=${BIOENERGIA_IP_DATABASE}
bioenergia.database.port=${BIOENERGIA_PORTA_DATABASE}
bioenergia.database.name=${BIOENERGIA_NAME_DATABASE}
bioenergia.database.url=jdbc:oracle:thin:@//${BIOENERGIA_IP_DATABASE}:${BIOENERGIA_PORTA_DATABASE}/${BIOENERGIA_NAME_DATABASE}

## Industria MI - Database
industria.mi.database.dbms=oracle
industria.mi.database.oracle.connection.type=${INDUSTRIA_MI_TIPO_CONEXAO_DATABASE}
industria.mi.database.connection.dialect=org.hibernate.dialect.Oracle11gDialect
industria.mi.database.user=${INDUSTRIA_MI_USER_DATABASE}
industria.mi.database.password=${INDUSTRIA_MI_PASSWORD_DATABASE}
industria.mi.database.host=${INDUSTRIA_MI_IP_DATABASE}
industria.mi.database.port=${INDUSTRIA_MI_PORTA_DATABASE}
industria.mi.database.name=${INDUSTRIA_MI_NAME_DATABASE}
industria.mi.database.url=jdbc:oracle:thin:@//${INDUSTRIA_MI_IP_DATABASE}:${INDUSTRIA_MI_PORTA_DATABASE}/${INDUSTRIA_MI_NAME_DATABASE}

## Industria PI - Database
industria.pi.database.dbms=oracle
industria.pi.database.oracle.connection.type=${INDUSTRIA_PI_TIPO_CONEXAO_DATABASE}
industria.pi.database.connection.dialect=org.hibernate.dialect.Oracle11gDialect
industria.pi.database.user=${INDUSTRIA_PI_USER_DATABASE}
industria.pi.database.password=${INDUSTRIA_PI_PASSWORD_DATABASE}
industria.pi.database.host=${INDUSTRIA_PI_IP_DATABASE}
industria.pi.database.port=${INDUSTRIA_PI_PORTA_DATABASE}
industria.pi.database.name=${INDUSTRIA_PI_NAME_DATABASE}
industria.pi.database.url=jdbc:oracle:thin:@//${INDUSTRIA_PI_IP_DATABASE}:${INDUSTRIA_PI_PORTA_DATABASE}/${INDUSTRIA_PI_NAME_DATABASE}

# Middleware
middleware.enabled=false
middleware.ip=
middleware.port=

# SSL / HTTPS
ssl.enabled=${SSL_ENABLED}
ssl.keystore.path=${SSL_KEYSTORE_PATH}
ssl.keystore.password=${SSL_KEYSTORE_PASSWORD}

# Memory JVM
memory.initial=${MEMORY_INITIAL}
memory.max=${MEMORY_MAX}

# Credentials API
credentials.client.id=${CREDENTIALS_CLIENT_ID}
credentials.client.secret=${CREDENTIALS_CLIENT_SECRET}

##


EXECUTANDO A INSTALAÇÃO

Após configurado o arquivo totvs-agro-ta-api-hub-oracle.properties, para iniciar o processo de instalação em modo silencioso, basta executar o arquivo install-silent.bat em modo Administrador, e o processo irá iniciar automaticamente.

...

Caso alguma informação no arquivo totvs-agro-ta-api-hub-oracle.properties esteja incorreta ou inválida, o processo de instalação, ao identificar a inconsistência, será abortado, exibindo a mensagem informativa, conforme exemplo abaixo:


...

EXECUÇÃO DO INSTALADOR EM MODO PADRÃO

PROCESSO DE INSTALAÇÃO PADRÃO

Após realizar o download e extrair o instalador, execute o arquivo install.bat  ou install.sh com privilégios de administrador para iniciar o processo de instalação.

...

Após concluir essas etapas, basta aguardar o processo de instalação.

Aviso
  1. Para verificar se a aplicação foi instalada com sucesso, acesse a URL http://SEU_IP:SUA_PORTA/api/actuator/health. Ao carregá-la, deverá exibir a mensagem {"status":"UP"} 
  2. Após a instalação concluída e o serviço em execução, para realizar um teste, basta codificar SEU_CLIENT_ID:SEU_CLIENT_SECRET (no exemplo: teste:teste:123) para Base64
  3. Agora basta chamar http://SEU_IP:SUA_PORTA/oauth2/token enviando no Headers
    1. Key: Authorization
    2. Value: Basic dGVzdGU6dGVzdGUxMjM=



...

SUGESTÕES DE MELHORIAS

Para sugestões de melhorias no processo de instalação, acesse a Central Colaborativa TOTVS

...