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.
O projeto de integração tem como pré-requisito a instalação e implantação dos módulos envolvidos (TIN, Protheus e seus anexos como o TBC), assim como correta configuração do módulo de POC. (Configurações)
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 |
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 escopo de integração dos processos se restringe aos listados na seção Transações/Entidades/Mensagens.
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:
Observação: evite o uso de Prints de telas, facilitando, assim, o trabalho de tradução e versionamento deste documento.
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 | |
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 | |
3 | Instalação e configuração do TBC | |
3.1 | Instalação do 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 | |
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 | |
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.
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 | Cliente/Fornecedor | RM | Protheus | CustomerVendor_2_002.xsd |
02 | Locais de Estoque | RM | Protheus | Warehouse_1_000.xsd | |
03 | Meio de Pagamento | RM | Protheus | PaymentMethod_1_000.xsd | |
04 | Produto | RM | Protheus | Item_3_004.xsd | |
05 | Pontos de Venda | RM | Protheus | ListOfStationSalePoint_1_000.xsd | |
06 | Unidade de Medida | RM | Protheus | UnitOfMeasure_2_000.xsd | |
07 | Vendedor | 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 | |
|
|
|
|
|
Para cada fluxo de informação descreva, se necessário, alterações de comportamento que o respectivo produto irá sofrer. Por exemplo: quando o Logix recebe o PEDIDO de OUTRO ERP, este pedido não poderá ser alterado no Logix.
Liste quais as entidades integradas e como é o mapeamento entre as diferentes estruturas. Por exemplo: Classe no sistema A vira categoria no sistema B, o campo X é refletido no campo Y etc.
Liste quais transações/operações a integração fará com as entidades relacionadas. Exemplo: Insert de PEDIDO, Insert, update de ITEM, buscar saldo em estoque do ITEM no dia X ou buscar dados do FUNCIONÁRIO.
Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.
Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos
Em seguida faça uma descrição para cada um dos fluxos para cada entidade
<Transação/Entidade>
Identificador da Mensagem: <mensagem>
Versão: <versão>
Módulo <marca 1>: <BackOffice – Gestão xxxxxxx>
Módulo <marca 2>: <SIGAXXX>
Tipo de Envio: <Assíncrona/Síncrona>
Mensagem Padrão | PROTHEUS | RM | ||
Tabela | Campo | Tabela | Campo | |
Code | CTO990 | CTO_SIMB | GMOEDA | SIMBOLO * |
Description | CTO990 | CTO_DESC | GMOEDA | DESCRICAO |
Symbol | CTO990 | CTO_SIMB | GMOEDA | SIMBOLO |
Notas:
Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela
A seguir descrever as variações, particularidades da mensagem e processos (integração) de acordo com cada marca
Limitações/Restrições
Descreva limitações e restrições para a integração que está sendo descrita.
Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.
Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos
Em seguida faça uma descrição para cada um dos fluxos para cada entidade
<Transação/Processo>
Tipo de Fluxo: Protheus -> RM
Mensagem: Request_1_000
Versão: 1.000
Descrição de todo o comportamento e funcionamento do processo. Breve contexto, origem, regras, integração (geração da mensagem, envio, recebimento no destino), o quê supostamente irá ocorrer no destino, retorno, impacto, consequências, o que foi afetado, como conferir, validar, etc o retorno.
Acrescentar um diagrama do processo.
A seguir descrever as variações, particularidades da mensagem e processos (desta integração) de acordo com cada marca
Notas:
Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela
Limitações/Restrições
Descreva limitações e restrições para a integração que está sendo descrita.
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: