Manual do Instalador PIMSConnector em Linux

12.1.19 (Janeiro/2018)

Sumário

1. Contexto de negócio (Introdução)

2. Pré-requisitos instalação/implantação/utilização

3.5. Iniciando o PIMSConnector

4.2. Diretório pimsconnectorconfig

5. Configurações adicionais do JBoss

Este manual tem como objetivo capacitar clientes, usuários e demais profissionais que manipulam ou que de alguma forma estão envolvidos com a manutenção do PIMSConnector a realizarem instalações e atualizações dos ambientes de execução relacionados ao PIMS. Com esse Manual os profissionais terão plenas condições de aplicarem os procedimentos nos ambientes configurados para o PIMSConnector.

Pré-requisitos instalação/implantação/utilização

Sistema Operacional

O aplicativo PIMSConnector é desenvolvido na plataforma Java EE e pode ser instalado em qualquer sistema operacional que suporte a execução de aplicações Java.
Linux (distribuições como RedHat, CentOS e Fedora, mas não se limitando a estas, desde que em suas versões Server), preferencialmente 64 bits *.

Sistema Gerenciador de Banco de Dados

A aplicação PIMSConnector está homologada para realizar integração com os seguintes SGBDs:

SQL Server 2005
SQL Server 2008
Oracle 11 G

Servidores de Aplicações

O servidor de aplicações utilizado para implantação do PIMSConnector é o Jboss 6.1.0. Este servidor é multiplataforma, ou seja, um único instalador pode ser utilizado para qualquer sistema operacional.
A obtenção do software deve ser feita junto à equipe de suporte da TOTVS Agro, uma vez que a versão do servidor utilizada para instalação do PIMSConnector possui algumas configurações específicas de acordo com o banco de dados utilizado.

SDK Java

A instalação de um SDK Java é exigida e as seguintes versões podem ser utilizadas:

JDK 6 - Estas devem ser obtidas de acordo com o sistema operacional utilizado e a plataforma (64 bits ou 32 bits)

Requisitos de Hardware e Ambiente

Para a implantação do PIMSConnector recomendam-se dois ambientes, um para "HOMOLOGAÇÃO" e outro "PRODUÇÃO". Recomenda-se esta configuração para que as atualizações de versão sejam executadas e testadas em ambiente independentes, inicialmente em homologação e posteriormente em ambiente de produção.

Servidores de Aplicações

Para o servidor de aplicações de Produção (Jboss) é esperado que se tenha (como configuração mínima):

Servidor Pentium Xeon ou Quad Core 64 bits (mínimo de 2 cpus),
4 GB de RAM disponíveis
10 GB de HD disponíveis

Para o servidor de aplicações de Homologação (Jboss) é esperado que se tenha (como configuração mínima):

Servidor Pentium Core 2 Duo ou Dual Core (mínimo de 2 cpus) 64 bits,
4 GB de RAM *disponíveis ***
10 GB de HD disponíveis

Pastas & Permissões (Configurações para rotina de instalação)

Criar um usuário jboss.
Criar a pasta TotvsAgro no Diretório opt/ dando direitos de acesso ao usuário jboss.

Antes de iniciar a instalação verificar as configurações do sistema operacional dos seguintes arquivos:

/etc/hostname

/etc/sysconfig/network

/etc/sysconfig/i18n

/etc/sysconfig/iptables

Observação: Esse manual de instalação foi realizado na distribuição CentOS 6 do Linux. Para outras distribuições podem haver variações de nome e local dos arquivos.

Na distribuição do CentOS 6.

Abrir o arquivo network localizado em /etc/sysconfig e informar o HOSTNAME de sua preferência
Abrir o arquivo de hosts localizado em /etc e inserir o IP e o hostname.
Verificar o idioma configurado no ambiente executando o comando locale. Se o idioma for diferente de pt_BR.iso88591, abrir o arquivo i18n localizado em /etc/sysconfig e alterar o idioma do parâmetro LANG.

Após realizar configurações reinicie o servidor.
Abrir o arquivo /etc/sysconfig/iptables. Definir quais portas de entrada e saída serão liberadas.

