AÇÃO ATIVAÇÃO DE USUÁRIOS PIMS X AGRO/PIMSCS
Contexto de negócio (Introdução)
Realizar atualizações periódicas dos usuários PIMS com o status existente no servidor de domínio da empresa, mas também permitir que tenhamos canais de integração onde outras aplicações ERP possam acionar o PIMS e realizar as atualizações de status em tempo real para garantir que as políticas de segurança sejam aplicadas de forma imediata.
Nessa integração tem o objetivo de um ERP específico faça a chamada para que um específico usuário seja ativado dentro do PIMS seguindo as regras de verificação dentro do Servidor AD.
Sistemas Envolvidos
Descrição dos sistemas envolvidos no contexto de negócio (e que serão envolvidos na integração).
- PIMSCS/GUtilit Web - Ativação de Usuários.
- BackOffice(s) - Qualquer sistema pode fazer a chamada da integração desde que atenda o requisito de Chamada via HTTP/Rest e que contenha um usuário e senha com permissão dentro do PIMS.
Integração
O que levou a criação da integração foi a necessidade e facilidade do cliente para ativar um usuário dentro do PIMS.
Escopo
Na interface de Ativação de usuários estaremos realizando um check adicional para garantir a ativação do usuário apenas quando o mesmo já estiver ativo no AD ou ERP.
Após receber o código do usuário deveremos verificar se o mesmo existe no cadastro Pims, levando em consideração o método de autenticação de usuário simples ou extendido.
Com a validação de existência no cadastro de usuário deveremos passar a verificar se o seu status atual no AD ou ERP esta como ativo, se ocorrer de estar inativo então deveremos retornar mensagem para a interface e não executar a ativiação.
No caso do usuário já estar ativo no AD ou ERP então prosseguiremos com a Rotina de Ativação enviando o usuário e o código de Origem 2.
Interface de Integração de Ativação do Usuário
Rotina de Ativação de Usuário
Bibliotecas a serem adicionadas:
- com.google.code.gson
- log4j
- org.apache.httpcomponents
- Biblioteca Rest Client disponível no arquivo de integrações: pimsserver-rest-client-12.1.9
Caso esteja utilizando o gerenciador de dependências Maven, adicione as seguintes linhas no pom.xml:
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.2.4</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.5.1</version>
</dependency>
Para todos os serviços, deve-se usar o seguinte cabeçalho de requisição HTTP:
Content-Type: application/json; charset=utf-8
usuario: usuárioPIMSautorizado
senha: SenhaDoUsuário
idioma: pt_BR
instancia: instanciaDoUsuário
Ativar Usuário
Tipo do Método: PUT
URI: GUtilitRest/rest/integracao/GUtilitRest/AtivaUsuario
Dados necessários no formato JSON:
{
"usuario": "strUsuarioParaAtivar"
}
Objeto de Banco: GUTILITWEB.WEBSERVICE.ativarUsuario
Retorno do Serviço: TRUE ou FALSE
Pré-requisitos instalação/implantação/utilização
1. Sistemas operacionais
Exige-se, no mínimo, Windows XP SP3, sendo possível realizar a instalação em servidores com Windows 2003 Server, Windows 2008 Server ou ainda Windows 7. O sistema operacional também deve ser 64 bits.
2. JDK - Java Development Kit
a. Versões do JDK suportadas pelo PIMS Web
Para a instalação do PIMS Web, a SDK Java é exigida. Deve-se utilizar a versão 6, mais atualizada.
b. Obtenção do Software
O software JDK está disponível para diversos sistemas operacionais e plataformas (32 bits e 64 bits). A versão mais recente (atualizada) do software pode ser obtida através das seguintes fontes:
Download direto do site da Oracle:
http://www.oracle.com/technetwork/java/javase/downloads/index.html
Obtenção através do FTP disponibilizado pela TOTVS. Neste caso é necessário entrar em contato com o suporte para obter os dados de acesso.
c. Requisitos de espaço em disco
No mínimo 300MB devem estar disponíveis no disco de instalação. Porém, recomenda-se 500MB durante a instalação.
http://www.oracle.com/technetwork/java/javase/windows-diskspace-140460.html
3. Servidor de Aplicações JBoss 6.1
a. Versões do JBoss suportadas pelo PIMS Web
Para a implantação do PIMS Web, a instalação de um Servidor de Aplicações é exigida. O único servidor de aplicações homologado para a execução do PIMS Web, atualmente é o JBoss Application Server, em sua versão 6.1.0.
b. Obtenção do Software
O software JBoss AS é open-source e multiplataforma, o que significa que seu instalador pode ser utilizado para diversos sistemas operacionais e plataformas (32 bits e 64 bits) que suportem a plataforma Java.
Apesar de estar gratuitamente disponível para download no site do fornecedor, obtenção do instalador do JBoss para o PIMS Web Agrícola deve ser feita através do FTP disponibilizado pela TOTVS, pois o mesmo já estará pré-configurado com as bibliotecas necessárias para o funcionamento do PIMS Web.
Portanto, para a obtenção do instalador, é necessário entrar em contato com o suporte da TOTVS para obter os dados de acesso ao FTP.
c. Requisitos de espaço em disco
Para a instalação do JBoss AS 6.1.0, no mínimo 15GB devem estar disponíveis no disco de instalação.
d. Concorrência de outros serviços Java
Há casos em que o servidor destinado à instalação do aplicativo já possui outras aplicações Java instaladas, como aplicações desktop (standalone) ou servidoras.
Quando este for o caso, a equipe técnica da TOTVS deverá ser notificada com a descrição de tais aplicativos/serviços, afim de que se possam prever possíveis conflitos na instalação.
Recursos de Hardware
4. Plataforma
O hardware utilizado para a instalação do PIMS Web deve ser uma máquina dedicada e possuir uma arquitetura de 64 bits, devido à possibilidade de aumento de memória e melhor desempenho.
5. Memória RAM
8GB disponíveis (por disponível entenda a quantidade de memória livre, além daquela já utilizada pelo sistema operacional e outros aplicativos; não se trata da quantidade total de memória da máquina).
6. Processador
Dual Core 2.0 GHZ ou XEON 2.0 GHZ
7. Espaço em Disco
30GB (o espaço em disco total leva em conta os espaços requeridos pelo SDK Java, pelo Servidor de aplicações JBoss 6.1, o tamanho da aplicação e espaço para armazenamento de logs da aplicação. O armazenamento necessário para o banco de dados do cliente deve ser considerado à parte).
ATENÇÃO: Estes valores são uma referência de configuração mínima, e podem sofrer alterações de acordo com as necessidades do contexto do cliente. Qualquer alteração nas recomendações, para mais ou para menos, deverão ser analisadas pela equipe técnica da TOTVS.
Pims CS
Insira aqui as informações pertinentes a Datasul.
Instalação/Atualização
- Instalação do Java JDK 1.6 update 45
- Crie o diretório C:\TOTVS\PIMSWeb\java;
- Instale a jdk1.6.0_45 no diretório C:\TOTVS\PIMSWeb\java\;
- Configuração e instalação do servidor de aplicação JBOSS 6
- Crie o diretório C:\TOTVS\PIMSWeb\;
- Realize a descompactação do jboss6 no diretório C:\TOTVS\PIMSWeb\
- Adicione os arquivos GUtilitModule.jar e GUtilitRest.war no diretório C:\TOTVS\PIMSWeb\jboss6\server\producao\deploy\pimsserver
- Realize a configuração da conexão com a base de dados no arquivo PIMSCS-oracle-xa-ds.xml localizado no diretório C:\TOTVS\PIMSWeb\jboss6\server\producao\deploy\pimsserver. Utilize o arquivo TNSNAMES.ORA para coletar as informações necessárias para que a conexão com a base de dados seja realizada com sucesso.
- Realize as configurações do diretório do jboss6 e da jdk1.6.0_45, a porta a ser utilizada, o tipo de autenticação de usuário (SIMPLE ou EXTENDS) e o modo de autenticação (BD ou LDAP) usuário no arquivo run-producao.conf.bat localizado no diretório C:\TOTVS\PIMSWeb\jboss6\bin:
- Configure o IP da aplicação PIMSWeb no arquivo service-producao.bat localizado no diretório C:\TOTVS\PIMSWeb\jboss6\bin. Edite o arquivo service-producao.bat e substitua o IP 127.0.0.1 pelo IP da aplicação.
- Instale a aplicação PIMSWeb como serviço do Windows por meio do prompt de comando (cmd). Para isso, abra o Prompt de Comando como Administrador, execute o comando CD C:\TOTVS\PIMSWeb\jboss6\bin
- Em seguida, execute o comando para instalar o serviço service-producao.bat install
- Com a aplicação PIMSWeb instalada como serviço do Windows falta apenas inicia-la.
Controle de Versão
O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.
Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.
Suporte
O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos RM Conector e Backoffice Protheus estarão aptas a fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.
Observação: Este modelo de suporte está sendo revisado pela TOTVS.
Transações/Entidades/Mensagens únicas
ERP solicita via HTTP/Rest a Ativação de usuário e espera o retorno do Web Service em Síncrono.
Método | ID | Descrição | Origem | Destino | HTTP |
Processo | 01 | Ativar Usuário | ERP | PIMS | GUtilitRest/rest/integracao/GUtilitRest/AtivaUsuario |