Histórico da Página
INTEGRAÇÃO TOTVS
PDV X BackOffice RMMessage Core
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:
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 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.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 LOJA070 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 1.001 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.
CheckList de Implantação | ||
---|---|---|
Índice | Tarefa | Anexo |
Preparação do Ambiente | ||
1 | Configurar comunicação entre retaguarda Protheus e PDV Protheus | |
1.1 | Caso esteja utilizando TOTVS PDV, seguir a configuração conforme o anexo | Guia de configuração |
2 | No modulo do configurador Protheus, efetuar o cadastro de De/Para de empresa/filial e dos Adapters do Protheus (vide: pré-requisitos instalação/implantação/utilização) | |
3 | Configuração da carga de ambiente | Carga de ambiente |
4 | No appserver.ini da retaguarda Protheus na chave [ONStart] não deve conter o JOB LjGrvBatch | |
5 | No appserver.ini do PDV Protheus configurar a subida de vendas do PDV para a Retaguarda Protheus | |
5.1 | Caso esteja utilizando o TOTVS PDV, configurar o JOB STWUpData na chave [ONStart] | |
5.2 | Caso esteja utilizando o Front Loja, configurar o JOB FRTA020 na chave [ONStart] | |
6 | Ativar o parâmetro MV_LJRMBAC na retaguarda e pdv | |
7 | Configurar os parâmetros somente na retaguarda Protheus: | |
7.1 | MV_EAIURL2 -> Endereço do Webservices da RM | |
7.2 | MV_EAIUSER -> Usuario do Webservices da RM | |
7.3 | MV_EAIPASS -> Senha do Webservices da RM | |
8 | Cadastrar manualmente no Sigaloja as TES necessárias para realização das vendas | |
8.1 | As TES devem ser cadastradas antes de receber a carga de produto do RM | |
8.2 | Após o cadastro das TES, deve-se acessar a rotina LOJA2142 (Atualizações > Integração > Configuração Padrão) para informar em seus respectivos campos as TES de Isento, Tributado, Não Tributado, Substituição e Redução ICMS. | |
9 | Após receber o cadastro de estação do Backoffice RM, deve-se alterar o cadastro de estação no Protheus (retaguarda) incluindo os equipamentos necessários para realização das vendas no PDV Protheus, exemplo: Impressora fiscal, balança, pin-pad e entre outros. | |
10 | Após receber do Backoffice RM todos os cadastrados, efetuar a carga para os PDV's (vide item 2) | |
11 | Configurar no PDV os parâmetros (MV_CLIPAD e MV_LOJAPAD) para cliente e loja padrão. | |
12 | Chamar a rotina do monitor de integração ERP no menu do Sigaloja para acompanhar as vendas que integraram com o RM | Monitor de integração |
13 | Configurar 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.
CheckList de Implantação
Índice
Tarefa
Anexo
Preparação do Ambiente
1
Ativação da Integração
Anexo "Configuração da integração"
Preparação/Carga da Base de Dados
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 processosO 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:
- Consulta de Estoque no terminal do PDV.
- Sangria e suprimento de caixa no PDV.
- Processo de troca ou devolução no PDV.
- A integração somente efetua integração de vendas em Cupom Fiscal e SAT, não estando preparado para integração por NFC-e.
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.
Método | ID | Descrição | Origem | Destino | Mensagem Única | Versão da Mensagem | Fórmula Visual de Gatilho | Fórmula Visual de Carga de Dados |
Cadastros | 01 | Clientes | RM | Protheus | CustomerVendor | 2.002 | PENDENTE | PENDENTE |
02 | Locais de Estoque | RM | Protheus | Warehouse | 1.000 | PENDENTE | PENDENTE | |
03 | Meios de Pagamento | RM | Protheus | PaymentMethod | 1.000 | PENDENTE | PENDENTE | |
04 | Produtos | RM | Protheus | Item | 3.004 | PENDENTE | PENDENTE | |
05 | Pontos de Venda | RM | Protheus | ListOfStationSalePoint | 1.000 | PENDENTE | PENDENTE | |
06 | Unidades de Medida | RM | Protheus | UnitOfMeasure | 2.000 | PENDENTE | PENDENTE | |
07 | Vendedores | RM | Protheus | Seller | 2.001 | PENDENTE | PENDENTE | |
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 |
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
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 DI_TOTVS_Message Core_x_BackOffice_RM, é 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..
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:
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 anexo "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
- Obrigatoriamente o ambiente Protheus deve possuir controle por Grupo de Empresa, mantendo a seguinte disposição:
- O ambiente deve possuir um Grupo de Empresas para cada.
- 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.
CheckList de Implantação | ||
---|---|---|
Índice | Tarefa | Anexo |
Preparação do Ambiente | ||
1.1 | Caso esteja utilizando TOTVS PDV, seguir a configuração conforme o anexo | Guia de configuração |
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 |
Ativação da Integração RM | ||
1 | Instalação e parametrização do pacote de integração no RM | |
1.2 | Executar o configurador da integração | Anexo "Configuração da integração" |
2 | Ativação de gatilhos de Integração ou Carga de dados | Anexo "Importação de Fórmulas Visuais" |
2.1 | Efetuar o sincronismo das Coligadas e Filiais existentes na base de dados. | |
2.1.1 | Importar a Fórmula Visual de carga de dados | Vide lista de Fórmulas na seção Transações/Entidades/Mensagens |
2.2 | Executar a Fórmula Visual de carga de Coligadas e Filiais | Anexo "Execução de Formulas Visuais" |
2.2.1 | Para integração no online de Coligadas e Filiais deve-se importar as Fórmulas visuais de gatilho. | Vide lista de Fórmulas na seção Transações/Entidades/Mensagens Anexo "Importação de Fórmulas Visuais" |
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.
Âncora | ||||
---|---|---|---|---|
|
Transações/Entidades/Mensagens únicas
Segue abaixo tabela com informações sobre as entidades trafegadas na integração.
Método | ID | Descrição | Mensagem Única | Versão da Mensagem | Fórmula Visual de Gatilho RM | Fórmula Visual de Carga de Dados RM |
Cadastros | 01 | Empresa | Company | 2.002 | GLBWKF0001 - Company_Branch.TotvsWF | GLBWKF0002 - Sincronização_Company_Branch.TotvsWF |
02 | Filial | Branch | 2.001 | GLBWKF0001 - Company_Branch.TotvsWF | GLBWKF0002 - Sincronização_Company_Branch.TotvsWF |
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.
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 Empresas (Coligada)
Identificador da Mensagem: Company
Versão: 2.002
Mandatário: BackOffice
Tipo de Envio: Síncrono
Especificação Linha RM: Integração de Empresas - Linha RM
Notas:
Cadastro de Filiais
Identificador da Mensagem: Branch
Versão: 2.001
Mandatário: BackOffice
Tipo de Envio: Síncrono
Especificação BackOffice RM: Integração de Filiais - Linha RM
Notas:
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 | ||||
---|---|---|---|---|
|
Siga os passos abaixo para efetuar a instalação e configuração da integração no BackOffice RM.
- Acesse o contexto de integração.
- Executar o processo 'Configurar' na aba 'Ferramentas'.
- Selecionar o pacote de integração 'BackOffice RM x PDV Protheus (Novo Modelo)" e executar o processo.
- Acessar a rotina "Integrações" e parametrizar o campo 'URL WebService" com o caminho do WebService do Protheus.
Âncora | ||||
---|---|---|---|---|
|
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 de instalação do RM 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 | ||||
---|---|---|---|---|
|
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 Protheus
Cadastro de Produtos
Identificador da Mensagem: Item
Versão: 3.004
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.
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)
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-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
Siga os passos abaixo para efetuar a instalação e configuração da integração.
Acesse o contexto de integração.Executar o processo 'Configurar' na aba 'Ferramentas'.
Selecionar o pacote de integração 'BackOffice RM x PDV Protheus (Novo Modelo)" e executar o processo.
Acessar a rotina "Integrações" e parametrizar o campo 'URL WebService" com o caminho do WebService do Protheus.
Acessar o anexo "Parâmetros de Integração"
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.
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'
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)
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).
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
- 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.