:OUTPUT ACCEPT [587:587] ( Porta de saída para envio de e-mail).
-A INPUT -m - - state NEW -m tcp -p - - dport 8080 -j ACCEPT (Porta de entrada para conexão com o servidor = http://IP:8080/PIMSConnector)

Instalador

Descompactar o arquivo "PIMSConnector-Instalador- VERSAO -linux.zip" na pasta /home/jboss

Acessar a pasta onde foi realizada a descompactação e executar PIMSConnectorInstall.sh

Escolha o idioma para prosseguir.

Instalação

Selecione Instalação clique Próximo.

Selecione o diretório onde será realizada a instalação. Como padrão traz "opt/TotvsAgro/PIMSConnector", porém pode ser informado outro caminho

para instalação desde que haja as permissões de leitura e escrita.

Selecione o Ambiente da instalação.

Escolha o ambiente de Instalação:

A instalação compreende por padrão dois ambientes, sendo um de Homologação e outro de Produção. Selecionando uma destas opções serão criados os ambientes "PRD" ou "HMG".

Se o campo "Outro ambiente (Especificar)" for preenchido será criado um ambiente com nome personalizado.

IP do Servidor:

O IP do Servidor compreende a máquina onde está sendo instalado o PIMSConnector, por padrão o instalador já traz preenchido o IP.

Porta do Jboss:

Onde será executado o PIMSConnector, está compreendido entre 8080 à 9980.

Fuso Horário

Determina um fuso específico para o servidor de aplicação do PIMSConnector, ou seja, o sistema operacional pode trabalhar com um fuso e o servidor de aplicação com outro fuso horário.

Quando é selecionado a opção "Sistema Operacional", o PIMSConnector é configurado com o mesmo fuso horário do servidor.

Horário

Pode ser normal ou horário de verão. Quando é escolhido o horário de verão é acrescentado uma hora a mais no horário normal com base no fuso horário selecionado.

Para os fusos que não contemplam horário de verão não haverá adição desta hora a mais.

Exibe as operações que serão executadas na instalação.

Clicando nas opções ou posicionando o mouse em cima, é apresentado um descritivo mais detalhado da operação.

.

Tela de configuração de acesso ao Banco de Dados do PIMSConnector. As informações desta tela podem ser mantidas. A senha pode ser gerada nos arquivos de configuração criptografada ou sem criptografia.

Defina as informações do Banco de Dados do PIMSMulticultivos que pode ser em Oracle ou SLQServer. A senha pode ser gerada nos arquivos de configuração criptografada ou sem criptografia.

Caso ocorra algum erro na tentativa de conexão com o Banco de Dados, um relatório será exibido.

Exibe as informações do arquivo PIMSConnectorBridge.properties. Nenhuma alteração será realizada nessa etapa.

Exibe um resumo das configurações das Operações da instalação. Clique em Próximo para iniciar o processo de instalação.

Ao clicar no botão "Próximo" abrirá uma tela de confirmação.

Exibe a execução das operações realizadas.

Caso não ocorra nenhum erro, a instalação será finalizada com sucesso.

Após o final da instalação será iniciado o wizard de configuração do PIMSConnector automaticamente, de acordo com a URL definida na instalação.

Na tela inicial do Wizard, selecione o modelo de integração (Nesta versão Protheus x PIMS Multicultivos ) a ser utilizada e clique em Avançar.

Configuração do WebService do ERP.

Nesta tela será informado o endereço URL de comunicação com o ERP para integrações de mensagens únicas. Se não for uma URL válida não abrirá a tela da próxima etapa.

Clique em Avançar. Informa usuário e senha de autenticação caso haja necessidade.

Na tela seguinte desmarque as mensagens que não serão integradas e clique em Avançar.

A próxima tela realizaremos as parametrização do PIMSConnector e PIMS Multicultivos.

Após realizar todas as configurações necessárias dos Parâmetros clique em Avançar.

A próxima tela exibe as configurações de e-mail, se optar por não configurar, marque a opção Desabilitar Configuração.

Na tela seguinte cadastre os destinatários que receberam os e-mail com resumo do processamento das mensagens.

Obs: Esta tela não aparecerá se desabilitar a configuração de email.

Clique no botão "Novo" para incluir destinatários.

Selecionar as integrações que irão enviar mensagem de e-mail caso ocorra algum erro de integração.

As integrações definidas como:

Será gerado e-mail conforme a configuração do agendamento de envio definido no PIMSConnector, para as demais quando ocorrer erro será gerado o e-mail independentemente se o agendamento estiver ativo ou não.

Resumo Geral: apresenta um relatório das integrações processadas em um determinado período apresentando cada integração com as suas respectivas quantidades de Sucesso, Erro, etc...

AnaliseBaixa/AnaliseOS: Apresenta os boletins que apresentaram alguma divergência no processamento. (Apontamentos diversos e Solicitação de Material de Oficina ).

Tela de Configuração de Agendamentos.

Configure o tempo para execução das mensagens que serão integradas. A mensagem MensagemUnicaDataDriver é obrigatório a sua configuração.

Ela responsável pelo processamento das mensagem do tipo Assíncrona.

Tela de configuração do usuário padrão. Por padrão o usuário é criado como ADMIN e a senha ADMIN.

Alteração da senha do usuário ADMIN é obrigatório.

Ao finalizar as configurações do Wizard, será apresentado o resumo dos procedimentos efetuados, clique em Concluir para finalizar as configurações.

Após realizar todas as configurações, o sistema será redirecionado para página de login e senha, utilize o usuário padrão (admin) e a senha que configurou no wizard.

Tela Principal do PIMSConnector

Atualização

Selecione Atualização clique Próximo.

Selecione o diretório onde será realizada a atualização. Como padrão traz "/opt/TotvsAgro/PIMSConnector", porém pode ser informado outro caminho. Em seguida escolha a instância.

Exibe o resumo das configurações referente ao processo de atualização.

Observação: Caso o serviço do Jboss, não esteja no padrão utilizado pelo PIMSConnector, o instalador irá padronizar o nome do Serviço.

Histórico de integração de mensagem única.

Esta tela define se haverá ou não exclusão de histórico de mensagem com data superior a 30 dias.

Exibe as operações que serão executadas na atualização.

Informa que um backup do ambiente será realizado no ato da atualização do ambiente.

Antes de iniciar a atualização é apresentado um resumo das operações que serão realizadas.

Ao clicar em Próximo será exibido uma tela de confirmação.

Ao final do processo de atualização será apresentada a tela com o resultado de execução das operações.

Caso não ocorra nenhum erro, a instalação será finalizada com sucesso.

Ao final da atualização será iniciado o serviço do PIMSConnector e será carregado no navegador definido como padrão.

Pagina principal do PIMSConnector

Configurações

Selecione Configurações clique Próximo.

Selecione o diretório onde será realizada a Configuração. Como padrão traz "/opt/TotvsAgro/PIMSConnector", porém pode ser informado outro caminho. Em seguida escolha a instância.

Será exibido o resumo das configurações de instalação. O Instalador realizará a parada do PIMSConnector, antes de iniciar o processo de configuração.

Abrirá uma tela para informar usuário e senha para prosseguir com a configuração. O usuário deverá ser do tipo "ADMIN".

Tela de configuração

IP do Servidor:

Traz o IP configurado para o servidor de aplicativo (Jboss). Após clicar em "Próximo" será verificado se o IP informado existe, se não existir será retornada a tela de erro abaixo

Porta do Jboss:

Porta em que rodará o serviço do PIMSConnector, após clicar no botão "Próximo" será feito uma verificação se a porta selecionada não está sendo utilizada por outro serviço, retornando a seguinte tela de erro quando a mesma estiver em uso:

Seleciona o Fuso Horário:

Permite alterar o fuso horário configurado no servidor de aplicativos do PIMSConnector (JBOSS) .

Horário:

Define se o fuso horário selecionado será no horário normal ou horário de verão. Será acrescentado uma hora a mais na configuração caso seja selecionado horário de verão.

Quando a porta do JBOSS é alterada, o serviço do windows é removido e criado novamente.

Histórico de Integração de mensagem única.

Esta define se haverá ou não exclusão de históricos de mensagem única com data superior à 30 dias.

Tela que mostra as operações que serão executadas na rotina de configuração

Tela com informações do DataSource do PIMSConnector.

Tela com informações do DataSource do PIMSMulticultivos.

Tela com as configurações que serão geradas no arquivo de propriedades PIMSConnectorBrigde.properties.

Tela com resumo das configurações das operações que serão realizadas.

Tela de confirmação.

Tela com informações das operações realizadas.

Caso não ocorra nenhum erro, a configuração será finalizada com sucesso.

Ao final da configuração será iniciado o serviço do PIMSConnector e será carregado no navegador.

Tela principal do PIMSConnector.

Desinstalação

Selecione Desinstalação clique Próximo.

Selecione o diretório onde será realizada a Desinstalação. Como padrão traz "/opt/TotvsAgro/PIMSConnector", porém pode ser informado outro caminho. Em seguida escolha a instância.

Será exibido o resumo das configurações de instalação. O Instalador realizará a parada do PIMSConnector, antes de iniciar o processo de desinstalação.

Caso exista alguma movimentação registrada será necessário informar usuário/senha.

Exibe as operações que serão executadas na desinstalação.

Exibe um resumo das configurações das operações.

Ao clicar em Próxima exibirá uma tela para confirmação da desinstalação

Ao final do processo de desinstalação será apresentada a tela com o resultado de execução das operações.

Caso não ocorra nenhum erro, a desinstalação será finalizada com sucesso.

Iniciando o PIMSConnector

Iniciar servidor Jboss navegar até a pasta bin do jboss (diretório de instalação + jboss-6.1.0.pimsconnector/bin)

Executar o seguinte comando: ./runHMG.sh start
No nosso exemplo está instalado a instância HMG, se fosse PRD o comando seria ./runPRD.sh start , ou seja o termo é composto ./runAmbiente.sh start .
Aguardar alguns minutos e informar na na URL do navegador o endereço: http://ip_servidor:porta/PIMSConnector

Informar usuário e senha de acesso ao PIMSConnector. Na instalação o usuário padrão é admin e a senha é a configurada no wizard de configuração.

Migração

O processo de migração irá auxiliar no transporte das informações presente no H2 Database para o PostgreSQL, esse processo irá migrar as configurações e mensagens (Não Processadas no período de 30 dias ).

Selecione Migração clique Próximo.

Selecione o diretório onde será realizada a Migração. Como padrão traz "/opt/TotvsAgro/PIMSConnector", porém pode ser informado outro caminho. Em seguida escolha a instância.

Será exibido o resumo das configurações referente ao processo de Migração.

Será exibido as recomendações para o processo de Migração.

Tela para informar usuário e senha do PIMSConnector para dar prosseguimento na operação de Migração. O usuário deve estar parametrizado como "ADMIN" .

Será exibido o resumo das tabelas que serão migradas no processo de Migração.

Informar os dados para conexão com o banco de Dados PostgreSQL

Ao clicar no botão Próximo, abrirá uma tela de confirmação de atualização

Ao final o processo de Migração, será apresentada o resultado de execução das operações.

Caso não ocorra nenhum erro, a Migração será finalizada com sucesso.

Overview do JBoss

Esta é uma rápida introdução ao servidor de aplicações JBoss, abordando os pontos que são importantes para o contexto do PIMSConnector.
Ao observar o conteúdo do diretório de instalação do JBoss, podemos observar os seguintes subdiretórios. Vamos explorar alguns deles.

Bin: Scripts para início e término do servidor de aplicações, além de scripts para desenvolvimento de Web Services e o Twiddle;

Client: Bibliotecas Java (arquivos *.jar) para a compilação de componentes a serem hospedados pelo JBoss AS e para a execução de clientes remotos que falem com estes componentes;

Common: Diretório de uso exclusivo do sistema JBoss. Onde se localiza todos os painéis de administração do JBoss.

Docs: Exemplos de documentos XML para configuração de Serviços MBean;

Lib: Classes Java que formam o Microkernel JMX e permitem a inicialização do JBoss AS;

Server: Cada subdiretório desta pasta forma uma configuração distinta do JBoss AS, isto é, um conjunto de Serviços Bean e seus diretórios de trabalho.

Diretório server

O PIMSConnector é executado por padrão na configuração server\HMG ou server\PRD. Caso a instalação seja feita de forma manual, os ambientes poderão ter nomes diferentes dos citados acima.
Dentro das configurações temos os seguintes diretórios:

Work: diretório de arquivos temporários gerados pelo JBoss para as aplicações implantadas.
Tmp: diretório de arquivos temporários gerados pelo JBoss durante sua execução.
Pimsconnectorlibs: bibliotecas utilizadas especificamente pela aplicação, como por exemplo o driver jdbc de conexão com os bancos de dados, frameworks.
Pimsconnectordata: diretório do banco de dados interno do PIMSConnector.
Pimsconnectorconfig: diretório de arquivos configurações relativas ao serviço do PIMSConnector.
Log: diretório onde os logs gerados pelo servidor e pela aplicação são armazenados.
Lib: bibliotecas utilizadas pelo JBoss para a execução de aplicações e componentes.
Deploy: diretório onde são implantados as aplicações e os componentes do servidor de aplicações.
Datasources: diretório com modelos de datasources (Conexão de Banco de Dados).
Data: arquivos temporários de banco de dados utilizado internamente pelo servidor de aplicações.
Conf: diretório de arquivos de configuração.

Sempre que o servidor JBoss for parado para atualização de versões, por exemplo, ou ainda em casos não previstos, como desligamento acidental do servidor, os diretórios a seguir deverão ser apagados:

tmp/
work/
log/
data/

Se for necessário guardar os logs para qualquer análise posterior, faça um backup do diretório log antes de eliminá-lo.
Na rotina de atualização realizada pelo Instalador, as pastas tmp, work, log e data são apagadas.

Diretório pimsconnectorconfig

Diretório com arquivos de configuração do PIMSConnector:

PimsConnectorBridge.properties: arquivo de configuração de portas e parâmetros do módulo principal.
mssql_mapings.xml: arquivo de mapeamento de comandos SQL entre Oracle e SQLSERVER.

Diretório deploy

Neste diretório temos arquivos de configuração dos DataSources.

PimsConnector-ds.xml: configuração do datasource do PIMSConnector

Com criptografia de senha:

Sem criptografia de senha:

PimsMulticultura-ds.xml: configuração do datasource do PIMSMulticultivos

SQLServer com criptografia de senha:

SQLServer sem criptografia de senha:

Oracle com criptografia de senha:

Oracle sem criptografia de senha:

Diretório apl

Diretório onde ficam os arquivos que executam as integrações e o núcleo do PIMSConnector

Diretório conf

Login-config.xml: arquivo de configuração dos mecanismos de autenticação no servidor de aplicação. Este arquivo será útil quando houver a necessidade de se utilizar credenciais criptografadas em arquivos de datasource.

No arquivo existem várias políticas de autenticação. No exemplo abaixo segue exemplo de estrutura de configuração para senha criptografada para datasource do PIMSMulticultivos.

Datasource do PIMSMulticultivos utilizando senha criptografada

Configurações adicionais do JBoss

Verbosidade de Logs

O JBoss AS 6 possui um arquivo de configurações para o nível de verbosidade dos logs gerados. Explicando de forma resumida, existem os níveis de log DEBUG, INFO, WARN E ERROR, sendo DEBUG o de menor criticidade (usado em modo de desenvolvimento e homologação) e ERROR o de maior criticidade.
Quanto menor a criticidade utilizada na configuração, maior é a quantidade de log gerado, aumentando assim a quantidade de utilização de disco. Para ambientes de produção, é adequado configurar os níveis de log para WARN. Isto pode ser feito no arquivo JBOSS_HOME\server\HMG\deploy\jboss-logging.xml (onde JBOSS_HOME é o diretório de instalação do servidor). Neste arquivo há várias categorias configuradas, como a que é apresentada abaixo:

O valor do elemento level deve então ser configurado para ERROR em todas as categorias encontradas.

Páginas filhas