INTEGRAÇÃO TOTVS PDV X BackOffice RM 

Contexto de negócio

O objetivo da integração do PDV Protheus x BackOffice RM é viabilizar que de forma automática os cadastros gerenciados pelo BackOffice sejam replicados no vertical e, de forma similar, que os processos geridos pelo PDV Protheus tenham suas informações levadas ao BackOffice. Desta forma as bases de dados se mantém espelhadas, atualizando estoque, permitindo emissão de notas fiscais e demais processos no BackOffice.

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:
  • SigaFrt - Vertical responsável pela emissão dos Cupons Fiscais, Cancelamento de vendas e ReduçãoZ.
  • SigaLoja - Módulo de Retaguarda do Protheus, responsável pela comunicação com o BackOffice RM.
• BackOffice RM através dos seguintes módulos:
  • TOTVS Gestão de Estoque, Compras e Faturamento (RM Nucleus): BackOffice utilizado pelo cliente, sendo responsável pela manutenção dos cadastros, gestão de estoque, integrações Fiscais, financeiras e demais processos da empresa.
  • TOTVS Business Connect: Módulo responsável pelos WebServices e Framework de Integração.

  
  

Integração

Para atender a demanda de clientes que possuem o BackOffice RM e necessitam de uma solução para controle de frente de loja foi desenvolvida esta integração, que possibilita a gestão das vendas a partir do módulo correspondente do Protheus, 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 Protheus + TIN).

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 únicos 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.
• Caso existam processos a serem executados de forma assíncrona é importante que o WebServices e os serviços de cada módulo estejam disponíveis durante o agendamento destes processos.
• 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 BackOffice RM x PDV Protheus (Novo Modelo) por meio do TBC (Integração / Ferramentas / Configuração) na versão 12.1.10 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 12.1.8 do Protheus superior.
• Configuração dos adapters utilizados na integração TOTVS PDV 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:
    • Mensagem única: Sim
    • Rotina: Nome do adapter  com a ultima letra  referenciando o programa (A)
    • Mensagem: Nome da mensagem única  que o Adapter EAI  espera receber.
    • Descrição: Identificação da mensagem
    • Recebe: SIM
    • Método: Síncrono/Assincrono
    • Operação: TODAS

    • Canal de Envio  : EAI

      Mensagem Única	Rotina Protheus	Mensagem	Descrição	Envia	Recebe	Método Protheus	Operação	Canal de Envio	Adapter Protheus	Versão
      Sim	MATA010	Item	Produto	Não	Sim	Síncrono	Todas	EAI	MATI010	4.005
      Sim	MATA030	CustomerVendor	Cliente	Nâo	Sim	Síncrono	Todas	EAI	MATI030	2.002
      Sim	AGRA045	Warehouse	Armazéns de Estoque	Não	Sim	Síncrono	Todas	EAI	AGRI045	1.001
      Sim	QIEA030	UnitOfMeasure	Unidades de Medida	Não	Sim	Síncrono	Todas	EAI	QIEI030	2.002
      Sim	LOJA121	ListOfStationSalePoint	Lista de Estações de Trabalho	Não	Sim	Síncrono	Todas	EAI	LOJI121	1.000
      Sim	MATA040	Seller	Vendedor	Não	Sim	Síncrono	Todas	EAI	MATI040	2.001
      Sim	LOJA070A	PaymentMethod	Forma de Pagamento/Adm. Fin.	Não	Sim	Sincrono	Todas	EAI	LOJI070	1.000
      Sim	LOJA701	RetailSales	Vendas Varejo	Sim	Não	Sincrono	Todas	EAI	LOJI701	12.001009
      Sim	LOJA160	Reduction	Redução Z	Sim	Não	Sincrono	Todas	EAI	LOJI160	1.001

• Caso a integração via ESB tenha sido implantada anteriormente no cliente é necessário efetuar a configuração de novo ambiente Protheus a partir de ambiente vazio.
  • Todos os cupons fiscais e ReduçõesZ devem ser integrados ao BackOffice RM e a base de dados Protheus seja salva somente em caráter de Backup.
  • O novo ambiente Protheus deve ser iniciado a partir de ambiente vazio, evitando assim problemas de relacionamento De-Para ou registros existentes do Protheus que não tenham equivalente no RM.
• Obrigatoriamente o ambiente Protheus deve possuir controle por Grupo de Empresa, mantendo a seguinte disposição:
  • O ambiente deve possuir somente um Grupo de Empresas.
  • Devem haver tantas empresas quanto coligadas no RM.
  • Não deve haver controle por unidade no Protheus.
  • Devem haver tantas Filiais quanto existirem no RM.

