INTEGRAÇÃO TOTVS Message Core 

Contexto de negócio

O objetivo do pacote de integração TOTVS Message Core é disponibilizar adapters para integração dos cadastros comuns a todas as integrações, como Empresa e Filial.

Sistemas Envolvidos

Lista dos aplicativos no projeto de desenvolvimento e que disponibilizarão os Adapters de integração.

• TOTVS linha RM.
• TOTVS linha Protheus.
• TOTVS linha DataSul.
  
  

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 o pacote de integração TOTVS Message Core por meio doo menu Integração / Ferramentas / Configuração na versão 12.1.19 ou superior.
• Importação das Fórmulas Visuais de gatilhos de integração ou de carga de dados. Vide seção XXXXXanexo "Importação de Fórmulas Visuais".

Protheus

• Utilizar a versão 12.1.8 do Protheus superior.
• Configuração dos adapters utilizados na integração TOTVS Incorporação x BackOffice Protheus, 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	3.004

      Sim

      MATA030

      CustomerVendor

      Cliente

      Nâo

      Sim

      Síncrono

      Todas

      EAI

      MATI030

      2.002SimAGRA045WarehouseArmazéns de EstoqueNãoSimSíncronoTodasEAIAGRI0451.001SimQIEA030UnitOfMeasureUnidades de MedidaNãoSimSíncronoTodasEAIQIEI0302.002SimLOJA121ListOfStationSalePointLista de Estações de TrabalhoNãoSimSíncronoTodasEAILOJI1211.000SimMATA040SellerVendedorNãoSimSíncronoTodasEAIMATI0402.001SimLOJA070PaymentMethodForma de Pagamento/Adm. Fin.NãoSimSincronoTodasEAILOJI0701.000SimLOJA701RetailSalesVendas VarejoSimNãoSincronoTodasEAILOJI7011.001SimLOJA160ReductionRedução ZSimNãoSincronoTodasEAILOJI1601.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.

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

Configurar no PDV os parâmetros (MV_CLIPAD e MV_LOJAPAD) para cliente e loja padrão.12Chamar a rotina do monitor de integração ERP no menu do Sigaloja para acompanhar as vendas que integraram com o RMMonitor de integração13Configurar o JOB LJISENDEAI na chave [OnStart] do appserver da retaguarda 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 à integração dos cadastros de domínio da equipe de Framework, listados na seção Transações/Entidades/Mensagens.

Transações/Entidades/Mensagens únicas

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

Obs.: 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.

Fluxo das Informações

Fluxo de integração de Cadastros 

.

Image Removed

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.

Image Removed

Cadastros

Para esta integração todos os cadastros possuem sua origem no respectivo BackOffice, sendo enviados ao sistema de destino via Mensagem Padronizada TOTVS.

Cadastro de Empresa Empresas (Coligada)

Identificador da Mensagem: Company

Versão: 2.002

Mandatário: BackOffice

Tipo de Envio: Síncrono

Especificação Linha RM: ER_PCREQ-7772_Integracao_Cliente_CustomerVendorIntegração de Empresas - Linha RM

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

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: 

• Para o BackOffice RM o cabeçalho das mensagens de integração de Coligadas terá as informações de CompanyId e BranchId preenchido a partir do contexto de login.

Cadastro de Filiais

Cadastro de Produtos

Identificador da Mensagem: ItemBranch

Versão: 32.004001

Mandatário: BackOffice RM

Tipo de Envio: Síncrono

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

Integração

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.

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: 

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.

Cadastro de Vendedores

Identificador da Mensagem: Seller

 Versão: 2.001

Mandatário: BackOffice RM

Tipo de Envio: Síncrono

Especificação BackOffice RM: ER_PCREQ-7800_Vendedor - Seller

Notas: 

• O Protheus possui um parâmetro onde é informado o Código do Vendedor Padrão que será assumido na tela de atendimento no momento da Venda. Com isso é necessário que este Vendedor seja cadastrado no RM e o parâmetro MV_VENDPAD seja atualizado no Configurador do Protheus (SIGACFG)

de Filiais - Linha RM

Notas: 

• Para o BackOffice RM o cabeçalho das mensagens de integração de Coligadas terá as informações de CompanyId e BranchId preenchido a partir do contexto de login.

Limitações/Restrições

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

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.

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 na Linha RM

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

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.
   Image RemovedImage Added
   Image RemovedImage Added
   
   
4. Acessar a rotina "Integrações" e parametrizar o campo 'URL WebService" com o caminho do WebService do Protheus.
   
   Image Removed
   Acessar o anexo "Parâmetros de Integração"
   Image Removed
   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.
   Image Removed
   

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

Image Removed

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

Image Removed

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

Image Removed

Image Removed

1. Image Added
   
   
   

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

Image Removed

Image Removed

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)

Image Removed

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)

Image Removed

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

Image RemovedImage Added

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

Image RemovedImage Added

Configuração do ambiente

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

Image Removed

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

Image Removed

Protheus

Image Removed

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

Image Removed

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

Image Removed