Guia de Instalação TSA 11.6.11

Finalidade

Este guia tem como finalidade descrever de forma objetiva os procedimentos necessários para a instalação do produto TOTVS Segurança e Acesso 11.6, bem como configurar o produto nas plataformas suportadas.

Público Alvo

Por este processo de instalação ser complexo, a instalação requer pessoas que tenham conhecimentos da arquitetura do Java, JBoss e ambiente de rede.

Documentações Importantes

Manuais JBoss

Installation Guide;

Getting Started Guide;

Server Configuration Guide.

Estas e outras documentações podem ser obtidas em Jboss AS Documentation e Jboss Wiki.

Introdução

Arquitetura Distribuída do Produto

A arquitetura distribuída consiste em separar os componentes em plataformas independentes que interagem entre si, permitindo que os recursos sejam compartilhados enquanto se obtém ao máximo os benefícios de cada dispositivo. Basicamente, funciona da seguinte forma: as máquinas dos usuários estarão conectadas aos servidores pela rede e cada servidor fornecerá recursos diferentes para que os programas possam ser executados da máquina do usuário. A figura abaixo mostra os quatro componentes básicos utilizados pelo produto.

Tipos de Instalação

Para o funcionamento do produto, é necessário executar os procedimentos de Bancos de Dados e a instalação do Servidor de Aplicação:

• Servidor de Aplicação

Instala e configura o JBoss e o Java, assim como o TOTVS Segurança e Acesso, sendo esses componentes essenciais para o funcionamento do produto.

• Banco de Dados

Procedimentos para configurar os bancos de dados utilizados pelo produto

Requisitos Básicos

Este capítulo tem como objetivo divulgar recomendações sobre o uso de hardware e software relacionados ao TOTVS Segurança e Acesso.

As recomendações e exemplos citados adiante levam em consideração somente os softwares relacionados ao TOTVS Segurança e Acesso e softwares de uso genérico, como Office e e-mail. Caso sejam instalados outros softwares no mesmo ambiente, eles devem ser levados em consideração, sendo que os requisitos descritos podem não ser o suficiente para a execução de todas as rotinas.

As versões homologadas de software, banco de dados, sistema de gestão de pessoas (Datasul, Protheus ou RM) e a firmware dos dispositivos são exatamente as citadas abaixo. Qualquer item que seja utilizado com alguma versão diferente das citadas não é considerado homologado, podendo prejudicar a execução das rotinas do produto.

Visão Geral dos Requisitos

Para dar início ao processo de atualização para o Datasul, o sistema deve obedecer a versão de pacote de origem (entre parênteses) suportado pela atualização, conforme definições da tabela a seguir:

Requisitos de Hardware

Requisitos para estação cliente

É necessário que a estação cliente possua o sistema operacional Windows ou Linux instalado. Não recomendamos o uso de estações menores que o mínimo acima citado, pois o desempenho não atenderá às necessidades dos usuários. Para todos os casos recomendamos a utilização de placas de rede de fornecedores de primeira linha.

Requisitos para servidor

A configuração acima é para servidor dedicado, não recomendamos que o servidor dos aplicativos de integração com os dispositivos seja compartilhado com alguma outra aplicação. Pelo fato da comunicação com os equipamentos ser real-time, a execução de outros aplicativos no mesmo servidor poderá gerar lentidão na liberação dos acessos.

Requisitos de Dispositivos (Controle de Acesso e Ponto Eletrônico)

Abaixo são exibidos os equipamentos suportados pelo software TOTVS Segurança e Acesso. As versões homologadas são somente as citadas abaixo. Caso seja lançada uma nova versão de firmware de qualquer dispositivo, esta não é homologada e não deve ser usada antes que seja verificada sua compatibilidade com o produto. logada e não deve ser usada antes que seja verificada sua compatibilidade com o produto. Caso tenha a necessidade de solicitar a homologação de um novo firmware, por favor, abra um chamado com a equipe de atendimento.

Requisitos de Software

Recomenda-se criar um usuário especifico para o produto TSA para configuração do sistema. Apenas para o banco de dados Progress, no qual deverá ser utilizado o usuário “pub”.

SQL Server

