Integração BackOffice RM x SigaMNT

Contexto de negócio

O objetivo da integração do SIGAMNT 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 Gestão de Ativos/Gestão de Frotas 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).

Integração

Para atender a demanda de clientes que possuem o BackOffice RM e necessitam de uma solução para Manutenção de Ativos e Controle de Frotas foi desenvolvida esta integração, que possibilita a gestão das movimentações 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 RM + SigaMNT 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:

BackOffice RM

Protheus

Mensagem ÚnicaRotina ProtheusMensagemDescriçãoEnviaRecebeMétodo ProtheusOperaçãoCanal de EnvioAdapter ProtheusVersão
SimNGMUAmpPat ASSETSVALUATION Ampliação Patrimonial SimNãoSíncronoTodasEAINGMUAmpPat 1.000
SimNGMUAprCst APPOINTMENTCOST Apropriação de Custo SimNãoSíncronoTodasEAINGMUAprCst 1.000
SimATFA010ASSETSAtivo FixoNãoSimSíncronoTodasEAIATFA0101.001
SimNGMUStoTuO STOCKTURNOVER Baixa de EstoqueSimSimSíncronoTodasEAINGMUStoTuO 1.002
SimNGMUCanMnO CANCELMAINTENANCEORDCancelamento de OS SimNãoSíncronoTodasEAINGMUCanMnO 1.000
SimNGMUCanReqCANCELREQUEST Cancelamento de Requisição SimSimSíncronoTodasEAINGMUCanReq1.000
SimGPEA370EMPLOYEEPOSITION CargoNãoSimSíncronoTodasEAIGPEA3701.000
SimCTBA030     COSTCENTERCentro de CustoNãoSimSíncronoTodasEAICTBA030    2.000
SimMATA030CUSTOMERVENDORClienteNãoSimSíncronoTodasEAIMATA0302.002
SimMATA360PAYMENTCONDITIONCondição de PagamentoNãoSimSíncronoTodasEAIMATA3602.000
SimNGMUStoLvl STOCKLEVEL Consulta de Saldo SimNãoSíncronoTodasEAINGMUStoLvl 1.001
Sim*NGMUTRAREQTRANCEABILITYREQUESTConsulta Situação da SolicitaçãoSimNãoSíncronoTodasEAINGMUTRAREQ1.001
SimPMSA201STEPPROJECTEtapa (EDT)NãoSimSíncronoTodasEAIPMSA2012.000
SimMATA020CUSTOMERVENDORForncecedorNãoSimSíncronoTodasEAIMATA0202.002
SimGPEA030ROLE FunçãoNãoSimSíncronoTodasEAIGPEA0301.000
SimGPEA010EMPLOYEEFuncionárioNãoSimSíncronoTodasEAIGPEA0102.001
SimNGMUGETSITGETEMPLOYEESITUATIONSSituação do FuncionárioSimNãoSíncronoTodasEATNGMUGETSIT1.000
SimNGMUInfPar INFOOFPARCELVALUES Informações de Parcelas NãoSimSíncronoTodasEAINGMUInfPar1.000
SimAGRA045WAREHOUSELocal de EstoqueNãoSimSíncronoTodasEAIAGRA0451.000
SimCTBA140CURRENCYMoedaNãoSimSíncronoTodasEAICTBA1402.000
SimPMSA201SUBPROJECTObra (EDT)NãoSimSíncronoTodasEAIObra (EDT)2.000
SimNGMUOrder ORDER OrdemSimSimSíncronoTodasEAINGMUOrder 3.002
SimNGMUMntOrd MAINTENANCEORDER Ordem de ServiçoSimSimSíncronoTodasEAINGMUMntOrd 1.000
SimMATA010ITEMProdutoNãoSimSíncronoTodasEAIMATA0102.000
SimPMSA200PROJECTProjetoNãoSimSíncronoTodasEAIPMSA2002.000
SimNGMUReques REQUEST Solicitação SimSimSíncronoTodasEAINGMUReques 1.000
SimPMSA203TASKPROJECTTarefaNãoSimSíncronoTodasEAIPMSA2032.000
SimGPEA080 SHIFTWORK TurnoNãoSimSíncronoTodasEAIGPEA080 1.000
SimQIEA030UNITOFMEASUREUnidade de medidaNãoSimSíncronoTodasEAIQIEA0302.000

* Disponível a partir da versão 12.1.15.160. 

 

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. 

PENDENTE - VERIFICAR COM O PROTHEUS

