Integração PROTHEUS (SIGAJURI) X RM (Simplificado) 

Contexto de negócio

O intuito deste manual e validar a integração do Ambiente RM X Protheus via envio de mensagem única EAI. 

O objetivo da integração do PROTHEUS x BackOffice RM é viabilizar que de forma automática os cadastros gerenciados pelo BackOffice sejam replicados.  Desta forma as bases de dados se mantém espelhadas. 

Sistemas Envolvidos

Descrição dos sistemas envolvidos no contexto de negócio (e que serão envolvidos na integração).

• Microsiga Protheus através dos seguintes módulos:

  • Protheus Framework (SIGACFG): Módulo responsável pelos WebServices e Framework de Integração.

  • Protheus Padrão Jurídico (SIGAJURI): Módulo Jurídico.

  • TOTVS Business Connect: Módulo responsável pelos WebServices e Framework de Integração.

Integração

Atender a demanda de clientes que possuem o BackOffice RM,  sincronizando as informações entre os módulos a partir da integração por Mensagem Única TOTVS.

Modelo de Mensagem Única TOTVS

Durante o processo de consolidação de marcas, iniciado pela TOTVS, várias empresas diferentes foram adquiridas e com elas vários produtos passaram a compor o portfólio de ofertas disponível aos clientes. Esta expansão de ofertas permitiu que clientes de uma marca, antes limitados pelas opções com aquela “etiqueta”, pudessem agora compor o seu ambiente de TI utilizando produtos de origens diferentes (Exemplo: BackOffice RM + Protheus).

Esta mesma iniciativa já era uma prática comum nos clientes, porém todo o custo envolvido na integração entre estes aplicativos era visto pelo cliente como parte da escolha de utilizar-se de produtos de diferentes fornecedores. Uma vez que estes produtos passam a fazer parte de uma mesma oferta, os clientes TOTVS passam a demandar que estes produtos sejam naturalmente integrados. Isto significa que se antes o cliente arcava com o custo e o risco envolvido em uma integração (como corrupção da base de dados, por exemplo), ele agora entende que a TOTVS deve prover soluções já integradas, independente da origem dos produtos oferecidos.

Com o objetivo de padronizar as integrações com os produtos TOTVS, foi definida uma nova diretriz para os projetos de integração: A de que todos os produtos TOTVS devam trabalhar com uma mensagem XML único evitando, desta forma, o processo de transformação de mensagens. Neste cenário, teríamos o seguinte quadro:

Neste cenário, qualquer produto TOTVS trabalhará com o mesmo XML para uma mesma entidade, vamos supor que tenhamos um XML correspondente à mensagem de CLIENTES, ela poderá ser enviada para qualquer um dos produtos que suporte o recebimento desta entidade.
Uma vez que os vários produtos TOTVS terão um "idioma" comum (o XML único), as integrações entre estes produtos não exigirão mais que as mensagens sejam transformadas de um formato para outro. Com isto, será possível conectar diretamente dois produtos, sem a necessidade do TOTVS ESB, como no diagrama abaixo: 

Além de questões referentes ao formato das mensagens, a mensagem única também torna uniforme o tratamento destas mensagens XML pelos aplicativos, principalmente no que diz respeito à capacidade de rastreamento.

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

O ambiente de integração necessita, além dos pré-requisitos de cada módulo individualmente, das seguintes características:

• Permissão de tráfego na rede entre os sistemas e os WebServices de destino.
• Devem haver licenças de uso suficientes para o processamento das integrações em conjunto com o uso dos sistemas.

BackOffice RM

• Configurar a integração TOTVS PROTHEUS x BackOffice RM por meio do TBC na versão 12.1.12 ou superior.
• Importação das Fórmulas Visuais com gatilhos de integração, enviando os registros ao EAI.
• Cadastramento do De-Para de Empresas e Filial antes de iniciar a carga de dados.
• Os cadastros mantidos pelo BackOffice RM, como por exemplo de Clientes, devem ter desabilitada no Protheus sua entidade correspondente, evitando concorrência de dados.