• Os cadastros mantidos pelo RM devem possuir no Protheus o mesmo compartilhamento por empresa e filial, descrito na tabela abaixo:

  Cadastro	Grupo de Empresa	Empresa	Filial
  Cliente	Exclusivo	Compartilhado	Compartilhado
  Estação	Exclusivo	Exclusivo	Compartilhado
  Forma de Pagamento	Exclusivo	Exclusivo	Compartilhado
  Local de Estoque	Exclusivo	Exclusivo	Exclusivo
  Produto	Exclusivo	Exclusivo	Compartilhado
  Unidade de Medida	Exclusivo	Compartilhado	Compartilhado
  Vendedor	Exclusivo	Exclusivo	Compartilhado

Instalação/Atualizaçã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. 

RM

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

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.

Escopo

O escopo deste projeto se restringe aos processos de venda gerenciados pelo PDV 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.

Escopo de cadastros

A integração é responsável pela replicação dos cadastros efetuados no BackOffice RM no módulo de retaguarda de vendas do Protheus (SigaLoja) de forma transparente ao usuário final, estando fora do escopo deste projeto toda e qualquer alteração nos processos de carga entre a retaguarda e o PDV Protheus.

O escopo dos cadastros se restringe aos necessários para utilização nos módulos de venda, listados na seção Transações/Entidades/Mensagens.

Escopo dos processos

O escopo da integração se restringe aos processos relacionados a venda que sejam pertinentes de manipulação no BackOffice, que são a integração dos dados de Cupom Fiscal e ReduçãoZ, pra posterior geração de Nota Fiscal e escrituração.

O módulo de retaguarda de vendas do Protheus (SigaLoja) deve ser utilizado somente como meio de integração dos sistemas de frente de loja com o BackOffice RM, não devendo o mesmo ser utilizado para nenhum processamento de dados, integração fiscal ou geração de relatórios.

O fluxo de integração de processos tem origem nos módulos de Frente de Loja do Protheus, sendo integrada de forma nativa para a Retaguarda de vendas Protheus, mas estando esta parte fora do escopo da integração com BackOffice RM. O escopo deste projeto se restringe à integração da Retaguarda de vendas Protheus para o BackOffice RM.

O escopo de integração dos processos se restringe aos listados na seção Transações/Entidades/Mensagens.

Contra Escopo

Somente os processos e cadastros listados na seção Transações/Entidades/Mensagens fazem parte do escopo da integração, devendo os demais terem suas permissões restritas ou serem executados isoladamente, sendo esta segunda opção não aconselhável e não analisada neste projeto.

Segue abaixo lista de processos não contemplados na integração disponível:

1. Consulta de Estoque no terminal do PDV.
2. Sangria e suprimento de caixa no PDV.
3. Processo de troca ou devolução no PDV.

Obs.: Os processos listados acima estão mapeados para desenvolvimento em ciclo futuro.

Transações/Entidades/Mensagens únicas

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

Observações:

• A nomenclatura das Fórmulas Visuais de gatilho ainda se encontram em definição pela equipe de qualidade. Caso necessário entre em contato com o suporte para obtê-las.
• A partir da versão RM 12.1.20, a integração passa a utilizar nova versão de mensagem para entidade Produto (Item 4.005). Para maiores informações de como atualizar sua integração consulte o documento técnico 1331649 MATESTCNTFTOF01-1147 DT Campo tributação do CF no Cadastro de Produto por filial

Fluxo das Informações

Fluxo de integração de Cadastros 

O fluxo de integração de cadastros tem origem no BackOffice RM, mandatário das informações, sendo enviado para a retaguarda de vendas Protheus, para posterior carga nos Pontos de Venda, conforme descrito no diagrama abaixo.

Fluxo de integração de Processos

Conforme descrito na sessão Escopo dos processos, é apresentado abaixo todo o fluxo de integração de processos, mas o limite de integração RM e Protheus se restringe à comunicação entre a Retaguarda de vendas Protheus com o BackOffice RM.

Vide diagrama abaixo com fluxo completo de informações.

Cadastros

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

Após a implantação deve-se remover as permissões de alteração dos cadastros listados abaixo no Protheus, visto que estes devem ser mantidos no BackOffice, com exceção aos campos do cadastro de Estação que por definição devem ser parametrizados no Front Loja.

Cadastro de Clientes

Identificador da Mensagem: CustomerVendor

Versão: 2.002

Mandatário: BackOffice RM

Tipo de Envio: Síncrono

