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.10 | 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 1
Cadastros:
Serão gerados no Sistema RM e enviados para o Sistema Protheus:
- Cadastro de Clientes
- Cadastro de Produtos
- Código de Barras do Produto
- Forma de Pagamento/Administradoras Financeiras
- Unidade de Medida
- Local de Estoque
Serão gerados no Sistema Protheus e enviados para o Sistema RM:
- Cadastro de Estação (PDV);
- Cadastro de Vendedor
Movimentos do Produto
Serão gerados no Sistema Protheus e enviados para o Sistema RM:
- Cupom Fiscal;
- Cancelamento de Cupom Fiscal;
- Mapa Resumo/Redução Z (PAF-ECF)
Fase 2
Cadastros:
O cadastro abaixo será utilizado e tratado no Sistema RM e enviado para o Sistema Protheus:
- Crédito de Devolução/Troca
Movimentos do Produto:
Serão efetuados no Sistema Protheus e enviados para o Sistema RM:
- Sangria
- Suprimento de Caixa
- Consulta de Estoque
Detalhes das Integrações
Cadastro de Clientes:
O cliente (pessoa física ou jurídica), consumidor dos produtos, 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.
Os campos necessários para o Protheus estão informados no XSD CustomerVendor_2_002.xsd.
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 do Cliente
- Loja
- Nome
- Nome Fantasia
- Endereço
- Entidade: pessoa física ou pessoa jurídica
- Município.
- Estado.
- País.
Tabelas Utilizadas
- SA1 - Clientes
- SA2 - Fornecedores
Mapeamento dos Campos
- Mensagem CustomerVendor 2.002
Cadastro de Produtos:
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.
Os campos necessários para o Protheus estão informados no XSD Item_2_000.
Obs: Para correta integração dos produtos, deve ser removida a obrigatoriedade e validação de sistema do campo B1_CODITE no sistema Protheus.
- Preços do Produto:
Os Preços de Venda do produto serão enviados através da integração de Produtos, serão gravados na tabela de Preços de Venda (SB0) para serem utilizados na venda.
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 uma Lista com os Códigos de Barras correspondentes, 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:
- Código do Produto
- Descrição do Produto
- Tipo do Produto
- Unidade de Medida
- Armazém Padrão
- Preço de Venda
Tabelas Utilizadas
- SB1 - Produtos
- SB0 - Dados Adicionais - Loja
Mapeamento dos Campos
- Mensagem Item 2.000
Cadastro de Estação de Trabalho:
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.
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 | - |
Cadastrar os campos 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.
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 | - |
Cadastrar os campos no Protheus conforme help de campos.
Tabelas Utilizadas
- SA3 - Vendedores
Mapeamento dos Campos
- Mensagem Seller 2.001
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_000.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.
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/ | - |
Cadastrar os campos no Protheus conforme help de campos.
Tabelas Utilizadas
- SAH - Unidades de Medida
Mapeamento dos Campos
- Mensagem UnitOfMeasure 2.002
Cadastro de Local de Estoque:
A Local de Estoque será A 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_000.xsd.
A 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/ | - |
Cadastrar os campos no Protheus conforme help de campos.
Tabelas Utilizadas
- NNR - Armazéns de Estoque
Mapeamento dos Campos
- Mensagem Warehouse 1.000
Configuração de Grupo de Empresas no Protheus:
Exemplo:
Grupo de Empresas | Empresa | Unidade de Negócio | Filial |
01 | 01 | 010 | 01 |
01 | 01 | 010 | 02 |
01 | 02 | 010 | 01 |
01 | 02 | 020 | 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 | Filial | Tabela Protheus |
Customer | Exclusivo | Compartilhado | SA1 |
Vendor | Exclusivo | Compartilhado | SA2 |
Item | Exclusivo | Compartilhado | SB1 |
5. Clique em atualizar Base de Dados para salvar as alterações.
Observações :
1: Independentemente se for utilizado produto global no RM, a tabela referente no Protheus deve ser exclusiva por empresa, ficando a cargo do RM replicar os produtos globais para cada filial no Protheus.
2: Mesmo que a empresa não utilize Cliente/Fornecedor global no RM, deve-se compartilhar a tabela referente no Protheus por empresa. Será enviado concatenado ao código do cliente/fornecedor o código da coligada, conforme a mascara “[CODCOLIGADA]|[CODCFO]”.
Alterar o Dicionário de Dados - inicializar os campos SA_COD de Cliente e Fornecedor
1: Acessar o Protheus , Módulo SigaCFG.
2: Acessar : Base de dados / Dicionário / Bases de Dados.
3: Acessar : Empresas / Dicionario de dados.
4: Pesquisar por SA1.
5: Selecione a tabela e clique em Editar.
6: Acesse : Clientes / Campos.
7: Pesquisar pelo campo código do cliente (A1_COD).
8: Selecionar o campo A1_COD e clicar no ícone Editar.
9: Informar o valor GETSXENUM(“SA1”, “A1_COD”) ao campo Inic.Padrão localizado na aba Opções e Confirmar.
10: Pesquisar pela Tabela SA2.
11: selecionar a Tabela e clicar no ícone Editar .
12: Acessar: Fornecedores / Campos .
13: Selecionar o campo A2_COD e clicar em Editar .
14: Informar o valor GETSXENUM(“SA2”, “A2_COD”) ao campo Inic.Padrão localizado na aba Opções e Confirmar.
Alterar o Dicionário de Dados - inicializar os campos SA_LOJA de Cliente e Fornecedor
1: Acessar o Protheus , Módulo SigaCFG
2: Acessar: Base de dados / Dicionário / Bases de Dados.
3: Acessar: Empresas / Dicionario de dados.
4: Pesquisar por SA1 . Selecione a tabela e clique em editar.
5: Clique em Editar.
6: Acesse : Clientes / Campos.
7: Pesquisar pelo campo do cliente (A1_LOJA).
8: Selecionar o campo A1_LOJA e clicar no ícone Editar.
9: Informar o valor “01” (As aspas são necessárias) ao campo Inic.Padrão localizado na aba Opções e Confirmar.
10: Pesquisar pela Tabela SA2.
11: Selecionar a Tabela e clicar no ícone Editar.
12: Acessar: Fornecedores / Campos .
13: Selecionar o campo A2_Loja e clicar em Editar.
14: Informar o valor “01” (As aspas são necessárias) ao campo Inic.Padrão localizado na aba Opções e Confirmar.
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 |
Sim | MATA010 | Item | Produto | Não | Sim | Síncrono | Todas | EAI | MATI010 |
Sim | MATA020 | CustomerVendor | Fornecedor | Não | Sim | Síncrono | Todas | EAI | MATI020 |
Sim | MATA030 | CustomerVendor | Cliente | Nâo | Sim | Síncrono | Todas | EAI | MATI030 |
Configuração do De-Para para as Empresas e Filiais
O cadastro de Empresas e Filiais deve ser feito manualmente no PROTHEUS, atraves 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 mais detalhes sobre as configurações do Protheus , acese os Boletins Técnicos.
Opcional
Protótipo de Tela
<Caso necessário inclua protótipos de telas com o objetivo de facilitar o entendimento do requisito, apresentar conceitos e funcionalidades do software>.
Protótipo 01
Opcional
Fluxo do Processo
<Nesta etapa incluir representações gráficas que descrevam o problema a ser resolvido e o sistema a ser desenvolvido. Exemplo: Diagrama - Caso de Uso, Diagrama de Atividades, Diagrama de Classes, Diagrama de Entidade e Relacionamento e Diagrama de Sequência>.
Opcional
Dicionário de Dados
Arquivo ou Código do Script: AAA – Negociação Financeira / *Versao=CP.2014.12_03*/
Índice | Chave |
01 | <FI9_FILIAL+FI9_IDDARF+FI9_STATUS> |
02 | <FI9_FILIAL+FI9_FORNEC+ FI9_LOJA+FI9_EMISS+FI9_IDDARF> |
03 | <FI9_FILIAL+FI9_FORNEC+ FI9_LOJA+FI9_PREFIX+FI9_NUM+FI9_PARCEL+FI9_TIPO> |
Campo | <AAA_PERESP> |
Tipo | <N> |
Tamanho | <6> |
Valor Inicial | <Varia de acordo com o tipo informado. Por exemplo, quando o campo “tipo” for date, neste campo pode ser informado uma data>. |
Mandatório | Sim ( ) Não ( ) |
Descrição | <Referência Mínima para Cálculo> |
Título | <Ref.Calc.> |
Picture | <@E999.99> |
Help de Campo | <Informar o % que o aluno pagará em dinheiro. Esse % poderá ser alterado durante a negociação> |
(Opcional)
Grupo de Perguntas
<Informações utilizadas na linha Protheus>.
Nome: FINSRF2
X1_ORDEM | 01 |
X1_PERGUNT | Emissão De |
X1_TIPO | D |
X1_TAMANHO | 8 |
X1_GSC | G |
X1_VAR01 | MV_PAR01 |
X1_DEF01 | Comum |
X1_CNT01 | '01/01/08' |
X1_HELP | Data inicial do intervalo de emissões das guias de DARF a serem consideradas na seleção dos dados para o relatório |
(Opcional)
Consulta Padrão
<Informações utilizadas na linha Protheus>
Consulta: AMB
Descrição | Configurações de Planejamento |
Tipo | Consulta Padrão |
Tabela | “AMB” |
Índice | “Código” |
Campo | “Código”; ”Descrição” |
Retorno | AMB->AMB_CODIGO |
(Opcional)
Estrutura de Menu
<Informações utilizadas na linha Datasul>.
Procedimentos
Procedimento |
|
|
|
Descrição | (Max 40 posições) | (Max 40 posições) | (Max 40 posições) |
Módulo |
|
|
|
Programa base |
|
|
|
Nome Menu | (Max 32 posições) | (Max 32 posições) | (Max 32 posições) |
Interface | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex |
Registro padrão | Sim | Sim | Sim |
Visualiza Menu | Sim/Não | Sim/Não | Sim/Não |
Release de Liberação |
|
|
|
Programas
Programa |
|
|
|
Descrição | (Max 40 posições) | (Max 40 posições) | (Max 40 posições) |
Nome Externo |
|
|
|
Nome Menu/Programa | (Max 32 posições) | (Max 32 posições) | (Max 32 posições) |
Nome Verbalizado[1] | (Max 254 posições) | (Max 254 posições) | (Max 254 posições) |
Procedimento |
|
|
|
Template | (Verificar lista de opções no man01211) | (Verificar lista de opções no man01211) | (Verificar lista de opções no man01211) |
Tipo[2] | Consulta/Manutenção/ Relatório/Tarefas | Consulta/Manutenção/ Relatório/Tarefas | Consulta/Manutenção/ Relatório/Tarefas |
Interface | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex |
Categoria[3] |
|
|
|
Executa via RPC | Sim/Não | Sim/Não | Sim/Não |
Registro padrão | Sim | Sim | Sim |
Outro Produto | Não | Não | Não |
Visualiza Menu | Sim/Não | Sim/Não | Sim/Não |
Query on-line | Sim/Não | Sim/Não | Sim/Não |
Log Exec. | Sim/Não | Sim/Não | Sim/Não |
Rotina (EMS) |
|
|
|
Sub-Rotina (EMS) |
|
|
|
Localização dentro da Sub Rotina (EMS) |
|
|
|
Compact[4] | Sim/Não | Sim/Não | Sim/Não |
Home[5] | Sim/Não | Sim/Não | Sim/Não |
Posição do Portlet[6] | 0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right | 0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right | 0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right |
Informar os papeis com os quais o programa deve ser vinculado |
|
|
|
Cadastro de Papéis
<O cadastro de papéis é obrigatório para os projetos de desenvolvimento FLEX a partir do Datasul 10>.
<Lembrete: o nome dos papeis em inglês descrito neste ponto do documento, devem ser homologados pela equipe de tradução>.
Código Papel | (máx 3 posições) |
Descrição em Português* |
|
Descrição em Inglês* |
|
[1] Nome Verbalizado é obrigatório para desenvolvimentos no Datasul 10 em diante.
[2] Tipo é obrigatório para desenvolvimento no Datasul 10 em diante
[3] Categorias são obrigatórias para os programas FLEX.
[4] Obrigatório quando o projeto for FLEX
[5] Obrigatório quando o projeto for FLEX
[6] Obrigatório quando o projeto for FLEX
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|