Protheus

• Utilizar a versão 11.8 do Protheus superior.

• O Protheus deve utilizar grupo de empresas para refletir a hierarquia de empresas configurada no BackOffice RM, contendo somente um grupo e a divisão de empresas sendo representada pelo respectivo conjunto “empresa” +” unidade”.
  Exemplo:

  

• O compartilhamento de tabelas deve ser coerente com a forma como o BackOffice RM trabalha, conforme descrita tabela abaixo.

  Cadastro	Empresa	Filial	Tabela RM	Tabela Protheus
  Moeda	Compartilhado	Compartilhado	GMOEDA	CTO
  Unidade de Medida	Compartilhado	Compartilhado	TUND	SAH
  Centro de Custo	Exclusivo	Compartilhado	GCCUSTO	CTT
  Projeto	Exclusivo	Exclusivo	MPRJ	AF8
  Obra	Exclusivo	Exclusivo	MTAREFA	AFC
  Tarefa	Exclusivo	Exclusivo	MTAREFA	AF9
  Etapa	Exclusivo	Exclusivo	MTAREFA	AFC
  Condição de Pagamento	Exclusivo	Compartilhado	TCPG	SE4
  Produto	Exclusivo *	Compartilhado	TPRODUTO	SB1
  Cliente/Fornecedor	Compartilhado **	Compartilhado	FCFO	SA1 (Cliente) e SA2 (Fornecedor)
  Patrimônio	Exclusivo	Exclusivo	IPATRIMONIO	SN1
  Funcionário	Exclusivo	Compartilhado	PFUNC	SRA | SRF | SR3 | SR7
  Local de Estoque	Exclusivo	Exclusivo	TLOC	NNR

  * Independentemente se for utilizado produto global no RM, a tabela referente no Protheus deve ser exclusiva por empresa, ficando a cargo do RM replicar os produtos globais para cada filial no Protheus.
  ** Mesmo que a empresa não utilize Cliente/Fornecedor global no RM, deve-se compartilhar a tabela referente no Protheus por empresa. Será enviado concatenado ao código do cliente/fornecedor o código da coligada, conforme a mascara “[CODCOLIGADA]|[CODCFO]”.

• Configuração dos adapters utilizados na integração TOTVS PROTHEUS  x BackOffice RM, assim como toda a configuração do EAI Protheus.
  • Acessar o SIGACFG
  • Ambiente  > Schedule > Adapter E.a.I.
  • Incluir uma nova Rotina  para os adapters do  sistema Protheus
  • Configurar a Rotina do Adapter  de acordo com  os dados abaixo fornecidos  e que já foram pré estabelecidos  na aplicação do patch de atualização do Protheus:

• 

  • Acessar o SigaCFG
  • Ambiente > Cadastros > Parametros

• Configurar os parâmetros abaixo no Protheus para a integração do BackOffice RM x Protheus

a)       MV_EAIURL2

Host do RM configurado (Procedimento futuro) 

2.       MV_EAIMETH

Método padrão 

3.       MV_EAIUSER

4.       MV_EAIPASS

.       MV_EAIPORT

po          Porta padrão

Protheus

Visando maior facilidade na implantação da integração está disponível abaixo um CheckList com os passos padrão necessários para implantação e parametrização da integração no Protheus. 

Neste passo, vamos realizar a configuração HTTP por parte do Protheus, bem como configurar os Adapters e Rotas para comunicação com RM via EAI. 

• Utilizar um ambiente Protheus existente.

• Na pasta bin, editar o arquivo appserver.ini

Incluir o seguinte bloco para conexão web service Protheus:

;================== webservice ========================

[HTTP]

ENABLE=1

PORT=12001                                        ;definir porta para http Protheus

PATH=\web\WS

ENVIRONMENT=p12117                   ;ambiente

RESPONSEJOB=JOB_WS_0101

;webservice para o MU usando o nome

 [LOCALHOST:12001]                         ;webservice para o MU

ENABLE=1

