Introdução

O TOTVS Intellector é uma solução para a gestão de processos decisórios, fornecendo uma interação fácil através de uma linguagem simples e prática. Este manual descreve passo-a-passo o processo de instalação do servidor TOTVS Intellector para o JBoss Application Server versão 7.1.1.

Para quem se destina o manual

O público alvo para este manual são administradores de sistemas e application servers, e que tenha bom conhecimento de JBoss e JVM.


O que é necessário para entender esse manual

Este manual assume que os administradores tem familiaridade com os conceitos de administração e deployment do JBoss, Linux ou Windows e Sun JDK.


Pré-requisitos

Como um primeiro passo, verifique e tenha certeza de qual versão do TOTVS Intellector você deseja instalar ou atualizar. Baseado na versão, você pode determinar a compatibilidade apropriada das versões de JBoss, Linux (veja as versões abaixo) ou Windows, e Java Oracle JDK.

Informações adicionais:
JDK 7.0

Instale a Sun JDK 1.7 64 bits apropriada para sua plataforma. As bibliotecas JDK estão disponíveis no seguinte site: http://java.sun.com/javase/downloads/index.jsp. Recomendamos usar versão Update 80. O TOTVS Intellector NÃO FUNCIONA com JDK inferior ao Update 07 devido à API do JAXB.

Não é suficiente ter somente o Java Runtime Environment (JRE), é imprescindível ter a versão full-blown JDK.

Não se esqueça de configurar JAVA_HOME no seu ambiente, mas, forneceremos um bootstrap para o TOTVS Intellector onde essa variável é configurada.  É necessário realizar essa configuração, caso necessite poderá ser colocada em outro lugar. Embora a localização da instalação da JDK seja livre, sugerimos criar uma pasta "<drive>:\opt" no Windows ou usar o "/opt" no Unix, isso ajuda para propósitos de suporte. Instalando em sistemas Unix, tenha bastante cuidado com as permissões de escrita para owner/group para o diretório do JBoss, pois o TOTVS Intellector irá precisar "escrever" nesse diretório.


 JBoss

O TOTVS Intellector foi homologado nas versões JBoss 4.2.3-GA, JBoss EAP 6.3 e JBoss 7.1.1. Você pode fazer o download do JBoss, para qualquer plataforma do seguinte site: http://www.jboss.org/jbossas/downloads/ .

Este é um bom lugar para tirar dúvidas e procurar dicas sobre o JBoss: http://wiki.jboss.org/ .


Instalando...

Após instalar o Java JDK e o JBoss nos locais apropriados, é necessário realizar um teste de verificação da instalação, subindo o JBoss ($JBOSS_HOME/bin/standalone.sh ou standalone.bat no Windows). Para verificar a instalação, deverá clicar na url  http://localhost:9990/console   de administração do application server. Se a console pedir autenticação, siga esse artigo para criar usuários que podem ter acesso ao container.

Evite instalar JDK e JBoss em diretórios que contenham espaços no nome, como "C:\Arquivo de Programas" do Windows  Conheça mais sobre JBoss Enterprise Application Platform.


Bootstrap para JBoss e TOTVS Intellector

Os scripts de bootstrap para o TOTVS Intellector são simples, precisando apenas de pequenas modificações no que concerne a utilização de memória e variáveis de ambientes. Usar o nome run-intellector.sh no Linux/Unix e run-intellector.bat no Windows e, deve ficar em $JBOSS_HOME/bin com permissão explícita de execução (básico para os linuxers).

#!/bin/bash
# exporta variaveis de ambiente necessarias
export JAVA_OPTS="-XX:+TieredCompilation -Dprogram.name=standalone.sh -Xms512M -Xmx512M -XX:MaxPermSize=256M -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000 -Djava.net.preferIPv4Stack=true -Dorg.jboss.resolver.warning=true -Duser.server.node=mynode -Djboss.modules.system.pkgs=org.jboss.byteman -Djboss.server.default.config=standalone-full.xml -Dpersistence.configuration=$JBOSS_HOME/bin/persistence.properties"

