Histórico da Página
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico.
Informações Gerais
Especificação | |||
Produto | Varejo | Módulo | Controle de Lojas |
Segmento Executor | TOTVS Construção e Projetos | ||
Projeto1 | Integração BackOffice RM x PDV Protheus | IRM1 |
|
Requisito1 |
| Subtarefa1 |
|
Chamado2 |
| ||
Release de Entrega Planejada | 12.1.7 | Réplica |
|
País | ( X ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( ) Outro _____________. | ||
Outros | <Caso necessário informe outras referências que sejam pertinentes a esta especificação. Exemplo: links de outros documentos ou subtarefas relacionadas>. |
Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos).
Objetivo
Descrever os requisitos de negócio e técnicos da integração do BackOffice RM com foco nos cadastros e movimentos do produto PDV (Frente de Caixa) Protheus. Implementação dos Adapters de integração via Mensagem Única, viabilizando assim o CRUD completo de cadastros e movimentações por envio de mensagens de integrações.
Os módulos Protheus envolvidos nesta integração são:
- TOTVSPDV – Módulo de Frente de Caixa
- SIGALOJA – Módulo de Controle de Lojas (Retaguarda)
As vendas serão realizadas no sistema Protheus pelo TOTVSPDV que se comunica com o SIGALOJA, este se comunicará e as enviará para o Sistema RM.
Definição da Regra de Negócio
O desenvolvimento se dará em 2 fases distintas sendo elas:
Fase 1Cadastros:
Serão gerados no Sistema RM e enviados para o Sistema Protheus:
- Cadastro de Clientes
- Cadastro de Produtos/Precificação do Produto/Código de Barras do Produto
- Cadastro de Estação de Trabalho (Pdv)
- Cadastro de Vendedor
- Cadastro de Forma de Pagamento/Administradoras Financeiras
- Cadastro de Unidade de Medida
- Cadastro de Local de Estoque
Fase 2
Movimentos do Produto:
Serão gerados no Sistema Protheus e enviados para o Sistema RM:
- Cupom Fiscal;/RPS
- Cancelamento de Cupom Fiscal;/RPS
- Mapa Resumo/Redução Z (PAF-ECF)
Fase 2
- Sangria
- Suprimento de Caixa
- Consulta de Estoque
Serão gerados no Sistema RM e enviados para o Sistema Protheus:
Crédito de Devolução/Troca- Crédito de Devolução/Troca
Observações:
A fase 2 do projeto será desenvolvida posteriormente.
Observações:
As Administradoras Financeiras (SAE) deverão ser cadastradas manualmente nos sistemas RM e Protheus e deverão ter o mesmo código.
Os Operadores de Caixa deverão ser cadastrados manualmente nos sistemas RM e Protheus e deverão ter o mesmo código.
Detalhes das Integrações
Cadastro de Clientes:
O cliente (física ou jurídica) será cadastrado primeiramente no Sistema RM e em seguida enviado ao Protheus, este receberá e armazenará para ser utilizado nas movimentações, a integração será de forma síncrona. No sistema RM, cliente e fornecedor pertencem a mesma entidade, já no sistema Protheus são cadastros distintos. Será gravado no sistema Protheus apenas a entidade cliente, fornecedor não será tratado neste processo, a tag <Type> é responsável por este controle.
A integração se comportará da seguinte forma:
Customer - Será integrado cliente no Sistema Protheus
Vendor - Não haverá integração no Sistema Protheus
Both - Será integrado cliente no Sistema Protheus
Os campos necessários para o Protheus estão informados no XSD CustomerVendor_2_002.xsd.
Caso seja adicionado auto-incremento no Cadastro de Cliente (A1_COD), esta opção terá prioridade, não considerando assim o código enviado pelo sistema RM na integração.
Observações:
O Código da Coligada RM será o código da Loja do Cliente Protheus, esta informação será enviada no XML de integração. Desta forma poderá ser utilizado o mesmo código de cliente para Coligada e Globalizada RM.
Observações:
Protheus possui um código de Protheus possui um código de Cliente Padrão automático com base nos parâmetros MV_CLIPAD e MV_LOJAPAD, RM deve enviar a integração deste cliente para alimentar a tabela De-Para.
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
Cadastro de Cliente | Inclusão/Alteração/Exclusão | Protheus/SigaLoja/Atualizações/Cadastros/Clientes | - |
Os campos considerados obrigatórios no envio para o correto recebimento no PDV são:
- Código
- Loja
- Nome
- Nome Fantasia
- Endereço
- Entidade: pessoa física ou pessoa jurídica
- Município.
- Estado.
- País.
Tabelas Utilizadas
- SA1 - Clientes
Mapeamento dos Campos
- Mensagem CustomerVendor 2.002
Cadastro de Produtos/Precificação do Produto/Código de Barras do Produto:
O produto será cadastrado primeiramente no Sistema RM e em seguida enviado ao Protheus, este receberá e armazenará para ser utilizado nas movimentações, a integração será de forma síncrona.
As integrações de Unidade de Medida e Local de Estoque são pré-requisitos para a integração de Produtos e estão detalhadas neste documento.
Os campos necessários para o Protheus estão informados no XSD Item_3_004.
Nesta integração poderão ser enviados as precificações e códigos de barras do produto, segue abaixo detalhes:
- Precificação do Produto:
Os Preços de Venda do produto serão enviados através da integração de Produtos, será enviada pelo Sistema RM uma Lista com os Preços correspondentes e gravados pelo Sistema Protheus na tabela de Preços de Venda (SB0), os campos necessários estão informados no XSD Item_3_004.xsd.
Os eventos de Preços estarão relacionados com os eventos da integração do Produto da seguinte forma:
- Inclusão de Produto:
Todos os Preços relacionados ao Produto que forem enviados serão incluídos - Alteração do Produto
Todos os Preços relacionados ao Produto que forem enviados serão alterados se necessário. - Exclusão de Produto
Todos os Preços relacionados ao Produto serão excluídos.
- Cadastro de Códigos de Barras:
Os Códigos de Barras correspondentes ao Produto também serão inseridos pela integração de Produtos, será enviada pelo Sistema RM uma Lista com os Códigos de Barras correspondentes e gravados pelo Sistema Protheus na Tabela de Código de Barras (SLK), os campos necessários estão informados no XSD ListOfBarCode_1_000.xsd.
Os eventos de Códigos de Barras estarão relacionados com os eventos da integração do Produto da seguinte forma:
- Inclusão de Produto:
Todos os Códigos de Barras relacionados ao Produto que forem enviados serão incluídos. - Alteração do Produto:
Todos os Códigos de Barras relacionados ao Produto que forem enviados serão alterados se necessário, aqueles que não forem enviados serão excluídos. - Exclusão do Produto:
Todos os Códigos de Barras relacionados ao Produto serão excluídos.
O Protheus possui um tratamento onde um Código de Barras pode representar uma Caixa de Mercadorias, neste caso, deverá ser informado pela RM a quantidade de produtos para o Código de Barras que está sendo gerado, caso não seja informado, será considerado o valor default = 0, definindo assim que o Código de Barras representa apenas 1 produto.
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
Cadastro de Produto Cadastro de Códigos de Barras | Inclusão/Alteração/Exclusão Inclusão/Alteração/Exclusão | Protheus/SigaLoja/Atualizações/Cadastros/Produtos Protheus/SigaLoja/Atualizações/Cadastros/Códigos de Barras | - - |
Os campos considerados obrigatórios no envio para o correto recebimento no PDV são:
Observações:
Haverá validação para o código de tributação ECF enviado, esta informação não é gravada no sistema Protheus pois os códigos são sempre fixos, já no sistema RM podem ser variáveis, assim esta validação garantirá que ambos estarão utilizando as mesmas informações, são elas:
- Tributado
Produto ICMS inicia com T + Aliquota do imposto + 00
Ex: 7% = T0700, 12% = T1200, 18% = T1800
Produto ISS inicia com S + Aliquota do imposto + 00
Ex: 5% = S0500 - Isento = I1
- Substituição Tributária = F1
- Não Tributado = N1
Observações:
Cadastrar no sistema Protheus as Tes para cada tipo de tributação e inerir no cadastro de configurações de produtos através da rotina SIGALOJA->Integração->Configuração Padrão (LOJA2142), com estas informações preenchidas, na integração do produto, a Tes correspondente será inserida no campo Tes de Saída (B1_TS).
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
Cadastro de Produto Cadastro de Códigos de Barras | Inclusão/Alteração/Exclusão Inclusão/Alteração/Exclusão | Protheus/SigaLoja/Atualizações/Cadastros/Produtos Protheus/SigaLoja/Atualizações/Cadastros/Códigos de Barras | - - |
Os campos considerados obrigatórios no envio para o correto recebimento no PDV são:
- Código
- Descrição
- Tipo
- Unidade de Medida
- Armazém Padrão
- Preços de Venda
Tabelas Utilizadas
- SB1 - Produtos
- SB0 - Dados Adicionais - Loja
- SLK - Códigos de Barra por Produto
Mapeamento dos Campos
- Mensagem Item 3.004
Cadastro de Estação de
Preços de VendaTabelas Utilizadas
- SB1 - Produtos
- SB0 - Dados Adicionais - Loja
- SLK - Códigos de Barra por Produto
Mapeamento dos Campos
- Mensagem Item 3.004
Observações :
Para correta integração dos produtos, deve ser removida a obrigatoriedade e validação de sistema do campo B1_CODITE no sistema Protheus.
Cadastro de Estação de Trabalho (Pdv):
A Estação de Trabalho será cadastrada no Sistema RM e em seguida enviado ao Sistema Protheus, este receberá e armazenará para ser utilizado nos processos de Vendas, os campos necessários estão informados no XSD ListOfStationSalePoint_1_000.
Nesta integração, também deverá ser informado o Local de Estoque, desta forma será possível efetuar corretamente a baixa de estoque das vendas efetuadas pela Estação de Trabalho.
Os campos relacionados a impressora fiscal (ECF), balança, pinpad e outros hardwares deverão ser cadastrados diretamente no sistema Protheus pois necessitam de informações dos dispositivos e computador, como porta de comunicação, Número de Série etc.
O Código da Estação enviado pelo sistema RM deve respeitar o tamanho do campo Código de Estação no Protheus (LG_CODIGO) pois trata-se de um campo chave no cadastro.
Caso seja adicionado auto-incremento no Código da Estação, esta opção terá prioridade, não considerando assim o código enviado na integração.
Se a Estação de trabalho for inativada no Sistema RM, esta será deletada no Sistema Protheus para que não sejam enviadas movimentações incorretas.
A integração de Local de Estoque é pré-requisito para a integração de Estação de Trabalho e está detalhada neste documento.
Observações:
Protheus possui um código de Estação de Trabalho Padrão automático, RM deve enviar a integração deste cliente para alimentar a tabela De-Para.
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
Cadastro de Estação | Inclusão/Alteração/Exclusão | Protheus/SigaLoja/Atualizações/Ponto de Venda/Estações | - |
Complementar os campos necessários no Protheus conforme help de campos.
Tabelas Utilizadas
- SLG - Estações
Mapeamento dos Campos
- Mensagem ListOfStationSalePoint 1.000
Cadastro de Vendedor:
O Vendedor será cadastrado no Sistema RM e em seguida enviado ao Sistema Protheus para que seja utilizado nos processos de Vendas, os campos necessários estão informados no XSD Seller_2_001.xsd.
O Código do Vendedor enviado pelo sistema RM deve respeitar o tamanho do campo Código de Vendedor no Protheus (A3_COD) pois trata-se de um campo chave no cadastro.
Caso seja adicionado auto-incremento no Código do Vendedor, esta opção terá prioridade, não considerando assim o código enviado na integração.
Observações:
Protheus possui um código de Vendedor Padrão automático, RM deve enviar a integração deste cliente para alimentar a tabela De-Para.
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
Cadastro de Vendedor | Inclusão/Alteração/Exclusão | Protheus/SigaLoja/Atualizações/Cadastros/Vendedores | - |
Tabelas Utilizadas
- SA3 - Vendedores
Mapeamento dos Campos
- Mensagem Seller 2.001
Cadastro de Forma de Pagamento/Administradoras Financeiras:
A Forma de Pagamento será cadastrada no Sistema RM e em seguida enviada ao Sistema Protheus, este receberá e armazenará para ser utilizado nos processos de Vendas, os campos necessários estão informados no XSD PaymentMethod_1_000.
Visto que a base Protheus possui carga com formas de pagamento padrão (obrigatoriamente constam na base de dados), deve-se efetuar o cadastro destas Formas de Pagamento no RM respeitando o mesmo código do Protheus para viabilizar a integração de registros que utilizem estas como parâmetro. A lista de forma de pagamentos padrão no Protheus e que devem ser cadastradas no RM com o mesmo código de descrição são:
Tabela de Formas de Pagamento nativas Protheus
Código | Descrição |
BOL | BOLETO BANCARIO |
CC | CARTAO DE CREDITO |
CD | CARTAO DE DEBITO AUTOMATICO |
CH | CHEQUE |
CO | CONVENIO |
CR | CREDITO |
DC | DEBITO EM CONTA CORRENTE |
FI | FINANCIADO |
FID | FIDELIDADE |
R$ | DINHEIRO |
VA | VALES |
VP | VALE PRESENTE |
Observações:
Se forem incluídas novas Formas de Pagamentos no Sistema RM diferentes das Formas de Pagamento pré-existente no Protheus, essas serão incluídas automaticamente.
Deverá ser informado pelo sistema RM o mesmo código da Forma de Pagamento Protheus conforme tabela acima, desta forma, será alimentada a tabela de integração para utilização, se o usuário optar em trabalhar com código diferente do cadastro Protheus, os códigos deverão ser inseridos manualmente nos parâmetros abaixo:
- MV_LJMUDIN: parâmetro de forma de pagamento para Dinheiro.
- MV_LJMUCH: parâmetro de forma de pagamento para Cheque.
- MV_LJMUFI: parâmetro de forma de pagamento para Financiado.
Observações:
Os códigos deverão ser inseridos manualmente nos parâmetros, se a Forma de Pagamento alternativa for excluída, o código deverá ser apagado manualmente do parâmetro correspondente.
As Administradoras Financeiras serão inseridas manualmente no sistema Protheus e não terão integração com o sistema RM, deve-se preencher no campo Form Pg Ext (AE_CODEXT) a Forma de Pagamento Cartão de Crédito/Débito enviado pelo sistema RM, desta forma, será possível estabelecer a relação entre as entidades.
Observações:
Os códigos de Forma de Pagamento nativas do Protheus (tabela acima) não serão excluídos mesmo que seja removido do sistema RM.
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
Cadastro de Formas de Pagamento Cadastro de Administradora Financeira | Inclusão/Alteração/Exclusão Inclusão/Alteração/Exclusão | Protheus/SigaCFG/Ambiente/Cadastros/Tabelas/Formas de Pagamento Protheus/SigaLoja/Atualizações/Cadastros/Administradoras Financeiras | - - |
Comlementar os campos necessários no Protheus conforme help de campos.
Tabelas Utilizadas
- SX5/24 - Tabelas Genéricas
- SAE - Administração Financeira
Mapeamento dos Campos
- Mensagem PaymentMethod 1.000
Cadastro de Unidade de Medida:
A Unidade de Medida será cadastrada no Sistema RM e em seguida enviada ao Sistema Protheus para que seja utilizado nos processos de Vendas, os campos necessários estão informados no XSD UnitOfMeasure_2_002.xsd.
A Undade de Medida enviada pelo sistema RM deve respeitar o tamanho do campo Código de Unidade de Medida no Protheus (AH_UNIMED) pois trata-se de um campo chave no cadastro.
Caso seja adicionado auto-incremento no Código do Unidade de Medida, esta opção terá prioridade, não considerando assim o código enviado na integração.
Observações:
RM deve enviar as integrações das Unidades de Medida padrões Protheus para que alimente as tabela De-Para.
Observações:
Sistema não permitirá a exclusão da Unidade de Medida se estiver sendo utilizada em algum cadastro (ex: Produto).
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
Cadastro de Unidade de Medida | Inclusão/Alteração/Exclusão | Protheus/SigaEst/Atualizações/Cadastros/Produto/Unidades de Medida | - |
Tabelas Utilizadas
- SAH - Unidades de Medida
Mapeamento dos Campos
- Mensagem UnitOfMeasure 2.002
Cadastro de Local de Estoque:
A O Local de Estoque será cadastrado no Sistema RM e em seguida enviada ao Sistema Protheus para que seja utilizado nos processos de Vendas, os campos necessários estão informados no XSD Warehouse_1_001.xsd.
A O Local de Estoque enviado pelo sistema RM deve respeitar o tamanho do campo Código de Local de Estoque no Protheus (NNR_CODIGO) pois trata-se de um campo chave no cadastro.
Caso seja adicionado auto-incremento no Local de Estoque, esta opção terá prioridade, não considerando assim o código enviado na integração.
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
Cadastro de Local de Estoque | Inclusão/Alteração/Exclusão | Protheus/SigaLoja/Atualizações/Cadastros/Locais de Estoque | - |
Tabelas Utilizadas
- NNR - Armazéns de Estoque
Mapeamento dos Campos
- Mensagem Warehouse 1.001
Pré-Requisitos
Configuração de Grupo de Empresas no Protheus:
Exemplo:
Grupo de Empresas | Empresa | Unidade de Negócio | Filial |
01 | 01 | 01 | 01 |
02 | 01 | 01 | 01 |
03 | 01 | 01 | 01 |
04 | 01 | 01 | 01 |
Configuração de compartilhamento de cadastros entre Empresas e Filiais.
1. Para o funcionamento da Integração Linha RM x Protheus SigaLoja é necessária a configuração de compartilhamento de registros nas tabelas do Protheus SigaLoja.
2. Para configurar o compartilhamento acesse : Protheus SigaCFG
3. Acesse : Base de dados / Dicionário de Dados / Base de Dados / Empresa / Dicionário de Dados.
4. Pesquise pela tabela e a configure conforme especificado na tabela abaixo:
Entidade | Empresa | Unidade | Filial | Tabela Protheus |
Cliente | Compartilhado | Compartilhado | Compartilhado | SA1 |
Vendedor | Exclusivo | Exclusivo | Compartilhado | SA3 |
Dados Adicionais Loja | Exclusivo | Exclusivo | Compartilhado | SB0 |
Produto | Exclusivo | Exclusivo | Compartilhado | SB1 |
Produtos x Preços | Exclusivo | Exclusivo | Compartilhado | SBI |
Log de Modificações | Exclusivo | Exclusivo | Exclusivo | SLH |
Genérica | Exclusivo | Exclusivo | Compartilhado | SX5 |
5. Clique em atualizar Base de Dados para salvar as alterações.
Observações:
Será necessário excluir a tabela SX5 através do APSDU, ao acessar o módulo SigaLoja novamente, a tabela será recriada com as filiais adicionadas corretamente.
Antes do processo, fazer backup da tabela SX5.
Será necessário efetuar os procedimentos de Compartilhamento de tabelas nos PDVs.
Cadastro de rotinas dos Adapters Protheus SigaCFG
1: Acessar : Ambiente / Schedule / Adapter E.a.I.
2: Incluir uma nova Rotina para os adapters do sistema Protheus
3: 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 |
Configuração do De-Para para as Empresas e Filiais
O cadastro de Empresas e Filiais deve ser feito manualmente no PROTHEUS, através da funcionalidade “De-Para”.
- Para cadastrar o De-Para das Empresas e Filiais no Protheus acesse : Protheus / SigaCFG / Ambiente / Schedule / Emp.fil Msg. Unica
- Incluir um novo registro
- Preencher os campos conforme os valores a seguir :
- Referência: RM
- Company : Código da Coligada RM a integrar.
- Branch: Código da Filial RM a integrar
- Emp. Protheus: Código da Empresa no Protheus a integrar com o sistema RM
- Fil. Protheus: Código da Filial no Protheus a integrar com o sistema RM
Exemplo :
Referência: RM
Company : 4
Branch: 20
Emp. Protheus: 01
Fil. Protheus: 0101005
Para os cadastros globais no Sistema RM, deve haver também um De-Para no Protheus conforme exemplo abaixo:
Referência: RM
Company : 0
Branch:
Emp. Protheus: 01
Fil. Protheus: 0101005
Configuração de Dicionário de Dados (SX3)
Tamanho do Grupo de Campos (A1_COD)
1. Acessar o Protheus , Módulo SigaCFG
2. Acessar : Base de Dados / Dicionario / Base de Dados
3. Acessar Dicionário de Dados / Grupo de Campos
4. Editar o Grupo Codigo Cliente/Fornecedor
5. Aumentar o tamanho para o valor desejado e salvar
6. Atualizar Base de Dados para efetivar a alteração.
Observações:
O tamanho do Código de Cliente pode variar de 6 a 20 conforme definido regra de negócio.
Inicializador Padrão do campo Loja do Cliente (A1_LOJA)
1. Acessar o Protheus , Módulo SigaCFG
2. Acessar : Base de Dados / Dicionario / Base de Dados
3. Dicionario de Dados / Pesquisar por SA1
4. Selecione a tabela e clique em editar.
5. Acesse : Clientes / Campos.
6. Pesquisar pelo campo do cliente (A1_LOJA).
7. Selecionar o campo A1_LOJA e clicar no ícone Editar.
8. Informar o valor “01” (As aspas são necessárias) ao campo Inic.Padrão localizado na aba Opções e Confirmar.
9.Atualizar Base de Dados para efetivar a alteração.
Tamanho do Grupo de Campos Código de Armazém
1: Acessar o Protheus , Módulo SigaCFG.
2: Acessar : Base de Dados / Dicionario / Base de Dados.
4: Dicionario de Dados / Grupo de Campos.
5. Selecione o Código do Armazém e clique em Editar.
6: Aumente o tamanho para o valor desejado e salvar.
7. Atualizar Base de Dados para efetivar a alteração.
Observações:
O tamanho do Código do Armazém pode variar de 2 a 6 conforme definido regra de negócio.
Inicializador Padrão do campo Loja do Cliente (NNR_CODIGO)
1. Acessar o Protheus , Módulo SigaCFG
2. Acessar : Base de Dados / Dicionario / Base de Dados
3. Dicionario de Dados / Pesquisar por NNR
4. Selecione a tabela e clique em editar.
5. Acesse : Clientes / Campos.
6. Pesquisar pelo campo do Código do Armazém (NNR_CODIGO).
7. Selecionar o campo NNR_CODIGO e clicar no ícone Editar.
8. Informar a função GetSxENum("NNR","NNR_CODIGO") ao campo Inic.Padrão localizado na aba Opções e Confirmar.
9.Atualizar Base de Dados para efetivar a alteração.
Observações:
Se adicionado Inicializador Padrão no campo Código do Armazém (NNR_CODIGO), não será considerado o código informado pela RM, será priorizada a inicialização automática.
Configuração de parâmetros
MV_EAIURL2:
Informe o nome do canal configurado no EAI para envio a outro EAI.
MV_EAIUSER
Informe o usuário para autenticação do EAI para uso no envio de mensagens.
MV_EAIPASS
Informe a senha para autenticação do EAI para uso no envio de mensagens.
MV_LJRMBAC
Informe o valor .T. para ativar a integração BacOffice RM x PDV Protheus.
Cupom Fiscal/RPS:
As Vendas Varejo serão realizadas no Sistema Protheus (Front Loja ou Totvs Pdv), poderão ser do tipo Cupom Fiscal ou RPS (Recibo Provisório de Serviço), após a finalização da venda, estas serão integradas com a Retaguarda (SigaLoja) através dos processos já existentes no sistema Protheus.
Na Retaguarda (SigaLoja), as vendas serão integradas para o sistema RM através de comunicação via Mensagem Única, a verificação e envio será feita pelo job LjiSendEAI , este verificará os registros com o status de integração (L1_SITUA = RX) e fará a chamada do EAI para envio, os campos necessários estão informados no XSD RetailSales_1_001.xsd, após a integração, se o retorno do sistema RM for positivo, o campo L1_SITUA receberá o conteúdo OK, informando assim ao sistema Protheus que a integração foi bem sucedida, caso retorno seja de erro, o campo L1_SITUA receberá o conteúdo ER, através do monitor EAI é possível verificar o motivo da divergência, após correção, basta alterar o conteúdo do campo L1_SITUA para RX para que seja feita uma nova tentativa de integração.
Observações:
As vendas emitidas e integradas corretamente não poderão ser alteradas, para estes casos, deverá haver cancelamento da venda, esta será integrada no sistema RM e em seguida, refazê-la no Sistema Protheus.
Observações:
O Job GravaBatch para geração das informações BackOffice não deverá ser configurado pois todo o controle será feito pelo sistema RM.
Observações:
O envio das integrações de vendas serão de forma automática através do Job LjiSendEAI, sua configuração está detalhada em Configurações de ambiente.
Observações:
A integração de venda será habilitada através do parâmetro MV_LJRMBAC.
Observações:
As integrações de vendas poderão ser monitoradas (Visualizadas e reprocessadas) pelo Monitor de Integrações, acesse em SIGALOJA->Integração->Mnt de Integrações (LOJA781).
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
Cupom Fiscal/RPS | Inclusão/Alteração/Exclusão | Protheus/SigaLoja/Atualizações/Atendimento/Venda Assistida | - |
Tabelas Utilizadas
- SL1 - Orçamento
- SL2 - Itens do Orçamento
- SL4 - Condição Negociada
Mapeamento dos Campos
- Mensagem RetailSales 1.001
Cancelamento de Cupom Fiscal/RPS
Os Cancelamentos de Vendas Varejo (Cupom Fiscal e RPS) serão realizadas no Sistema Protheus (Front Loja ou Totvs Pdv), estas serão integradas com a Retaguarda (SigaLoja) através dos processos já existentes no sistema Protheus.
Na Retaguarda (SigaLoja), os cancelamentos de vendas serão integradas para o sistema RM através de comunicação via Mensagem Única, a verificação e envio será feita pelo job LjiSendEAI , este verificará os registros com o status de integração (LX_SITUA = RX) e fará a chamada do EAI para envio, após a integração, se o retorno do sistema RM for positivo, o campo LX_SITUA receberá o conteúdo OK, informando assim ao sistema Protheus que a integração foi bem sucedida, caso retorno seja de erro, o campo LX_SITUA receberá o conteúdo ER, através do monitor EAI é possível verificar o motivo da divergência, após correção, basta alterar o conteúdo do campo LX_SITUA para RX para que seja feita uma nova tentativa de integração.
Os processos de cancelamento de venda podem ser de duas modalidades, venda já integrada ao BackOffice, ocorre quando a venda foi finalizada e enviada ao sistema RM, após, efetuado seu cancelamento no Pdv, constará no sistema RM e venda não integrada ao BackOffice, ocorre quando o cliente desiste da venda antes de sua finalização no Pdv, neste caso, não constará no sistema RM, ambas se darão pela rotina de venda, os campos necessários estão informados no XSD RetailSales_1_001.xsd.
Observações:
Os cancelamentos de vendas emitidas e integradas com sucesso não poderão ser alteradas.
Observações:
O envio das integrações de cancelamentos de vendas serão de forma automática através do Job LjiSendEAI, sua configuração está detalhada em Configurações de ambiente.
Observações:
A integração de venda será habilitada através do parâmetro MV_LJRMBAC.
Observações:
As integrações de cancelamentos de cupom fiscal/Rps poderão ser monitoradas (Visualizadas e reprocessadas) pelo Monitor de Integrações, acesse em SIGALOJA->Integração->Mnt de Integrações (LOJA781).
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
Cancelamento de Cupom Fiscal/RPS | Inclusão/Alteração/Exclusão | Protheus/SigaLoja/Atualizações/Atendimento/Exclusão Nota Fiscal/Orçamento/Pedido | - |
Tabelas Utilizadas
- SLX - Log Cancelamento x Devolução
Mapeamento dos Campos
- Mensagem RetailSales 1.001
Redução Z
As Reduções serão realizadas no Sistema Protheus (Front Loja ou Totvs Pdv), estas serão integradas com a Retaguarda (SigaLoja) através dos processos já existentes no sistema Protheus.
Na Retaguarda (SigaLoja), as reduções serão integradas para o sistema RM através de comunicação via Mensagem Única, a verificação e envio será feita pelo job LjiSendEAI , este verificará os registros com o status de integração (FI_SITUA = RX) e fará a chamada do EAI para envio, após a integração, se o retorno do sistema RM for positivo, o campo FI_SITUA receberá o conteúdo 00, informando assim ao sistema Protheus que a integração foi bem sucedida, caso retorno seja de erro, o campo FI_SITUA receberá o conteúdo ER, através do monitor EAI é possível verificar o motivo da divergência, após correção, basta alterar o conteúdo do campo FI_SITUA para RX para que seja feita uma nova tentativa de integração.
Observações:
O envio das integrações de reduções serão de forma automática através do Job LjiSendEAI, sua configuração está detalhada em Configurações de ambiente.
Observações:
A integração de venda será habilitada através do parâmetro MV_LJRMBAC.
Observações:
As integrações de redução z poderão ser monitoradas (Visualizadas e reprocessadas) pelo Monitor de Integrações, acesse em SIGALOJA->Integração->Mnt de Integrações (LOJA781).
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
Cancelamento de Cupom Fiscal/RPS | Inclusão/Alteração/Exclusão | Protheus/SigaLoja/Atualizações/Caixa/Redução Z | - |
Tabelas Utilizadas
- SFI - Resumo da Redução Z
Mapeamento dos Campos
- Mensagem Reduction 1.001
Pré-Requisitos
Configuração de Grupo de Empresas no Protheus:
Exemplo:
Grupo de Empresas | Empresa | Unidade de Negócio | Filial |
01 | 01 | 01 | 01 |
02 | 01 | 01 | 01 |
03 | 01 | 01 | 01 |
04 | 01 | 01 | 01 |
Configuração de compartilhamento de cadastros entre Empresas e Filiais.
1. Para o funcionamento da Integração Linha RM x Protheus SigaLoja é necessária a configuração de compartilhamento de registros nas tabelas do Protheus SigaLoja.
2. Para configurar o compartilhamento acesse : Protheus SigaCFG
3. Acesse : Base de dados / Dicionário de Dados / Base de Dados / Empresa / Dicionário de Dados.
4. Pesquise pela tabela e a configure conforme especificado na tabela abaixo:
Entidade | Empresa | Unidade | Filial | Tabela Protheus |
Cliente | Compartilhado | Compartilhado | Compartilhado | SA1 |
Vendedor | Exclusivo | Exclusivo | Compartilhado | SA3 |
Dados Adicionais Loja | Exclusivo | Exclusivo | Compartilhado | SB0 |
Produto | Exclusivo | Exclusivo | Compartilhado | SB1 |
Produtos x Preços | Exclusivo | Exclusivo | Compartilhado | SBI |
Log de Modificações | Exclusivo | Exclusivo | Compartilhado | SLH |
Genérica | Exclusivo | Exclusivo | Compartilhado | SX5 |
Estações de Trabalho | Exclusivo | Exclusivo | Compartilhado | SLG |
5. Clique em atualizar Base de Dados para salvar as alterações.
Observações:
Será necessário excluir a tabela SX5 através do APSDU, ao acessar o módulo SigaLoja novamente, a tabela será recriada com as filiais adicionadas corretamente.
Antes do processo, fazer backup da tabela SX5.
Será necessário efetuar os procedimentos de Compartilhamento de tabelas nos PDVs.
Cadastro de rotinas dos Adapters Protheus SigaCFG
1: Acessar : Ambiente / Schedule / Adapter E.a.I.
2: Incluir uma nova Rotina para os adapters do sistema Protheus
3: 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 |
Observações:
Estes adapters devem ser adicionados somente na Retaguarda.
Configuração do De-Para para as Empresas e Filiais
O cadastro de Empresas e Filiais deve ser feito manualmente no PROTHEUS, através da funcionalidade “De-Para”.
- Para cadastrar o De-Para das Empresas e Filiais no Protheus acesse : Protheus / SigaCFG / Ambiente / Schedule / Emp.fil Msg. Unica
- Incluir um novo registro
- Preencher os campos conforme os valores a seguir :
- Referência: RM
- Company : Código da Coligada RM a integrar.
- Branch: Código da Filial RM a integrar
- Emp. Protheus: Código da Empresa no Protheus a integrar com o sistema RM
- Fil. Protheus: Código da Filial no Protheus a integrar com o sistema RM
Exemplo :
Referência: RM
Company : 4
Branch: 20
Emp. Protheus: 01
Fil. Protheus: 0101005
Para os cadastros globais no Sistema RM, deve haver também um De-Para no Protheus conforme exemplo abaixo:
Referência: RM
Company : 0
Branch:
Emp. Protheus: 01
Fil. Protheus: 0101005
Configuração de Dicionário de Dados (SX3)
Tamanho do Grupo de Campos (A1_COD)
1. Acessar o Protheus , Módulo SigaCFG
2. Acessar : Base de Dados / Dicionario / Base de Dados
3. Acessar Dicionário de Dados / Grupo de Campos
4. Editar o Grupo Codigo Cliente/Fornecedor
5. Aumentar o tamanho para o valor desejado e salvar
6. Atualizar Base de Dados para efetivar a alteração.
Observações:
O tamanho do Código de Cliente pode variar de 6 a 20 conforme definido regra de negócio.
Será necessário efetuar os procedimentos de tamanho de grupo de campos na Retaguarda e nos PDVs.
Tamanho do Grupo de Campos (A1_LOJA)
1. Acessar o Protheus , Módulo SigaCFG
2. Acessar : Base de Dados / Dicionario / Base de Dados
3. Acessar Dicionário de Dados / Grupo de Campos
4. Editar o Grupo Loja Cliente/Fornecedor
5. Aumentar o tamanho para o valor desejado e salvar
6. Atualizar Base de Dados para efetivar a alteração.
Observações:
O tamanho do Código de Cliente pode variar de 2 a 4 conforme definido regra de negócio.
Será necessário efetuar os procedimentos de tamanho de grupo de campos na Retaguarda e nos PDVs.
Tamanho do Grupo de Campos Código de Armazém
1: Acessar o Protheus , Módulo SigaCFG.
2: Acessar : Base de Dados / Dicionario / Base de Dados.
4: Dicionario de Dados / Grupo de Campos.
5. Selecione o Código do Armazém e clique em Editar.
6: Aumente o tamanho para o valor desejado e salvar.
7. Atualizar Base de Dados para efetivar a alteração.
Observações:
O tamanho do Código do Armazém pode variar de 2 a 6 conforme definido regra de negócio.
Será necessário efetuar os procedimentos de tamanho de grupo de campos na Retaguarda e nos PDVs.
Tamanho do Grupo de Campos (B1_COD)
1. Acessar o Protheus , Módulo SigaCFG
2. Acessar : Base de Dados / Dicionario / Base de Dados
3. Acessar Dicionário de Dados / Grupo de Campos
4. Editar o Grupo Tamanho do Produto
5. Aumentar o tamanho para o valor desejado e salvar
6. Atualizar Base de Dados para efetivar a alteração.
Observações:
O tamanho do Código do Produto pode variar de 15 a 30 conforme definido regra de negócio.
Será necessário efetuar os procedimentos de tamanho de grupo de campos na Retaguarda e nos PDVs.
Inicializador Padrão do campo Loja do Cliente (NNR_CODIGO)
1. Acessar o Protheus , Módulo SigaCFG
2. Acessar : Base de Dados / Dicionario / Base de Dados
3. Dicionario de Dados / Pesquisar por NNR
4. Selecione a tabela e clique em editar.
5. Acesse : Clientes / Campos.
6. Pesquisar pelo campo do Código do Armazém (NNR_CODIGO).
7. Selecionar o campo NNR_CODIGO e clicar no ícone Editar.
8. Informar a função GetSxENum("NNR","NNR_CODIGO") ao campo Inic.Padrão localizado na aba Opções e Confirmar.
9.Atualizar Base de Dados para efetivar a alteração.
Observações:
Se adicionado Inicializador Padrão no campo Código do Armazém (NNR_CODIGO), não será considerado o código informado pela RM, será priorizada a inicialização automática.
Será necessário efetuar os procedimentos de Inicializador Padrão na Retaguarda e nos PDVs.
Configuração de parâmetros
MV_EAIURL2:
Informe o nome do canal configurado no EAI para envio a outro EAI.
MV_EAIUSER
Informe o usuário para autenticação do EAI para uso no envio de mensagens.
MV_EAIPASS
Informe a senha para autenticação do EAI para uso no envio de mensagens.
MV_LJRMBAC
Informe o valor .T. para ativar a integração BacOffice RM x PDV Protheus.
Observações:
Estes parâmetros devem ser configurados somente na Retaguarda.
Configuração de ambiente
Exemplo de configuração do Job LJISendEAI no AppServer.ini da Retaguarda:
[Integracao EAI]
Main= LJISENDEAI
ENVIRONMENT=Ambiente
nParms=2
Parm1=99
Parm2=01
[OnStart]
jobs=Integracao EAI
RefreshRate=120
Observações:
Este job deve ser adicionado somente na retaguarda.
Observações:
As Bases de Alíquotas existentes no Protheus são: 7, 12, 18 e 25. Caso sejam necessárias outras bases, deve-se inserir os campos correspondentes no Protheus (Tabela SFI) através do módulo Configurador (SIGACFG).
ICMS - Inicia com Bas + Base e FI_COD + Base, exemplo:
Base 16 – Campos Protheus = FI_BAS16 e FI_COD16
Base 3 – Campos Protheus = FI_BAS3 e FI_COD3
Se a Base possuir decimal, o campo deverá ser criado como FI_BAS + Inteiro + 0 + Decimal, exemplo
Base 7.2 – Campos Protheus = FI_BAS702 e FI_COD702
Base 8.5 – Campos Protheus = FI_BAS805 e FI_COD805
ISS - Inicia com BIS + Base e ISS + Base, exemplo:
Base 5 - Campos Protheus = FI_BIS0500 e FI_ISS0500
Base 6 - Campos Protheus = FI_BIS0600 e FI_ISS0600
Se Base possuir decimal, o campo o campo deverá ser criado como FI_BIS + Inteiro + 0 + Decimal, exemplo
Base 6.5 - Campo Protheus = FI_BIS0605 e FI_ISS0605
Esses campos deverão ser criados na Retaguarda e nos PDVs.
Dicionário de Dados
SLG - Estações
Campo | LG_LOCAL |
Tipo | Caractere |
Tamanho | 2 |
Valor Inicial |
|
Mandatório | Sim ( ) Não ( X ) |
Descrição | Armazem |
Título | Armazem do Produto |
Picture | @! |
Help de Campo | Armazém do produto. Utilizado nas integrações via Mensagem Única. |
SAE - Administração Financeira
Campo | AE_CODEXT |
Tipo | Caractere |
Tamanho | 7 |
Valor Inicial |
|
Mandatório | Sim ( ) Não ( X ) |
Descrição | Form Pg Ext |
Título | Forma Pagamento Externa |
Picture | @! |
Help de Campo | Código da Forma de Pagamento Externa enviada por integração com outros sistemas. |
SLQ - Orçamento
Campo | LQ_ERGRVBT |
Tipo | Memo |
Tamanho | 10 |
Valor Inicial |
|
Mandatório | Sim ( ) Não ( X ) |
Descrição | Erro GrvBat |
Título | Erro GravaBatch |
Picture | @! |
Help de Campo | Informa a descrição do erro que ocorreu na integração ERP (GravaBatch). |
SL1 - Orçamento
Campo | L1_ERGRVBT |
Tipo | Memo |
Tamanho | 10 |
Valor Inicial |
|
Mandatório | Sim ( ) Não ( X ) |
Descrição | Erro GrvBat |
Título | Erro GravaBatch |
Picture | @! |
Help de Campo | Informa a descrição do erro que ocorreu na integração ERP (GravaBatch). |
SLX - Log Cancelamento x Devolução
Campo | LX_ERGRVBT |
Tipo | Memo |
Tamanho | 10 |
Valor Inicial |
|
Mandatório | Sim ( ) Não ( X ) |
Descrição | Erro GrvBat |
Título | Erro GravaBatch |
Picture | @! |
Help de Campo | Informa a descrição do erro que ocorreu na integração ERP (GravaBatch). |
SFI - Resumo Redução Z
Campo | FI_ERGRVBT |
Tipo | Memo |
Tamanho | 10 |
Dicionário de Dados
SLG - Estações
Campo
LG_LOCAL
Tipo
Caractere
Tamanho
Valor Inicial |
|
Mandatório | Sim ( ) Não ( X ) |
Descrição |
Erro GrvBat |
Título |
Erro GravaBatch | |
Picture | @! |
Help de Campo |
Informa a descrição do erro que ocorreu na integração ERP (GravaBatch). |
SAE - Administração FinanceiraMDQ - Configuração Padrão Integração
Campo | AEMDQ_CODEXTTSSERV |
Tipo | CaractereCaracter |
Tamanho | 73 |
Valor Inicial |
|
Mandatório | Sim ( ) Não ( X ) |
DescriçãoForm Pg Ext | B1 TS SERVIC |
TítuloForma Pagamento Externa | Tes do Produto Servico |
Picture | @! |
Help de Campo Código da Forma de Pagamento Externa enviada por integração com outros sistemas. | Tes para ser utilizada em Produtos do tipo Servico. |
Parâmetros
Nome | MV_LJRMBAC |
Tipo | Caractere |
Cont. Por. | .T. |
Descrição | Habilita integração BackOffice RM x Pdv Protheus, .T. = Ativado e .F. = Desativado |
Nome | MV_LJMUCH |
Tipo | Caractere |
Cont. Por. |
|
Descrição | Forma de Pagamento externa para cheques, utilizado em integrações com outros sistemas. |
Nome | MV_LJMUDIN |
Tipo | Caractere |
Cont. Por. |
|
Descrição | Forma de Pagamento externa para dinheiro, utilizado em integrações com outros sistemas. |
Nome | MV_LJMUFI |
Tipo | Caractere |
Cont. Por. |
|
Descrição | Forma de Pagamento externa para financiado, utilizado em integrações com outros sistemas. |
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|