;PATH=M:\Protheus11\web\WS

ENVIRONMENT=p12117

INSTANCENAME=JOB_WS_0101

RESPONSEJOB=JOB_WS_0101

DEFAULTPAGE=wsindex.apw

[JOB_WS_0101]                                 ;webservice para o MU

TYPE=WEBEX

ENVIRONMENT=p12117

INSTANCES=1,10

SIGAWEB=JOB_WS_0101

INSTANCENAME=JOB_WS_0101

ONSTART=__WSSTART

ONCONNECT=__WSCONNECT

XMLSAVEALL=1

namespace=http://www.totvs.com.br/rm/

trace=1

• Subir o serviço ambiente Protheus.
• Verificar acesso ao Host no caminho: http://localhost:12001/
• Será utilizado o método EAI SERVICE: http://localhost:12001/EAISERVICE.apw?WSDL

Exemplo: http://localhost:12001/EAISERVICE.apw?WSDL

• Realizar a configuracao dos parâmetros listados anteriormente.

•  Ainda no SIGACFG, acessar a rotina de Schedule e realizar os seguintes cadastros: 

• Cadastro de Rotas EAI (será feita uma única vez) 
  
  

*URL (Método Host do RM – Service EAI RM)

*Usuário e senha RM

*Cliente WS e método (padrão) 

• Adapter EAI (É feita para cada rotina integrada ao RM)
  
  

*Mensagem única – Sim

*Rotina a ser integrada (exemplo clientes)

*Envia mensagens – Sim

*Recebe mensagem - Sim

*Método - Síncrono

*Canal de envio – EAI

*Versão de envio (de acordo com RM)

*Rota padrão (de acordo com parâmetros)

*Roteamento de mensagens – Apontar Rota e envia – Sim. 

*Funcionários 

*atenção na versao de envio utilizada.

Acessando http://api.totvs.com.br/#/ , é possivel veriricar a lista de servicos referentes a integração bem como as entidades (transactionID) e as versoes liberadas referentes ao RM, no menu > mensagem padronizada. 

• Schedule (verificação futura do monitor de comunicação de EAI entre os sistemas.

*clicando na lupa, e possivel ver o log de execução das mensagens. 

• Emp. Filial Mensagem Única (de para de empresas para referência ao RM) 

Será feita a referencia de empresas ao RM.

*empresa/filial – referentes a RM.

*grupo empresa/Filial Protheus - referentes a RM.

*Mais informaçõesno tópico: Transações/Entidades/Mensagens únicas

RM

Utilizado um banco de dados e uma Biblioteca de teste para simulacao do Ambiente. (Verificar padrões RM de acordo com Cliente e o administrador responsável do local a ser implementado) 

Passos para uma montagem de um ambiente teste: 

Local dos arquivos demo: \\engenharia.bh01.local\Publicado\12.1\12.1.17

Passo 1: Instalar uma base de dados RM 

a)      Executar o setup Base de Dados SQL - 12.1.17.msi

b)      No caminho apontado no setup da base, usar o arquivo exemplo “.bak”.

c)       Caminho: C:\TOTVS\CorporeRM\BaseDados\SQL\EXEMPLO12117.

d)      No SQL, restaurar o arquivo exemplo. 

e)      Apontar o arquivo. bak no dispositivo de origem. 

Passo 2: Instalar Biblioteca RM

a)      Executar o setup BibliotecaRM - 12.1.17.msi

b)      Seguir os passos a passos padrões do assistente.

c)       Avançar e aceitar os termos de uso.

d)      Marcar opção de Usuário (aceitar todos usuários da máquina).

e)      Criar uma pasta padrão no “C: TOTVS/CorporeRM” e apontar a instalação nela.

f)       A instalação padrão incluirá o RM.Host.Service.exe na lista de serviços do Windows, com start automático na porta padrão 8050.

OBS: Ver passo para configuração de Host.

g)      Além do serviço, e possível subir o host do ambiente RM pelo executável RM.HOST.EXE (na pasta C:\TOTVS\CorporeRM\RM.Net).