Deverá ser configurada uma porta fixa para a instância nomeada. Essa porta deverá ser fornecida no processo de instalação do Segurança e Acesso TOTVS descrito no capítulo “4.3 Instalação do Servidor de Aplicação”. Recomendamos que a collation do banco “tsa” e do banco do “sistema externo” seja CASE-INSENSITIVE: Latin1_General_CI_AI, sem restrição de maiúsculo e minúsculo e sem restrição de acentos.

Oracle

É necessário criar um usuário para o TOTVS Segurança e Acesso (TSA) e utilizar esse usuário para efetuar a carga das tabelas/dados no capítulo “4.4 Instalação de Banco de Dados”.

Esse ambiente Oracle deverá possuir um gatilho (trigger) para tratar diferenças na definição de CASE SENSITIVE do banco de dados. O script que deverá ser executado consta no diretório “scripts” do ambiente instalado do TSA, com o nome de “databaseInitialization-TSA-Oracle.sql”.

Caso você utilize uma instância existente, as recomendações que seguem devem prevalecer perante outros produtos não TOTVS. Para verificar valores de parâmetros de base existente, proceda as seguintes consultas e analise os resultados:

Comando:

• select parameter, value
• from nls_database_parameters
• where parameter = 'NLS_CHARACTERSET'

Resultado esperado:

• select name, value from v$parameter where name = 'db_block_size';
• select name, value from v$parameter where name = 'open_cursores';

CHARACTERSET: Obrigatoriamente o código de página do banco de dados deve possuir o valor WE8ISO8859P1 ou WE8MSWIN1252. Caso o valor deste parâmetro não seja este, a instância deverá ser recriada. Este parâmetro somente é informado durante a criação do banco de dados, desta forma não existe maneira de alterá-lo sem recriar a instância.

Progress

O sistema TOTVS Segurança e Acesso (TSA) poderá utilizar apenas o banco de dados do Datasul, sendo o banco de dados do sistema externo.

Sistema Externo: Sistema de gestão de pessoas (Datasul, Protheus, RM ou Logix). Quando Datasul será o banco de dados HCM.

Para esse banco de dados é necessário efetuar a criação do broker SQL e a criação dos usuários sysprogress e pub, ambos com permissão de DBA, conforme passos descritos abaixo:

• Criar o usuário “sysprogress”, senha “sysprogress” e o usuário “pub”, senha “pub” pelo “Admin > Security > Edit User List”;
• Fechar a sessão Progress e carregar o banco com um broker SQL:
  • proserve <banco> -S <porta> -N TCP -H <nome servidor banco> <parâmetros>
  • proserve <banco> -S <porta> -N TCP -H <nome servidor banco> -m3 -ServerType SQL <parâmetros>
• Acessar um computador cliente windows com Progress instalado;
• Acessar o “proenv” do Progress em “Iniciar > Programas > Progress > Proenv”;

MySQL

Recomendamos que o TSA seja utilizado com o mesmo banco de dados corporativo do cliente, lembrando quanto a restrição de banco de dados Progress. Porém, quando o cliente optar em utilizar o TSA com o banco de dados MySQL, deverá se atentar em efetuar a revisão da parametrização do servidor. Por padrão o MySQL é instalado com uma configuração para ambientes de desenvolvimento, por isso, caso o mesmo seja utilizado sem revisão de configuração poderá apresentar problemas de desempenho. O MySQL já possui por padrão exemplos de configurações para ambientes mais exigentes, recomendamos que seja utilizado a configuração mostrada no arquivo “my-innodb-heavy-4G.ini” da instalação do MySQL.

DB2

Em algumas situações no processo de atualização do TSA, o script de migração poderá apresentar mensagens conforme a abaixo:

Essa mensagem não é caracterizada como um erro, ela apenas informa que o comando executado (busca de dados, atualização ou deleção) foi aplicado considerando uma condição que não afetou nenhum registro da entidade em questão. A execução do script não é interrompida pelo fato das mensagens acima, desta forma, essas mensagens poderão ser ignoradas.

Java

O instalador disponibiliza automaticamente o Java na versão homologada com o sistema. Em nenhuma hipótese o Java deve ser atualizado. O TSA não está homologado com a versão Java 7 (nem superiores). Todos os serviços necessários pelo TSA são configurados utilizando o Java disponibilizado na mídia de instalação. O Java disponibilizado na mídia de instalação é a versão “JRE 1.6.0_45 64 Bits”. A localização do Java será: %TSA_HOME%\jre.

