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 | TOTVS Gestão de Estoque, Compras e Faturamento | Módulo | Faturamento |
Segmento Executor | Construção e Projetos | ||
Projeto1 | Integração BackOffice RM x PDV Protheus | IRM1 | PCREQ-7769 |
Requisito1 | PCREQ-8878 | Subtarefa1 | PDR_CP_MOV009-103 |
Chamado2 |
Release de Entrega Planejada | 12.1.10 | Réplica | Não |
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
Implementação do adapter de integração via Mensagem Única TOTVS do Cancelamento de Cupom Fiscal. Este adapter irá viabilizar o recebimento da mensagem de Cancelamento do Cupom Fiscal (Venda e SAT) gerado pelo PDV PROTHEUS.
Definição da Regra de Negócio
Considera-se como escopo deste requisito a implementação do adapter de recebimento de Mensagens Únicas TOTVS para integração do cancelamento de Cupom Fiscal (Venda e SAT), estando o adapter de envio desta mesma mensagem fora do escopo do requisito.
A análise e o desenvolvimento do adapter será efetuado considerando a integração com o PDV Protheus, mas também viabilizará a integração com outras fontes de dados desde que respeitado o layout da mensagem.
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
Cupom Fiscal | Alteração | RM \ BackOffice \ Gestão de Estoque, Compras e Faturamento \ Cadastros \ Fiscais\ Mais...\ Cupom Fiscal | - |
Movimento | Alteração | RM \ BackOffice \ Gestão de Estoque, Compras e Faturamento \ Vendas \ Faturamento \ Movimentação | - |
Regras de Integridade
O Inclusão de Cupom Fiscal não pode ser excluído, tem que ser Cancelado. Sendo assim o Cancelamento do Cupom Fiscal será realizado quando a tag "IsCanceled" estiver com o Cancelado
Este cenário ocorre quando o cliente desiste da venda ainda no caixa. Para este cenário o PDV deverá enviar ao RM a mensagem RETAILSALES com a tag "IsCanceled" com valor igual a "true". O cupom cancelado será incluído sem a informação de pagamento, ou seja, serão preenchidos somente os dados de Cupom Fiscal e Item de Cupom Fiscal.
Observação: na inclusão do Cupom Fiscal Cancelado não é gerado Movimento para o cupom.
Item de Cupom Cancelado
Este cenário ocorre quando o cliente desiste de comprar algum item no momento da venda. Para este cenário o PDV deverá enviar ao RM a mensagem RETAILSALES com a tag "IsCanceled" com valor igual a "true" para o Item de Cupom.
Observação: O movimento gerado para o Cupom irá considerar somente os itens não cancelados.
Cupom Fiscal Cancelado
O Cupom Fiscal não pode sofrer alterações além do cancelamento. Sendo assim o PDV irá enviar a mensagem RETAILSALES com a tag "IsCanceled" com valor igual a "true".
ApósApós o recebimento da mensagem pelo EAI RM
,será consumido o
serviçoDataServer de
alteração do Cupom Fiscal.Serão realizadas as seguintes consistênciasCupom Fiscal onde serão preenchidos os dados da classe de parâmetro de Cancelamento de Cupom e realizado a seguinte consistência:
- O Cupom Fiscal a ser cancelado deve estar cadastrado
;- A coluna CANCELADO deve estar com valor igual a True;
- A coluna INTEGRAAPLICACAO deve receber o valor "SIGALOJA" para identificar que ele veio da integração.
Exemplo de Aplicação:
- Criar o campo “% Mínimo Espécie” (AAA_PERESP) onde o usuário informará o % que o aluno pagará em dinheiro. Esse % poderá ser alterado durante a negociação.
- Criar o campo “Referência Mínima para Cálculo” (AAA_REFCAL) onde o usuário informará um dos 4 valores disponíveis para pagamento das mensalidades como a referência mínima para calcular o débito total do aluno.
- Criar o parâmetro MV_ACPARNE que definirá se as informações de “% Mínimo Espécie” e “Referência Mínima para Cálculo” serão obrigatórias.
- O parâmetro MV_ACPARNE deve ter as seguintes opções: 1=Obrigatório e 2=Opcional. Deve ser inicializado como opcional>.
Tabelas Utilizadas
- TCUPOMFISCAL – Cupom Fiscal
- TCUPOMFISCALITM - Itens de Cupom Fiscal
- TCUPOMFISCALFIN - Pagamentos do Cupom Fiscal
Entidades de Integração
- DataServer envolvido
- MovCupomFiscalData
- Transformação
- Id: RetailSales
- Versão: 1_001
- SourceCode (Evento)
- GUID:
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 |
- .
Ao consumir o serviço de Cancelamento do Cupom Fiscal são executados no RM:
- Cancelamento do Movimento a Partir do Cupom Fiscal
- Consiste se existe movimento associado ao cupom fiscal.
- Consiste se o movimento associado ao cupom fiscal está cancelado.
- Preenche a classe de Cancelamento de Movimento (MovMovCancelamentoPar) com Motivo de Cancelamento igual a "Cancelamento de Cupom Fiscal" e Data Cancelamento igual a data atual do servidor.
- Executa o serviço de Cancelamento de Movimento.
- Cancelamento do Cupom Fiscal
- Atualiza a coluna CANCELADO da tabela TCUPOMFISCAL com o valor: 1 - Cupom Cancelado.
- Cancelamento do Movimento a Partir do Cupom Fiscal
Cupom Fiscal SAT Cancelado
O Cupom Fiscal do tipo SAT não pode sofrer alterações além do cancelamento. Sendo assim o PDV irá enviar a mensagem RETAILSALES com a tag "IsCanceled" com valor igual a "true".
Após o recebimento da mensagem pelo EAI RM será consumido o DataServer de Cupom Fiscal e quando o Tipo do Cupom for igual a SAT será recuperado o Identificador do Movimento referente ao Cupom SAT. O filtro a ser realizado para buscar o Identificador do Movimento referente ao Cupom SAT na tabela de Movimentos é: Código da Coligada e Chave de Acesso.
Serão preenchidos os dados da classe de parâmetro de Cancelamento de Cupom e consumido o serviço de Cancelamento do Cupom Fiscal.
Ao consumir o serviço de Cancelamento do Cupom Fiscal são executados no RM:
- Cancelamento do Movimento
- Consiste se existe movimento associado ao Cupom Fiscal SAT.
- Consiste se o movimento associado ao cupom fiscal SAT está cancelado.
- Preenche a classe de Cancelamento de Movimento (MovMovCancelamentoPar) com Motivo de Cancelamento igual a "Cancelamento de Cupom Fiscal", Data Cancelamento igual a data atual do servidor e Id do Movimento com o Identificador do Movimento SAT.
- Executa o serviço de Cancelamento de Movimento.
- Cancelamento do Movimento
Observação: Cupom Fiscal SAT está disponível a partir do release 12.1.14.
Entidades de Integração
- DataServer envolvido
- MovCupomFiscalData
- Transformação:
- Id: RetailSales
- Versão: 2.009
- SourceCode (Evento)
- GUID: 1efe6424-027b-44af-8dd3-ef18a527d6b6
Tabelas Utilizadas
- TCUPOMFISCAL – Cupom Fiscal
- TCUPOMFISCALITM - Itens de Cupom Fiscal
- TCUPOMFISCALFIN - Pagamentos do Cupom Fiscal
- TMOV - Movimentos
- TITMMOV - Itens de Movimento
Fluxo do Processo
Mapeamento de Campos
Mensagem: RetailSales 2.009 - mapeamento encontra-se disponível na especificação de Venda.
(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
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|