Especificações  BackOffice RM: ER_PCREQ-7772_Integracao_Cliente_CustomerVendor

Notas: 

• Em exceção aos outros cadastros, o gatilho de integração de Clientes é interno ao seu objeto de negócio, tendo sua fórmula visual com objetivo de contra-gatilho. Assim sendo, a integração será disparada mesmo sem a Fórmula Visual ter sido importada. 
• Mesmo que a empresa não utilize Cliente/Fornecedor global no RM, deve-se compartilhar a tabela referente no Protheus por empresa uma vez que a informação da Coligada do registro (global ou não) é mapeada para o campo loja do Protheus..

Cadastro de Locais de Estoque

Identificador da Mensagem: Warehouse

Versão: 1.000

Mandatário: BackOffice RM

Tipo de Envio: Síncrono

Especificação BackOffice RM: ER_PCREQ-7807_Local de Estoque - Warehouse

Notas: 

Cadastro de Meios de Pagamento

Identificador da Mensagem: PaymentMethod

Versão: 1.000

Mandatário: BackOffice RM

Tipo de Envio: Síncrono

Especificação BackOffice RM: ER_PCREQ-7809_Administradora Financeira / Forma de Pagamento

Notas: 

• Deve-se verificar a especificação completa para compreensão do modelo de relacionamento entre Administradoras Financeiras do Protheus com os Meios de Pagamento do RM.
• Visto que a base Protheus possui carga com formas de pagamento padrão (obrigatoriamente constam na base de dados) estes registros não poderão ser alterados e excluídos. Vide especificação para detalhes.
  
  
  

Cadastro de Produtos

Identificador da Mensagem: Item

Versão: 4.005

Mandatário: BackOffice RM

Tipo de Envio: Síncrono

Especificação BackOffice RM: ER_PCREQ-7797_Integração_Produto - Item

  ER_PCREQ-7798_Integração_Código de Barras

Notas: 

• A mensagem de Produtos trafega juntamente a lista de códigos de barras relacionados ao registro.
• Caso o cadastro de Tributações ECF não siga o padrão definido pelas impressoras fiscais é necessário efetuar o ajuste destas informações anteriormente ao sincronismo ao Protheus. Vide especificação para detalhes.
• A partir da versão RM 12.1.20, a integração passa a utilizar nova versão de mensagem para entidade Produto (Item 4.005). Para maiores informações de como atualizar sua integração consulte o documento técnico 1331649 MATESTCNTFTOF01-1147 DT Campo tributação do CF no Cadastro de Produto por filial

Cadastro de Pontos de Venda (Estação)

Identificador da Mensagem: ListOfStationSalePoint

Versão: 1.000

Mandatário: BackOffice RM

Tipo de Envio: Síncrono

Especificação BackOffice RM: ER_PCREQ-7799_Estacao 

Notas: 

• Os campos enviados do RM para o PROTHEUS não poderão ser alterados no PDV.
• Conforme uso normal do FrontLoja, o usuário deverá acessar o cadastro de Estação no mesmo para efetuar as configurações referentes aos periféricos agregados, como Impressora Fiscal, PinPad, Leitor de Código de Barras e demais. 
  
  

Cadastro de Unidades de Medida

Identificador da Mensagem: UnitOfMeasure

 Versão: 2.000

Mandatário: BackOffice RM

Tipo de Envio: Síncrono

Especificação BackOffice RM: ER_PCREQ-7808_Unidade de Medida - UnitOfMeasure

Notas: 

• Apesar de não obrigatório, é aconselhável que todas as unidades de medida padrão do Protheus sejam cadastradas no RM.
• Para os cadastros de Unidade de Medida que possuam código de tamanho maior que o permitido no Protheus é aconselhável o cadastramento manual do registro e na tabela De-Para do Protheus, solicitando posterior integração no RM para atualizar os demais dados.

Limitações/Restrições

Processos

Conforme descrito na seção de apresentação do escopo, o escopo da integração se restringe aos processos relacionados a venda que sejam pertinentes de manipulação no BackOffice, como integrações fiscais, financeiras ou controle de estoque.

Abaixo são listados os processos integrados.

Cupons Fiscais

Tipo de Fluxo: Protheus -> RM

Mensagem: RetailSales

Versão: 12.001 009 (Necessário versão igual ou superior a 2.007 para utilizar cupom NFC-e)

Especificações BackOffice RM:

ER_PCREQ-8877_Venda

ER_PCREQ-8878_Cancelamento de Venda de Cupom Fiscal

Notas:

• Vide especificação para melhores informações sobre restrições e pontos de atenção do processo de integração de Cupons Fiscais.
• SAT está disponível a partir do release 12.1.14.
• NFC-e está disponível a partir do release 12.1.23.