h)      Neste ponto o RM.EXE já pode ser executado. 

• Configurando Host RM:

a)      Editar os arquivos de configuração de Host para comunicação do XML entre sistemas.

b)      Replicar as alterações de Host do RM.HOST.SERVICE.EXE.CONFIG para o arquivo RM.HOST.EXE.CONFIG (caso suba o ambiente pelo executável) 

• Seguir o seguinte modelo para configuração do Host RM:

<?xml version="1.0" encoding="utf-8"?>

<configuration>

                <appSettings>

                               <add key="JobServer3Camadas" value="false" />

                               <add key="Port" value="8050" />

                               <add key="Host" value="localhost" /> 

                               <add key="SERVICESHOSTNAME" value="localhost" />

                               <add key="HTTPPort" value="8051" />

                               <add  key="ActionsPath" value="C:\totvs\CorporeRM\RM.Net;C:\totvs\CorporeRM\Corpore.Net\Bin" />

                               <add key="LibPath" value="C:\totvs\CorporeRM\RM.Net" />

                               <add key="EnableDynamicLocalization" value="false" />

                               <add key="EnableCompression" value="false" />

                               <add key="LocalizationLanguage" value="pt-BR" />

                                <add key="defaultdb" value="CorporeRM" />

                                 <add key="FrameHTMLUser" value="mestre" />

                                 <add key="FrameHTMLPassword" value="totvs" />

                </appSettings>

                <runtime>

                               <gcServer enabled="true" />

                </runtime>

</configuration>

• Check:

1. Checar as tags marcadas em negrito conforme configuração local.
2. Usuário e senha de acordo com usuário administrador do RM
3. Definir uma httpporta diferente para o serviço e host pelo executável. 

• Após subir o ambiente, verificar o acesso ao Host no browser de internet: http://localhost:8051/wspageindex/

*Criação feita em ambiente local, alterar “localhost” para local especifico. O restante refere-se aos métodos default.  

Será utilizado o método EAI SERVICE para comunicação com o Protheus. 

Abrindo RM:

Utilizado um usuário padrão de testes. 

Usuário: mestre

Senha:  totvs

Para primeiro acesso deve ser configurado o alias clicando no botão ao lado. 

• Ver permissões:

Menu > Serviços globais > ver permissões em perfis e Usuário

• Acessar guia segurança.

 Opção Perfis. 

Neste caso, o usuário possui perfis de acesso DBA e DP.

Criar um perfil adicional

Exemplo Perfil mestre: 

Clicar em incluir.

Identificação: 

Nesta parte e possível delegar acessos a campos e menus.

*Verificar com o Administrador do RM, o acesso as rotinas que serão integradas leitura e gravação e também a opção de Integrações do menu. 

*permitido acesso a todos serviços para o usuário Mestre.

• Opção Usuários.

Localizar e editar o usuário.

Identificação: 

 Associar os perfis, na aba Segurança: 

• Menu Integração

• Acessar a guia EAI 2.0

Nesta área, será feita a configuracao dos seguintes itens:

-          Aplicativos

-          Transações

-          Rotas (Transação/App)

-          De/Para

• Aplicativos 

Incluir um aplicativo de conexão para o Protheus e RM. 

*Será apontado o Host de comunicação do protheus para o RM

*Utilizado coligadas por Empresa.

Criado um aplicativo para o próprio RM.

*Host do RM

*usuário de autenticação RM.

*aplicativo interno. 

• Transações

Será configurado cada entidade que fará a comunicação entre os módulos. 

*Suportado – forma de envio.

*mensagem síncrono.

*compartilhamento das tabelas. 

• Anexos> versão. 

Incluir. 

Definir a versão que sera utilizada.

*de acordo com a versão XSD de mensagens homologadas. http://api.totvs.com.br/#/

• Rotas

Definição das Rotas de comunicação. 

*Aplicativo - Apontar o aplicativo de comunicação 

*Trasação – Rotina RM que sera comunicada.

