O objetivo da integração do TOTVS PDV x BackOffice Protheus é viabilizar que de forma automática os cadastros gerenciados pelo BackOffice sejam replicados no vertical e, de forma similar, que os processos geridos pelo TOTVS PDV 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.
Descrição dos sistemas envolvidos no contexto de negócio (e que serão envolvidos na 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.
Definição de Mensagem Única - TOTVS Message
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.
O ambiente de integração necessita, além dos pré-requisitos de cada módulo individualmente, das seguintes características:
BackOffice RM
Protheus
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 |
Este tópico tem por objetivo orientar a instalação da integração, visando o seu funcionamento completo. Instalação de produtos ou ferramentas necessárias podem referenciar outros documentos existentes, desde que estejam disponíveis no repositório de documentação da TOTVS ou sejam enviados junto com o documento da integração em si. As informações mínimas necessárias para teste tópico são:
CONSIDERO QUE SEJA VANTAJOSO UNIRMOS ESTE E OS DOIS PROXIMOS TÓPICOS EM UM ÚNICO CHECKLIST DE IMPLANTAÇÃO.
Insira aqui as informações pertinentes ao 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 RM.
CheckList de Implantação | ||
Índice | Tarefa | Anexo |
Preparação do Ambiente | ||
1 | Instalação/Atualização da Biblioteca RM |
|
1.1 | Conferir arquivos *.Config e Alias.dat | |
2 | Instalação e configuração do IIS | Manual de instalação do TBC |
3 | Instalaçã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 | |
4 | Atualização da base de dados | 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 | ||
5 | Instalação e parametrização do pacote de integração no RM | |
5.1 | Executar script de habilitação da integração no Configurador (para cliente Piloto) | |
5.2 | Executar o configurador da integração | Anexo "Configuração da integração" |
5.3 | Parametrizar a URL do WebService Protheus | |
5.4 | Parametrizar o parâmetro de integração “Código de Classificação do País” | |
5.5 | Parametrizar o Tipo de Movimento para utilizar Acréscimo e Desconto por valor (no Movimento e nos Itens) | |
5.6 | Parametrizar o Tipo de Movimento para utilizar troco | |
5.7 | Informar parâmetro geral “Calcula Rateio Cupom Fiscal considerando Valor Líquido” como verdadeiro (marcado) | |
5.8 | Cadastrar De-Para de Empresa e Filial | |
5.9 | Importar as Fórmulas Visuais de gatilho. | |
5.10 | Caso a integração via ESB esteja ativa executar os passos 5.10.X | |
5.10.1 | Desativar a integração via ESB na tela de parâmetros | |
5.10.2 | Desativar as Fórmulas Visuais da integração ESB | |
Preparação/Carga da Base de Dados | ||
6 | Cadastro 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. | |
7 | Cadastro 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 atualizados | |
7.2 | Configurar os dados referentes a impressora fiscal e demais periféricos no cadastro de Ponto de Venda no Protheus | |
8 | Cadastro 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 Pagamento | |
8.3 | Caso o cliente não deseje utilizar no Protheus as formas de pagamento padrão, deve-se efetuar a correta parametrização. | |
9 | Cadastro de Vendedores | |
9.1 | Efetuar a carga de Vendedores ao Protheus | |
10 | Cadastro 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 atualizados | |
10 | Cadastro 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 Produtos | |
11 | Cadastro 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 Clientes | |
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.
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.
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 TOTVS PDV ou ao Front Loja.
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.
Apresente quais as transações/entidades que são trocadas e quem envia a informação para quem. Pode (e recomenda-se) ter um diagrama, uma tabela ou afins que apresente este fluxo.
Relacione quais são as mensagem únicas (TOTVSMessage) utilizadas e qual o seu relacionamento com as entidades já existentes do ERPs envolvidos.
Exemplos:
Método | ID | Descrição | Origem | Destino | XSD (versões podem variar) |
Cadastros | 01 | Clientes | RM | Protheus | CustomerVendor_2_002.xsd |
02 | Locais de Estoque | RM | Protheus | Warehouse_1_000.xsd | |
03 | Meios de Pagamento | RM | Protheus | PaymentMethod_1_000.xsd | |
04 | Produtos | RM | Protheus | Item_3_004.xsd | |
05 | Pontos de Venda | RM | Protheus | ListOfStationSalePoint_1_000.xsd | |
06 | Unidades de Medida | RM | Protheus | UnitOfMeasure_2_000.xsd | |
07 | Vendedores | RM | Protheus | Seller_2_001.xsd | |
Processos | 08 | Cupom Fiscal | Protheus | RM | RetailSales_1_001.xsd |
09 | ReduçãoZ | Protheus | RM | Reduction_1_001.xsd | |
|
|
|
|
|
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_PDV_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.
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
Especificação Protheus: <SIGAXXX>
Notas:
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
Especificação Protheus: <SIGAXXX>
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
Especificação Protheus: <SIGAXXX>
Notas:
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
Especificação Protheus: <SIGAXXX>
Notas:
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
Especificação Protheus: <SIGAXXX>
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
Especificação Protheus: <SIGAXXX>
Notas:
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
Especificação Protheus: <SIGAXXX>
Notas:
Limitações/Restrições
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
Especificação Protheus: <SIGAXXX>
Notas:
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)
Especificação Protheus: <SIGAXXX>
Notas:
Limitações/Restrições
Descreva limitações e restrições para cada fluxo descrito no tópico anterior. Exemplo:
ERP1 somente enviará o ITEM se este estiver em uma das famílias cadastradas no parâmetro FAMILIA_INTEGRACAO.
Se o tipo de valorização do estoque for FIFO.
O pedido recebido no ERP1 vindo do ERP2 estará bloqueado para alteração.
Descreva os passos que viabilizem a integração.
Exemplo:
Os passos para viabilizar a integração são:
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.
Exemplo 1:
Tratamento de erros de integração (Produto A)
Erro | Mensagem | Solução |
Código do erro | Mensagem exibida | Ação a ser tomada para resolução do erro. |
Tratamento de erros de integração (Produto B)
Erro | Mensagem | Solução |
Código do erro | Mensagem exibida | Ação a ser tomada para resolução do erro. |
Exemplo 2:
Quando uma mensagem é enviada do Logix para o Protheus, podem ocorrer situações em que o WebService não estará totalmente funcional. Nestes casos uma mensagem de erro genérica irá aparecer na tela:
Exemplo:
Erro ao enviar a mensagem de Cidade via Integração
Se o arquivo de log for analisado, poderemos ver a falha na comunicação com o sistema destino:
-------------------------------------------------------------------------------
WSCERR044 / Não foi possível POST : URL http://172.16.31.57:8011/ws/FWWSEAI.apw
ADVPL WSDL Client 1.080707 / tst on 20120315 08:49:51
-------------------------------------------------------------------------------
Para resolver este problema, verifique as configurações do sistema de destino, analisando o funcionamento do servidor utilizado para esta comunicação e a habilitação do endereço do WebService.
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:
Siga os passos abaixo para efetuar a instalação e configuração da integração.