CheckList de Implantação

Índice

Tarefa

Anexo

Preparação do Ambiente

1Pendente - Verificar com a equipe do 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. 

CheckList de Implantação

Índice

Tarefa

Anexo (Pendente)

Preparação do Ambiente

1

Instalação/Atualização da Biblioteca RM

 

1.1     Conferir arquivos *.Config e Alias.dat 
2Instalação e configuração do IIS
Manual de instalação do TBC 
3Instalação e configuração do TBC
3.1     Instalar o TBC na mesma versão da Biblioteca RM 
3.2     Configuração do Web.Config 
3.2.1           Configurar o Web.Config conforme o RM.Host.*.Config e Rm.Exe.Config 
3.2.2           Configurar Tag “DefaultDB” no Web.config com o Alias desejado 
4Atualização da base de dados (Caso ainda não esteja na versão necessária)Manual do RM Atualizador
4.1     Efetuar Backup da base de dados 
4.2     Executar o RM Atualizador na base de dados 
4.3     Conferir se o Dicionário de Dados do Protheus possui compartilhamento por Empresa/Filial igual ao RM para os cadastros integrados. 

Ativação da Integração

5Instalação e parametrização do pacote de integração no RM 
    Parametrizar os Tipos de Movimento utilizados na integração 
      Executar o configurador da integração

 

Anexo "Configuração da integração"

      Parametrizar a URL do WebService Protheus
     Informar os parâmetros da integração
      Cadastrar De-Para de Coligada e FilialAnexo "Cadastrar De-Para"
      Importar as Fórmulas Visuais com gatilhoAnexo "Importação de Fórmulas Visuais"

Preparação/Carga da Base de Dados

6Cadastro de Unidades de Medida 
6.1     Cadastrar no RM as unidades padrão existentes na base de dados Protheus com mesmo código ou referenciar as duas na tabela De-Para do Protheus. 
6.2     Cadastrar no Protheus o De-Para das unidades de medida padrão que possuírem códigos diferentes entre os sistemas. Ex.: Unidade ‘Jogo’ possuir código ‘Jg’ no RM e ‘JG’ no Protheus.  
6.3     Cadastrar no Protheus unidades com código intuitivo e respectivos De-Paras das unidades de medida que possuírem código maior que 2 caracteres no RM.  
 Efetuar a carga das Unidades de MedidaAnexo "Execução de Formulas Visuais"
7Cadastro de Pontos de Venda 
7.1     Caso hajam Pontos de Venda com código maior que o permitido no Protheus deve-se seguir os passos 7.1.X 
7.1.1          Cadastrar um registro referente no Protheus, somente com código e campos obrigatórios. 
7.1.2          Mapear na tabela De-Para do Protheus os Pontos de Venda com os respectivos códigos no RM. 
7.1.3          Efetuar a carga dos Pontos de Venda do RM para que os dados sejam atualizadosAnexo "Execução de Formulas Visuais"
7.2     Configurar os dados referentes a impressora fiscal e demais periféricos no cadastro de Ponto de Venda no Protheus 
8Cadastro de Formas de Pagamento 
8.1     Cadastrar no RM as formas de pagamento padrão do Protheus 
8.2     Efetuar a carga de Formas de PagamentoAnexo "Execução de Formulas Visuais"
8.3     Caso o cliente não deseje utilizar no Protheus as formas de pagamento padrão, deve-se efetuar a correta parametrização. 
9Cadastro de Vendedores 
9.1     Efetuar a carga de Vendedores ao ProtheusAnexo "Execução de Formulas Visuais"
10Cadastro de Locais de Estoque 
10.1     Caso hajam Locais de Estoque com código maior que o permitido no Protheus deve-se seguir os passos 10.1.X 
10.1.1          Cadastrar um registro referente no Protheus, somente com código e campos obrigatórios. 
10.1.2           Mapear na tabela De-Para do Protheus os Locais de Estoque com os respectivos códigos no RM. 
10.1.3          Efetuar a carga dos Locais de Estoque do RM para que os dados sejam atualizadosAnexo "Execução de Formulas Visuais"
10Cadastro de Produtos 
10.1     Cadastrar as Tributações ECF conforme códigos corretos para integração 
10.2     Atualizar o cadastro de produtos para utilizar as tributações ECF corretas 
10.3     Efetuar a parametrização no Protheus do vínculo de TES por produto 
10.4     Verificar se todos os campos obrigatórios no Protheus estão preenchidos no RM 
10.5     Efetuar a carga de ProdutosAnexo "Execução de Formulas Visuais"
11Cadastro de Clientes 
11.1     Abrir tabela de Municípios do Protheus para que a mesma receba carga automática 
11.2     Conferir se o campo A1_COD no Protheus está sem inicializador padrão 
11.3     Verificar se todos os Clientes possuem endereço cadastrado 
11.4     Efetuar a carga de ClientesAnexo "Execução de Formulas Visuais"
 

 

 