Redução Z

Tipo de Fluxo: Protheus -> RM

Mensagem: Reduction

Versão: 1.001

Especificações BackOffice RM: ER_PCREQ-8879_Mapa Resumo (Redução Z)

Notas:

• Vide especificação para melhores informações sobre restrições e pontos de atenção do processo de integração de Redução Z.
• Para acessar a especificação do Protheus, acesse: Especificação Integração RM x Protheus

Limitações/Restrições

Limitações / Restrições Gerais

Situações comuns (opcional)

Descreva situações problemáticas comuns que podem ocorrer durante o funcionamento da integração e como solucioná-los. Neste ponto também é importante dar instruções de como reconhecer e investigar problemas que podem vir a ocorrer durante a integração. Se houver, apresente tabelas de códigos e descrições de erros que a integração poderá apresentar.

Este tópico possivelmente será alimentado com as experiências durante o desenvolvimento da integração e poderá ser realimentado durante o uso da integração no cliente.

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.

Anexos

Âncora
Configuração da integração Configuração da integração

Configuração da integração

Siga os passos abaixo para efetuar a instalação e configuração da integração.

1. Acesse o contexto de integração.
   
   
   
2. Executar o processo 'Configurar' na aba 'Ferramentas'.
   
   
   
3. Selecionar o pacote de integração 'BackOffice RM x PDV Protheus (Novo Modelo)" e executar o processo.
   
   
   
   
4. Acessar a rotina "Integrações" e parametrizar o campo 'URL WebService" com o caminho do WebService do Protheus.
   
   
   
   
5. Acessar o anexo "Parâmetros de Integração"
   
   
   
   
6. Configure o parâmetro "CodClassificPais" com o código da tabela de classificação utilizada e associada aos países referente à classificação do IBGE.
   
   
   

Âncora
Configuração da parametro rateio Configuração da parametro rateio

Configuração do parâmetro "Calcula Rateio Cupom Fiscal considerando Valor Líquido"

Acesse o contexto do TOTVS Gestão de Estoque, Compras e Faturamento

Acesse a rotina de parâmetros de estoque na aba "Ambiente"

No processo '04.03.04 - Frente de Loja' marque o parâmetro 'Calcula Rateio Cupom Fiscal considerando Valor Líquido'

Âncora
Cadastrar De-Para Cadastrar De-Para

Cadastrar De-Para de Empresas e Filiais

Acesse a rotina de cadastramento de De-para no contexto de Integração

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)

Âncora
Importacao de Formulas Visuais Importacao de Formulas Visuais

Importação de Fórmulas Visuais

A lista de Fórmulas Visuais referente a cada entidade encontra-se na seção Transações/Entidades/Mensagens.

As Fórmulas Visuais informadas na tabela estão disponíveis na pasta "" e devem ser importadas conforme apresentado no documento Importação\Exportação de fórmula visual, com atenção à importação dos gatilhos (caso contrário a mesma não será acionada).

Âncora
Execução de Formulas Visuais Execução de Formulas Visuais

Execução de Fórmulas Visuais de Carga de Dados

Segue abaixo a lista de passos para efetuar a Carga de Dados entre o BackOffice RM e o Protheus.

Acessar o processo "Executar" no caminho "Gestão -> Fórmula Visual"

Selecionar a Fórmula Visual de carga desejada e clicar no botão "Executar"

Após a execução é necessário acessar o arquivo de Log para verificação do status dos envios para o Protheus.
O Log estará disponível na pasta "Carga Inicial / Logs" dentro do diretório de instalação do RM (RM.Net).

Configuração do ambiente Sigaloja Protheus

1. Para cadastro dos adapter, acessar o modulo Sigacfg e em seguida acesse: Ambiente > Schedule > Adapter E.a.i

2. Para cadastro de De/para empresa/filial acesse o modulo Sigacfg e em seguida acesse: Ambiente > Schedule > Emp. filial mensagem única

3. Para acessar o monitor de E.a.i do Protheus acesse o modulo Sigacfg e em seguida acesse: Ambiente > Schedule > Schedule e clique na opção EAI

4. Para acessar a rotina LOJA2142 cadastro de relacionamento das TES, acesse o modulo Sigaloja e em seguida acesse: Atualizações > Integração > Configuração padrão

5. No appserver.ini do Sigaloja, ativar o Job LJISENDEAI conforme mostra imagem abaixo

Obs.: o Parm1 deve-se informar a empresa e o Parm2 deve-se informar a filial do Protheus.