*habilitação – Forma de envio 

*Por padrão funcionários por parte do RM esta habilitado para somente recebimento. 

• De/Para
  
  

Cadastramos o de/para por parte do RM, similares ao Protheus, referenciando as Coligadas.

Os passos a seguir devem se repetir para todas as coligadas e filiais.

Efetue o cadastramento do De-Para de Coligadas conforme imagem abaixo, substituindo os valores entre chaves com o valor correspondente pelo código da coligada.

Tabela RM: Fixo valor 'GCOLIGADA'

Chave Primária RM: Fixo valor 'CODCOLIGADA'

Valor Chave Primária RM: Código da coligada referente

Sistema Integrado: Fixo valor 'PROTHEUS'

Valor Chave Integração: Código da coligada referente (mesma do campo Valor Chave Primária RM)

Efetue o cadastramento do De-Para de Filiais conforme imagem abaixo, substituindo os valores entre chaves com o valor correspondente ao descrito internamente a ele.

 Tabela RM: Fixo valor 'GFILIAL'

 Chave Primária RM: Fixo valor 'CODCOLIGADA|CODFILIAL'

 Valor Chave Primária RM: Código da coligada + '|' + Código da filial

 Sistema Integrado: Fixo valor 'PROTHEUS'

 Valor Chave Integração: Código do grupo de empresa do Protheus + '|' + Código completo da filial no Protheus (composto por Empresa + Filial)

• Gerenciamento de Mensagens (por parte do RM) 

Acompanhamento das mensagens de entrada e saída.

Bem como, os dados da Mensagem, Rota e execução.

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 BackOffice RM,  Backoffice Protheus e SigaMNT estarão aptas a fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.

Escopo

O escopo deste projeto se restringe aos processos de integração com o Protheus e os cadastros utilizados por estes.

Todos os processamentos de BackOffice se manterão no RM, sendo eles a geração de escrituração, relatórios, emissão de notas fiscais e outros.

Transações/Entidades/Mensagens únicas

Segue abaixo tabela com informações sobre as entidades trafegadas na integração.

Obs.: As Fórmulas visuais estão disponíveis na pasta de instalação do RM em (...CORPORERM/Objetos Gerenciais/Fórmulas Visuais)

Cadastros

Para esta integração todos os cadastros possuem sua origem no BackOffice RM, sendo enviados à retaguarda Protheus.

Cadastro de Centro de Custo

Identificador da Mensagem: CostCenter
Versão: 2.000
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos: http://tdn.totvs.com/x/w9b0E

Notas: 

Cadastro de Cliente/Fornecedor

Identificador da Mensagem: CustomerVendor
Versão: 2.002
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos: http://tdn.totvs.com/x/MYP6E

Notas: 

Cadastro de Cargo

Identificador da Mensagem: EmployeePosition
Versão: 1.000
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos: http://tdn.totvs.com/x/04P6E

Cadastro de Função

Identificador da Mensagem: Role
Versão: 1.000
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos: http://tdn.totvs.com/x/7IP6E

Cadastro de Funcionário

Identificador da Mensagem: Employee
Versão: 2.001
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos: http://tdn.totvs.com/x/9Yv6E

Notas:

Links úteis de Refências 

 Abaixo, alguns links para visualização sobre a configuração validada em cliente para os mesmos cadastros citados nesta documentação.

Como funciona a camada EAI.

Checklist de suporte da aplicação

Crie um check-list de verificação de alguns pontos importantes para o funcionamento e atendimento da integração.

Instalação/Configuração

Relacione itens de verificação para garantir que a integração está corretamente instalada e configurada. Isto não pode ser uma cópia do procedimento de instalação/configuração, mas verificações pontuais que podem remeter aos itens da instalação.

Checklist de Verificações:

Relacione itens de verificações para que o atendente possa:

Identificar o funcionamento da integração;

Identificar a ocorrências de problemas;

Coletar evidências do mau funcionamento relatado pelo cliente;

Realizar possíveis ajustes na integração quanto à configuração ou negócio.