Configuração de serviços ambiente Linux

O TSA é compatível com o sistema operacional Linux, porém, o instalador da ferramenta está disponível apenas para ambientes Windows, desta forma, para instala-lo em ambiente Linux é necessário efetuar a instalação do TSA em um computador Windows e após efetuar a cópia do diretório instalado (normalmente c:\totvs\tsa) para o servidor Linux.

A inicialização manual dos serviços pode ser efetuada da seguinte forma:

JBoss (estando em tsa\jboss\bin):

./run.sh –c tsa-web -b0.0.0.0

Integrador (estando em tsa\integrador\server):

java -jar lib/tsa-core-XX.X.XX-SNAPSHOT.jar

Para iniciar os serviços de forma automática, utilize o seguinte procedimento (procedimentos executados em distribuições Linux compatíveis com Debian: Ubuntu):

JBoss:

Utilize os scripts constantes no diretório “tsa/jboss/bin”, que começam com o nome “jboss_init_*” (conforme sua distribuição).

Integrador: 

O procedimento abaixo irá fazer com que o serviço de comunicação com os dispositivos seja iniciado automaticamente e tratado como um serviço pelo servidor Linux é conforme os passos abaixo:

• No ambiente instalado, existirá o seguintes arquivos no diretório “%TSA_HOME%/integrador/server/bin/linux”:
• Para todos os arquivos do diretório acima, é necessário atribuir a permissão de execução, através do comando abaixo:
  • • sudo chmod +x /home/poffo/tsa/integrador/server/bin/linux/tsa-core-service
    • sudo chmod +x /home/poffo/tsa/integrador/server/bin/linux/ tsa-core-servicewrapper.sh
    • sudo chmod +x /home/poffo/tsa/integrador/server/bin/linux/ tsa-core-startservice.sh

tsa-core-service - Script responsável em representar o serviço dentro do ambiente do Linux. Esse script deverá ser copiado abaixo para o diretório “/etc/init.d/”:

• sudo cp /home/poffo/tsa/integrador/server/bin/linux/tsa-core-service /etc/init.d

tsa-core-service-wrapper.sh - Script utilizado para gerenciar o processo de início e parada do programa integrador do TSA. Nesse script precisaremos efetuar o ajuste das seguintes variáveis dentro do arquivo:

• JAVA_HOME: Diretorio de instalação do Java no servidor Linux;
• applDir: Deverá apontar para o caminho do TSA, no nosso caso é “/home/poffo/tsa/integrador/server/bin/linux”;
• javaArgs: Caso ocorrá alguma atualização de versão do TSA, nesta variável deverá contar o nome do JAR com a versão correta do ambiente;

tsa-core-start-service.sh

- Script responsável em iniciar o serviço, utilizado através do comando abaixo para que o serviço do TSA seja iniciado quando o ambiente Linux for iniciado:

• sudo ln -s /home/poffo/tsa/integrador/server/bin/linux/tsa-core-startservice.sh /etc/rc2.d/S20-tsa-core-start-service.sh
• sudo ln -s /home/poffo/tsa/integrador/server/bin/linux/tsa-core-startservice.sh /etc/rc3.d/S20-tsa-core-start-service.sh

Os logs do processo integrador poderão ser consultados diretamente na estrutura do TSA: %TSA_HOME%/integrador/server/log.

Os logs de início do serviço poderão ser consultados no diretório: /var/log/tsa-core.log.

Quando necessário, o serviço do integrador poderá ser iniciado ou paralisado através dos seguintes comandos:

Iniciar: sudo /etc/init.d/tsa-core-service start

Parar: sudo /etc/init.d/tsa-core-service stop

Da mesma forma como ocorre em sistemas operacionais Windows, o serviço do integrador irá subir antes do que o serviço do JBoss. Apesar do serviço integrador depender do serviço do JBoss para o seu funcionamento, ele possui técnicas para tentar obter uma conexão no JBoss em caso de falhas, fazendo com que gerencie automaticamente quando o JBoss não estiver disponível.

Requisitos de Usuário (Servidor)

Recomenda-se que a instalação do produto TSA seja efetuada com o usuário “administrador”, ou com um usuário que esteja incluso no grupo de administradores do servidor.

