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. 

Âncora
Sistemas Envolvidos Sistemas Envolvidos

Sistemas Envolvidos

Descrição dos sistemas envolvidos no contexto de negócio (e que serão envolvidos na 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:

...

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.

...

• 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:

• Âncora
  Configurar os Parametros Protheus Configurar os Parametros 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

Image Modified

Host do RM configurado (Procedimento futuro) 

2.       MV_EAIMETH

Image Modified

Método padrão 

3.       MV_EAIUSER

Image Modified

4.       MV_EAIPASS

Image Modified

.       MV_EAIPORT

Image Modified

po          Porta padrão

Âncora
CheckList Protheus CheckList Protheus

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.

...

ENVIRONMENT=p12117                   ;ambiente

RESPONSEJOB=JOB_WS_0101 

;webservice para o MU usando o nome

...

RESPONSEJOB=JOB_WS_0101

DEFAULTPAGE=wsindex.apw

[JOB_WS_0101]                                 ;webservice para o MU

...

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

trace=1;WEBSERVICELocation=http://SPOD2896:86

;URLLocation=http://SPOD2896:86

;WEBSERVICELocation=http://SPON5101:81

;URLLocation=http://SPON5101:81

• 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: 

Image Modified

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

Image Modified

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

...

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

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

Image Modified

*Mensagem única – Sim

...

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

Image Modified

*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.  

Image Modified

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

Image Modified

**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) 

Image Modified 

Será feita a referencia de empresas ao RM.

...

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

Âncora
CheckList RM CheckList RM

RM

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

...

Passo 1: Instalar uma base de dados RM  

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

...

d)      No SQL, restaurar o arquivo exemplo.  

Image Modified

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

Image Modified

Passo 2: Instalar Biblioteca RM 

a)      Executar o setup BibliotecaRM - 12.1.17.msi

...

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"?>

...

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

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

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

...

• 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

Image Modified

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

Image Modified

• Ver permissões:

...

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

Image Modified 

• Acessar guia segurança.

 Opção Perfis. 

Image Modified

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

Criar um perfil adicional 

Exemplo Perfil mestre:  

Image Modified 

Clicar em incluir. 

Image Modified

Identificação:  

Image Modified 

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. 

Image Modified

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

• Opção Usuários.

Image Modified 

Localizar e editar o usuário.

Identificação:  

Image Modified 

 Associar os perfis, na aba Segurança:  

Image Modified

• Menu Integração

...

Image Modified 

Image Modified 

• Acessar a guia EAI 2.0

...

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

-          Aplicativos

-          Transações

-          Rotas (Transação/App)

-          De/Para 

Image Modified 

• Aplicativos 

...

Image Modified

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

Image Modified 

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

...

Criado um aplicativo para o próprio RM.

Image Modified

*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.  

Image Modified 

*Suportado – forma de envio.

...

*compartilhamento das tabelas.  

• Anexos> versão. 

Incluir.  

Image Modified 

Definir a versão que sera utilizada. 

Image Modified

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

• Rotas

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

Image Modified

*Aplicativo - Apontar o aplicativo de comunicação 

...

*habilitação – Forma de envio 

Image Modified

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

Image Modified

Image Modified

• 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.

...

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

Image Modified

Image Modified

Image Modified

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.

...

 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.

Image Modified 

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

Image Modified

Âncora
Controle de Versão / Suporte / Escopo Controle de Versão / Suporte / Escopo

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 SigaMNT 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.

Âncora
Transações/Entidades/Mensagens Transações/Entidades/Mensagens

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)

Âncora
Cadastros Cadastros

Cadastros

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

...

...

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

...

Âncora
Links úteis de Refências Links úteis de Refências

Links úteis de Refências 

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

Como funciona a camada EAI.

Âncora
Checklist de suporte da aplicação Checklist de suporte da aplicação

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.

...

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

...