Transações/Entidades/Mensagens únicas

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

 

Método

ID

Descrição

Origem

Destino

Mensagem Única

Versão da MensagemFórmula Visual de GatilhoFórmula Visual de Carga de Dados

Cadastros

01

Unidade de Medida

RM

Protheus

UnitOfMeasure

2.000MOVWKF0017 - UnitOfMeasureMOVWKF0019 - Sincronizacao_Total_SigaMNT

02

Moeda

RM

Protheus

Currency

2.000MOVWKF0006 - CurrencyMOVWKF0019 - Sincronizacao_Total_SigaMNT

03

Centro de Custo

RM

Protheus

CostCenter

2.000MOVWKF0005 - CostCenterMOVWKF0019 - Sincronizacao_Total_SigaMNT

04

Condição de Pagamento

RM

Protheus

PaymentCondition

2.000MOVWKF0015 - PaymentConditionMOVWKF0019 - Sincronizacao_Total_SigaMNT
05Item (Produto)RMProtheusItem2.000MOVWKF0013 - ItemMOVWKF0019 - Sincronizacao_Total_SigaMNT

06

Projeto

RM

Protheus

Project

2.000MOVWKF0016 - ProjectMOVWKF0019 - Sincronizacao_Total_SigaMNT

07

Obra

RM

Protheus

SubProject

2.000MOVWKF0014 - Obra Etapa TarefaMOVWKF0019 - Sincronizacao_Total_SigaMNT
07TarefaRMProtheusTaskProject2.000MOVWKF0014 - Obra Etapa TarefaMOVWKF0019 - Sincronizacao_Total_SigaMNT
07EtapaRMProtheusStepProject2.000MOVWKF0014 - Obra Etapa TarefaMOVWKF0019 - Sincronizacao_Total_SigaMNT
08Cliente/FornecedorRMProtheusCustomerVendor2.002MOVWKF0007 - CustomerVendorMOVWKF0019 - Sincronizacao_Total_SigaMNT
11Local de EstoqueRMProtheusWarehouse1.000MOVWKF0018 - WarehouseMOVWKF0019 - Sincronizacao_Total_SigaMNT
12FuncionárioRMProtheusEmployee2.001MOVWKF0008 - EmployeeMOVWKF0019 - Sincronizacao_Total_SigaMNT
14Ativo FixoRMProtheusAssets1.001MOVWKF0002 - Assets_InclusaoAlteracaoMOVWKF0019 - Sincronizacao_Total_SigaMNT
XXXCargoRMProtheusEmployeePosition 1.000MOVWKF0025 - Sincronização de Cargo, Função e HorárioMOVWKF0025 - Sincronização de Cargo, Função e Horário
XXXFunçãoRMProtheusRole1.000MOVWKF0025 - Sincronização de Cargo, Função e HorárioMOVWKF0025 - Sincronização de Cargo, Função e Horário
XXXHorárioRMProtheusShiftwork1.000MOVWKF0025 - Sincronização de Cargo, Função e HorárioMOVWKF0025 - Sincronização de Cargo, Função e Horário

Processos

08

Cupom Fiscal

Protheus

RM

RetailSales

1.001--

09

ReduçãoZ

Protheus

RM

Reduction

1.001--

10

Cancelamento Venda/Item

Protheus

RM

RetailSales

1.001

 

 

 

 

 

 

Anexos

 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 'TOTVS Manutenção de Ativos x BackOffice RM" e executar o processo.



  4. Acessar a rotina "Integrações" (Integração | Mensagem Única | Integrações) e parametrizar o campo 'URL WebService" com o caminho do WebService do Protheus.


  5. Acessar o anexo "Parâmetros de Integração"


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


    5.2 Informe os Códigos dos Tipos de Movimento criado anteriormente para cada um dos processos que será utilizado.

    Observação: Este é apenas um exemplo, deve-se informar o Valor com o Código do Tipo de Movimento criado no ambiente do cliente.


 

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)


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 "CORPORERM | Objetos Gerenciais | Fórmulas Visuais" 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).