Instalação

Detalhes da Mídia de Instalação

A mídia de instalação do TOTVS Segurança e Acesso são disponibilizados em DVD e pelo Portal do Cliente. Nesta mídia estão disponíveis:

• Guia de Instalação do produto.
• Setup e arquivos necessários para instalação do produto.

Planejando a Instalação

Mostraremos agora as etapas que devem ser seguidas para a instalação e configuração do TOTVS Segurança e Acesso 11.6.

• Defina a topologia do ambiente. Nesta etapa, deve ser definido onde cada componente será instalado. Escolha o hardware que será utilizado como servidor de banco de dados, servidor de arquivos, servidor de aplicação e também as máquinas que estarão disponíveis aos usuários. Para cada um destes componentes, verifique se os requisitos de hardware e software são atendidos.
• Instale os bancos de dados.
• Instale o servidor de aplicação.

A mídia só faz uma instalação dos bancos e servidor de aplicação de uma vez só.

• Carregue os bancos de dados utilizando os scripts.

Inicie o JBoss através do serviço “TOTVS Controle de Acesso (TSA) - 8080” criado no “Services” do Windows. Após a conclusão destas etapas, o produto estará pronto para utilização.

Instalação do Servidor de Aplicação

Execute o arquivo “setup.exe” para iniciar o processo de instalação.

Na tela de apresentação do instalador, clique em “Avançar” para dar início no processo de instalação do TSA:

Digite o nome do usuário e o nome da empresa onde esta sendo instalado o TSA:

Na tela abaixo selecione onde será instalado o TOTVS Segurança e Acesso (TSA):

Selecione o idioma de instalação do TSA, podendo ser Português (Brasil) ou Espanhol (México):

Na tela abaixo selecione em qual porta WEB o TSA estará disponível. Com essa opção é possível instalar até 4 instâncias do TSA no mesmo servidor.

Selecione a base de dados na qual o TSA será executado dentro das opções disponíveis, nessa simulação escolheremos MySQL (posteriormente será questionado qual o banco de dados do sistema externo: Datasul, Protheus ou RM):

Digite o nome do servidor e a porta de conexão do servidor de banco de dados:

Digite o nome do banco de dados onde as tabelas do TSA estarão:

Digite o usuário de conexão no banco de dados (recomenda-se um usuário exclusivo TSA):

Digite a senha do usuário de conexão no banco de dados:

Selecione a base de dados que o sistema externo (Datasul, Protheus ou RM) utiliza. No exemplo abaixo será escolhido Progress utilizando como base o produto Datasul:

Informe o nome do servidor e a porta do servidor de banco de dados do sistema externo. O sistema externo é o produto de gestão de pessoas da TOTVS que fará o tratamento das marcações para o cálculo do ponto eletrônico. O sistema externo pode ser: Datasul, Protheus, RM ou Logix.

Na tela abaixo é informado qual o nome do banco de dados do sistema externo:

Na tela abaixo é informado o usuário de conexão no banco de dados do sistema externo (recomenda-se um usuário exclusivo TSA), para o banco Progress é utilizado o usuário pub:

Na tela abaixo deve ser informado a senha para conexão no banco de dados do sistema externo.

Após, o instalador irá preparar os dados para iniciar a instalação:

Após o processo de instalação irá iniciar:

Após, o processo de instalação foi finalizado:

Objetos Criados na Instalação do Servidor de Aplicação

Seguem os objetos importantes para administração do ambiente, criados na instalação do servidor de aplicação.

Instalando Henry Orion 6 (versão 2014)

Para que o programa “Integrador” do TSA efetue a comunicação correta com os dispositivos Henry Orion 6, o servidor necessita de alguns passos adicionais, conforme descrito abaixo.

Além dos passos abaixo, é importante verificar com a fabricante do dispositivo se o mesmo já passou pelo processo de “recall”, no qual o fabricante efetua a revisão e substituição de algumas peças para corrigir problemas identificado nas primeiras versões dos equipamentos.

Passos:

1. Efetue a instalação do programa “Henry Configurações 7x” (programa deve ser obtido juntamente com o fabricante do dispositivo ou algum representante técnico), versão 7.2.0.47 ou superior no servidor onde o serviço do integrador será executado. Esse programa copia arquivos necessários para a comunicação com os dispositivos.
2. Copie os arquivos 4 arquivos (“JobKernel.exe”, “Kernel7x.dll”, “KernelVelti.dll” e “KernelVelti3.dll”) disponibilizados no diretório “%TSA_HOME%\integrador\server\bin\henry-orion-6” para o diretório “c:\windows”. Esses arquivos são necessários para a comunicação com os dispositivos, foram desenvolvidos e são mantidos pela Henry. Quando necessário atualização os mesmos serão disponibilizados no pacote do produto TSA e os clientes serão notificados através do Release Notes do produto TSA.

Após os passos acima é possível iniciar o serviço do integrador e iniciar a comunicação com os dispositivos Henry Orion 6.

Instalando Ambiente TSA Múltiplas Instâncias

Após efetuar a instalação do TSA, deve-se executar o programa tsa-instance-config.bat com direitos administrativos. Esse programa deverá ser executado no servidor da Matriz para configuração da instancia Matriz e nas instancias filiais para configuração das instancias filiais.

Matriz:

A tela abaixo permite selecionar a operação que será executada para configuração ou inicialização de instâncias do TSA. Inicialmente será efetuado a configuração da Matriz, na sequencia será detalhado a configuração das instâncias e inicialização das mesmas.

Na tela abaixo foi alterado a porta padrão pelo fato da Matriz e da instância, nesta simulação, estarem no mesmo servidor. Por questões de finalidade da funcionalidade não deve-se manter Matriz e Instâncias no mesmo servidor. Na configuração das Instâncias deverá ser considerado as informações abaixo para indicar aonde está localizado a instância Mestre.

Na tela abaixo é exibido um descritivo de todas as ações que será executado no ambiente do TSA.

Na tela abaixo é exibido o status da execução das atividades exibidas na tela anterior. Atentar que as vezes a criação do serviço falha, por questões de restrição administrativa do Windows. Nestas situações deve-se ser executado o script de criação manualmente, conforme indicado na tela abaixo.

Na tela abaixo é exibido os próximos passos que deve ser executado, ou seja, a inicialização do ambiente sincronizador do TSA na Instância Matriz e na sequência iniciar o serviço do sincronizador para execução das demais configurações automaticamente.

Instância:

A base de dados do TSA da instância já deve estar carregada, considerando o script de carga inicial

Na tela abaixo informamos qual será o codigo da instância no qual está sendo configurado neste momento. Esse código não poderá ser alterado futuramente. O código “000” é reservado obrigatoriamente para a Instância Mestre.

Na tela abaixo é informado os dados da localização do sincronizador da Instância Mestre do TSA, necessário para que a sincronização ocorrá.

Na tela abaixo é exibido um descritivo de todas as ações que será executado no ambiente do TSA.

Na tela abaixo é exibido o status da execução das atividades no ambiente sincronizador do TSA.

Na tela abaixo é exibido os próximos passos, no caso iniciar o serviço do sincronizador na instância. Antes disso deve-se atentar se o serviço na instância mestre está iniciado.

Inicializando dados das instâncias:

Deve ser executado na instância Matriz, uma vez para cada instância que deve ser inicializada. Antes do término da primeira sincronização, da primeira instância, pode-se iniciar a sincronização da segunda instância.

Na tela abaixo informamos qual instância será iniciada.

Na tela abaixo é exibido um descritivo de todas as ações que será executado no ambiente do TSA.

Na tela abaixo é exibido o status das ações executadas, no caso apenas marcado a instância em questão para ser iniciada.

Na tela abaixo é exibido um descritivo do que deve ser efetuado agora, ou seja, iniciar o serviço da Instância Mestre. Antes disso atente-se que o serviço da instância do TSA que será iniciado está ativo.

• O cadastro da nova instância deve ocorrer no TSA Matriz, através do menu Tecnologia -> Configuração de Instância.
• O novo cadastro será sincronizado com as demais instâncias automaticamente.
• O status da sincronização pode ser consultado no TSA Matriz na tela de Informações do Sistema.
  
  

Na tela abaixo é exibido os comandos de sincronização que estão pendentes. Os comandos executados com sucesso são eliminados desta tela, ficando o que está pendente ou com erro de execução.