# remove indicativo de erros no deployment
rm -fv /opt/jboss7/standalone/deployments/*.failed
# atualize com seu IP
./standalone.sh -Djboss.bind.address.management=YOUR_IP -b YOUR_IP


No Windows:

rem alguns snipets para o bootstrap do Intellector
set JAVA_OPTS=-XX:+TieredCompilation -Dprogram.name=standalone.bat -Xms64M -Xmx512M -XX:MaxPermSize=256M -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000 -Djava.net.preferIPv4Stack=true -Dorg.jboss.resolver.warning=true -Duser.server.node=mynode -Djboss.modules.system.pkgs=org.jboss.byteman -Djboss.server.default.config=standalone-full.xml

rem inicia o JBoss numa instancia e IP especificos
./call standalone ./standalone.sh -Djboss.bind.address.management=YOUR_IP -b YOUR_IP


Área de dados para o TOTVS Intellector

O TOTVS Intellector tem uma característica de persistir alguns dados no File System da plataforma, seja persistência em XML (JAXB), seja dos plugins de acessos, políticas e layouts de políticas. Esse local de persistência, é um diretório ou uma árvore de diretórios. Você pode verificar, que no arquivo de bootstrap, existe uma variável intellector.datadir que deve apontar para um diretório válido, onde ocorrerá a persistência e o site criará o restante dos diretórios. Veja uma árvore de diretórios criada pelo site abaixo:

NUNCA MODIFIQUE NADA nos diretórios abaixo de Intellector.datadir.

 
Configurações do Application Server para o TOTVS Intellector

As seguintes configurações devem ser efetuadas no Appllication Server para que o TOTVS Intellector funcione corretamente.

ATENÇÃO: Lembrar de colocar o caminho onde deseja criar o datadir na propriedade "value".

<system-properties> 
    <property name="intellector.datadir" value="COLOQUE_AQUI_O_CAMINHO_DO_DATADIR"/> 
    <property name="persistence.configuration" value="MEU_CAMINHO/persistence.properties" /> 
</system-properties>

OPCIONAL: Na tag de logging (<subsystem xmlns="urn:jboss:domain:logging:1.1">) adicionar o item abaixo para que warnings sobre utilização de classes privadas da API (as commons-*, por exemplo) sejam suprimidos.



<logger category="org.jboss.as.dependency.private"> 
    <level name="ERROR"/> 
</logger>

  


<jms-destinations> 
    <jms-queue name="intellectorQueue"> 
    <entry name="queue/intellector"/> 
    <entry name="java:jboss/exported/jms/queue/intellector"/> 
    </jms-queue> 
    <jms-topic name="intellectorTopic"> 
    <entry name="topic/intellector"/> 
    <entry name="java:jboss/exported/jms/topic/intellector"/> 
    </jms-topic> 
</jms-destinations> 
Módulos a serem alterados e criados

Criar módulo e registrar os drivers de banco. Como exemplo usaremos a criação de um módulo com o driver para Postgres.

<?xml version="1.0" encoding="UTF-8"?>
<module xmlns="urn:jboss:module:1.1" name="org.postgresql">
     <resources>
         <resource-root path="postgresql-9.3-1103.jdbc4.jar"/>
     </resources>
     <dependencies>
         <module name="javax.api"/>
         <module name="javax.transaction.api"/>
         <module name="javax.servlet.api" optional="true"/>
     </dependencies>
 </module>

Criar módulo e registrar os drivers de banco. Como exemplo usaremos a criação de um módulo com o driver para Oracle.

<?xml version="1.0" encoding="UTF-8"?>
<module xmlns="urn:jboss:module:1.1" name="com.oracle.ojdbc6">
     <resources>
         <resource-root path="ojdbc6-11.2.0.3.0.jar"/>
     </resources>
     <dependencies>
         <module name="javax.api"/>
         <module name="javax.transaction.api"/>
      </dependencies>
  </module>

Criar módulo e registrar os drivers de banco. Como exemplo usaremos a criação de um módulo com o driver para MSSQLSever.

<?xml version="1.0" encoding="UTF-8"?>
<module xmlns="urn:jboss:module:1.1" name="net.sourceforge.jtds">
     <resources>
         <resource-root path="jtds-1.2.7.jar"/>
     </resources>
     <dependencies>
         <module name="javax.api"/>
         <module name="javax.transaction.api"/>
      </dependencies>
  </module>


Spring Framework


<resources> 
    <resource-root path="spring-asm.jar"/> 
    <resource-root path="spring-aop.jar"/> 
    <resource-root path="spring-context.jar"/> 
    <resource-root path="spring-core.jar"/> 
    <resource-root path="spring-beans.jar"/> 
    <resource-root path="spring-tx.jar"/> 
    <resource-root path="spring-jms.jar"/> 
    <resource-root path="spring-expression.jar"/> 
    <resource-root path="spring-web.jar"/> 
</resources>


CXF 2.6.4

Instalando uma Licença para o TOTVS Intellector

O TOTVS Intellector trabalha com 3 (três) modelos de licenciamento, Enterprise, Limited e Trial. Essas licenças estarão contidas em um único arquivo nomeado intellector.key (outro nome não será reconhecido) que deverá ser colocado no diretório ${intellector.datadir}/key. Ele poderá ser copiado para esse local a qualquer momento, não necessitando de qualquer intervenção no servidor.

  1. Enterprise -  totalmente livre para execução de qualquer política sem data de expiração;
  2. Limited -      determinada por um tipo específico e uma data de expiração ou não;
  3. Trial -          tipos de políticas livres e com uma data de expiração.
 
Deployment do TOTVS Intellector no JBoss

Considerando que o item instalando o JBoss foi seguido, o próximo passo será o deployment (instalação) do pacote intellector-ear.ear em uma instância do JBoss.

  1. Copiar intellector-ear.ear dentro do diretório $JBOSS_HOME/standalone/deployments;
  2. Se for uma atualização de versão, simplesmente remova o intellector-ear.ear, ANTES de extrair a nova versão. As pastas log, tmp e work situadas abaixo da instância, neste caso: $JBOSS_HOME/standalone/log, tmp, etc,  poderão ser guardadas, mas é uma boa prática excluí-las.
 
Iniciando o JBoss

Se os passos foram seguidos e tudo correu bem, então é hora de iniciar o JBoss. No diretório $JBOSS_HOME/bin, inicie o batch simplesmente digitando ./run-intellector.sh (linux/unix) ou run.bat no Windows. Segue abaixo o início e o fim do bootstrap do JBoss:

========================================================================= 
  
  JBoss Bootstrap Environment 
  
  JBOSS_HOME: /opt/jboss7
  
  JAVA: java 
  
  JAVA_OPTS:  -server -XX:+TieredCompilation -Xms64m -Xmx512m -XX:MaxPermSize=256m -Djava.net.preferIPv4Stack=true -Dorg.jboss.resolver.warning=true -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000 -Djboss.modules.system.pkgs=org.jboss.byteman -Djava.awt.headless=true -Djboss.server.default.config=standalone.xml 
  
========================================================================= 
  
11:52:02,131 INFO  [org.jboss.modules] JBoss Modules version 1.1.1.GA 
11:52:03,376 INFO  [org.jboss.msc] JBoss MSC version 1.0.2.GA 
11:52:03,458 INFO  [org.jboss.as] JBAS015899: JBoss AS 7.1.1.Final "Brontes" starting 
11:52:07,565 INFO  [org.jboss.as.server] JBAS015888: Creating http management service using socket-binding (management-http)


11:52:24,116 INFO  [br.com.tools.intellector] (MSC service thread 1-2) -----------------------------------------------------------
11:52:24,117 INFO  [br.com.tools.intellector] (MSC service thread 1-2) --------- Intellector configurado com sucesso... ---------- 
11:52:24,117 INFO  [br.com.tools.intellector] (MSC service thread 1-2) ----------------------------------------------------------- 
11:52:24,154 INFO  [org.jboss.web] (MSC service thread 1-2) JBAS018210: Registering web context: /intellector
11:52:24,156 INFO  [org.jboss.as] (MSC service thread 1-2) JBAS015951: Admin console listening on http://127.0.0.1:9990 
11:52:24,157 ERROR [org.jboss.as] (MSC service thread 1-2) JBAS015875: JBoss AS 7.1.1.Final "Brontes" started (with errors) in 23695ms - Started 537 of 625 services (6 services failed or missing dependencies, 80 services are passive or on-demand

Normalmente, ajustes adicionais, ou tuning, dependem de plataforma, número de requisições, escalabilidade, multi-ip, dentre outras, a mais comum é alterar a porta onde o container irá atender default é a 8080. Outros casos, como HTTPS ou load balancer, envolvendo o Apache, devem ser analisadas e não fazem parte do escopo desse manual.

Arquivo persistence.properties

Para utilização da persistência de acessos no TOTVS Intellector Server, na primeira execução antes da utilização do cache, deverá ser copiado o arquivo de configuração persistence.properties para o diretório $JBOSS_HOME/bin, como descrito abaixo.

O TOTVS Intellector utiliza a API de persistência Hibernate de forma que este arquivo também serve para mapear as configurações mais eficazes para utilização da API.


#persistence.properties 
#Fri Feb 03 13:52:26 BRST 2012 
  
### Define se o intellector utilizará banco de dados para persistência dos dados de acessos e políticas 
intellector.usesdatabase=true
  
### Nome da fila utilizada pelo MDB (Não pode ser alterado) 
persistence.queue.name=queue/intellector
  
### Connection Factory 
persistence.queue.connection.factory=/ConnectionFactory
  
### Endereço da fila JMS 
persistence.jndi.address=jnp://192.168.0.113:1099 
  
### Emails de aviso de erro na fila de tarifação, separados por virgula, de preferência sem espaço 
user.emailsWarning= 
#[email protected], [email protected] 
  
### Credenciais de conexão na fila Usuário/Senha 
persistence.jndi.security.principal= 
persistence.jndi.security.credentials= 
  
### Parâmetros do Hibernate do Cache ### 
######################################## 
## Endereço JNDI da conexão 
hibernate.connection.datasource=java:/intellector/totvs
#hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect 
hibernate.dialect=org.hibernate.dialect.SQLServer2008Dialect 
#hibernate.dialect=br.com.totvs.persistence.dialectfix.Oracle9iDialectFix 
#hibernate.dialect=br.com.totvs.persistence.dialectfix.Oracle10gDialectFix 
  
## auto schema export 
hibernate.hbm2ddl.auto=update 
  
# cache 
#hibernate.cache.provider_class=org.hibernate.hibernate.NoCacheProvider 
hibernate.cache.use_second_level_cache=true
hibernate.max_fetch_depth=1 
hibernate.cache.use_minimal_puts=true
  
## Delimitador de comandos específico do Banco de dados utilizado 
hibernate.hbm2ddl.delimiter=; 
  
#hibernate.session_factory_name=TSessionFactory 
hibernate.show_sql=true
hibernate.format_sql=true
hibernate.use_sql_comments=true
hibernate.generate_statistics=true
hibernate.jdbc.batch_versioned_data=true
hibernate.use_second_level_cache=false
hibernate.use_query_cache=false
hibernate.connection.release_mode=after_transaction 
hibernate.connection.autocommit=false
hibernate.session_factory_name=sessionFactory 
hibernate.current_session_context_class=thread 
  
# transaction controll 
hibernate.transaction.flush_before_completion=false
hibernate.transaction.auto_close_session=false
 
# para o caso da base Oracle 11g, descomentar a linha abaixo
#hibernate.default_schema=<NOME_DO_SCHEMA>


hibernate.connection.datasource
hibernate.dialect


Configurando Pool de Conexões - JNDI
Apontamento dos drivers de conexão.

Informar todos os drivers/modules que foram utilizados dentro do arquivo standalone-full.xml


                <drivers>
                    <driver name="postgresql-driver" module="org.postgresql">
                        <driver-class>org.postgresql.Driver</driver-class>
                    </driver>
                    <driver name="oracle-driver" module="com.oracle.ojdbc6">
                        <driver-class>oracle.jdbc.OracleDriver</driver-class>
                    </driver>
                    <driver name="jtds-driver" module="net.sourceforge.jtds">
                        <driver-class>net.sourceforge.jtds.jdbc.Driver</driver-class>
                    </driver>
                </drivers>
 

Se referem ao banco de dados onde serão armazenadas as informações de cache e auditoria. Os bancos homologados para essas funcionalidades foram Oracle 10g e 11, SQL Server 2008 e PostgreSQL 9.x.