Lengenda do status:

RT -> Processo de roteamento;

RQ -> Processo de extração em background;

NE -> Sincronização nova pronta para ser processada (enfileirado);

QY -> Processo de consulta (transformação);

SE -> Enviado para uma instância;

LD -> Em processo de carga (transformação);

OK -> Replicação efetuada com sucesso;

IG -> Replicação ignorada;

ER -> Replicação ocorreu com erro.

Ao término da sincronização, deve-se entrar na Instância, habilitar o parâmetro de sincronização (multiinstance.enabled) e informar qual o código desta Instância (currentinstance.code).

Removendo a sincronização e iniciando novamente:

Execute os scripts abaixo, eles estão localizados no diretório: %TSA_HOME%\scripts\multiinstance-initialization:

Eliminar o symmetric do banco de dados da Instância Matriz: remove-symmetric-entities.sql

Eliminar o banco de dados da Instância não Matriz completamente: Executar “drop” no “database”

Criar novamente o banco de dados da Instância não Matriz e executar o script de carga inicial do TSA: %TSA_HOME%\scripts\databaseInitialization-TSA-SQLSERVER-schema.sql

Executar o processo de eliminação dos dados da filial: initialize-symmetric-node.sql

Executar o script de carga da matriz: multiinstance-initialization-sqlserver.sql

• Iniciar o serviço sincronizador da Instância Matriz;
• Iniciar o serviço sincronizador da Instância não Matriz em questão;
• Através do configurador de instâncias, inicie novamente a Instância não Matriz. Lembrando que este processo deve ser executado na Instância Matriz, conforme descrito acima.

Instalação de Banco de Dados

A seleção do banco de dados no processo de instalação descrito no capitulo “4.3 Instalação do Servidor de Aplicação” é para que o JBoss seja configurado corretamente. O processo de instalação do banco de dados deverá ser executado manualmente e após, efetuada a carga dos dados do banco de dados.

Deverá ser carregado no banco de dados informado no processo de instalação o script “databaseInitialization-TSA*-schema.sql” localizado no diretório “<TSA_HOME\scripts”. Substitua o asterisco (*) pelo fabricante do banco de dados que deve ser carregado (DB2, MySQL, Oracle ou SQL Server). Esse script fará a criação do ambiente do TOTVS Segurança e Acesso e a inicialização necessária do ambiente.

O script de criação da tabela externa (de marcações) deverá ser carregado no banco de dados informado no processo de instalação como “Sistema Externo” que corresponde ao software de gestão de pessoas utilizado, podendo ser: Datasul, Protheus ou RM. Os scripts estão localizados no diretório “TSA_HOME\scripts” e possuem o padrão de nomenclatura: “databaseInitialization-TSA_EXT-*-schema.sql”, sendo que o asterisco (*) corresponde ao fabricante do banco de dados. O banco de dados externo pode ser um dos bancos a seguir: DB2, MySQL, Oracle, SQL Server, Progress ou Informix.

Inicializando o TOTVS Segurança e Acesso

Inicie o JBoss através do serviço “TOTVS Controle de Acesso (TSA) - 8080” criado no “Services” do Windows.

Acesso ao TOTVS Segurança e Acesso

Abra um navegador e acesse “http://localhost:8080/tsa-web” com os dados de login abaixo:

Login: adm

Senha: 123

Reinstalação

A reinstalação pode ser executada para restaurar os programas originais, atente-se em informar os mesmos valores para as configurações de banco de dados. Recomenda-se que seja efetuado um backup do ambiente antes de prosseguir com um processo de reinstalação.

Arquivos de configurações importantes para backup:

• %TSA_HOME%\integrador\server\conf\*
• %TSA_HOME%\jboss\server\tsa-web\deploy\properties-service.xml
• %TSA_HOME%\jboss\server\tsa-web\deploy\tsa-ds.xml

Desinstalação

O procedimento de desinstalação deve ser executado somente quando não é mais necessário os componentes instalado em cada servidor, sendo que essa rotina deve ser executada a partir do servidor onde foi instalado cada componente.

Para desinstalar o produto em ambiente Windows deve ser selecionada a opção “remover” do “TSA * Controle de Acesso TOTVS” em “Iniciar > Configurações > Painel de Controle > Adicionar ou Remover Programas”.