Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.




 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

 RM

Módulo

 Fiscal

Segmento Executor

 EducacionalServiços

Projeto1

REINF Integração RM X TAF

IRM1


Requisito1

FISCAL01-3559

Subtarefa1


Chamado2


Release de Entrega Planejada

12.1.20

Réplica: 12.1.18, 12.1.19


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>

Objetivo

Implementar Documentar as implementações do cadastro de controle das integrações das informações do RM para o TAF para a geração da REINF

Definição da Regra de Negócio

  • As informações serão geradas através do Gerador de Saídas em layout específico para este fim.
  • Os registros serão são gravados em uma tabela a ser criada que será especificada adiante neste documentotabela interna para posterior envio ao TAF (DINTEGRACAOTAF).
  • A visualização dos registros será feita através de cadastro a ser desenvolvido.
    • O cadastro deverá permitir permite a visualização dos registro registros em lista na qual poderão ser selecionados um ou mais registros para a  execução do processo de integração com o TAF
    • O cadastro deverá permitira permite a abertura dos registros somente para a visualização. Não será permitida a edição ou inclusão de registros .com exceção dos registros com Status "Image Added - Incluído" ou "Image Added - Registro integrado com erro"
  • Os registros desta visão deverão possuir possuem um anexo onde será é armazenado o log da integração, semelhante ao existente na visão de Notas Fiscais Eletrônicas.
  • Através deste cadastro será feita a integração das informações com o TAF.
    • Execução do processo para um único registro.
    • Execução do processo para mais de um registro ao mesmo tempo. 
  • Os registro ter seu Os registros terão seus status controlados de acordo com os processos executados. Eles
     Eles poderão assumir os seguintes valores:
    • 1 - Image Added Incluído: Status inicial do registro quando ele é gravado no banco de dados na tabela "DINTEGRACAOTAF"  e que ainda não foi integrado com o TAF. 
    • 2 - Alterado: Registro pré-existente que foi gravado novamente após o registro do RM que o originou ter sofrido alguma alteração. O registro com este status ainda não foi integrado novamente.
    • 3 - Registro integrado com sucesso com o TAF.
    • 4 - Registro integrado com sucesso com o TAF.
    • Image Added "Registro Enviado para o TAF" ou "Enviado Integração Banco x Banco":  O status deverá ser apresentado quando o registro  for enviado para a integração TAF via processos "Integração TAF - WebService - Envio" ou "Integração TAF - Banco x Banco".
    • Image AddedRegistro com erro na integração. O status é apresentado quando o registro integrado com o TAF apresentar erros de estrutura ou de validação realizado pelo TAF.
    • Image AddedRegistro integrado com sucesso com o TAF. O status é apresentado quando o registro for integrado com sucesso pelo TAF.
    • Image AddedRegistro integrado via banco de dados. O status é apresentado quando o registro for integrado com sucesso pelo TAF a partir da tabela TAFST1.
  • (Melhoria - Implementação futura) Cada registro deverá indicar sua origem conforme relação a ser criada com base nos registros do layout TAF conforme exemplo abaixo:
    • Registro TAF T001 - Complemento do Cadastro de Estabelecimentos  => Cadastro de Filiais no RM.
    • Registro TAF T013 - Cadastro de Documentos Fiscais => Lançamentos de Entrada/Saída no RM.
  • (Melhoria - Implementação futura) Deverá ser feito o controle dos registros do RM que já foram integrados para que no processo possa-se escolher integrar todos os registros, somente os não integrados ou somente os já integrados.
  • A manutenção desta tabela ficará a cargo do usuário. Quando a quantidade de registros existente nela for muito grande deverá ser feita a deleção manual dos mesmos(Melhoria - Implementação futura) Para que não sejam gerados problemas de performance a tabela que armazena os registros da integração será incluída no processo de Liberação de Período.
  • O envio das informações da REINF para a receita e controle de seus recibos será feito somente pelo TAF não sendo retornadas para o TOTVS Gestão Fiscal. 
  • O TOTVS Gestão Fiscal fará somente o controle das informações integradas com o TAF para a geração da REINF.

Especificação das tabelas a serem criadas para auxiliar o processo

Nome da Tabela: DINTEGRACAOTAF



Descrição do processo


Image Added




Processo "Geração de Registros - TAF Fiscal"


Este processo seleciona os lançamentos de acordo com os parâmetros passados para o Layout do Gerador de Saída e grava os dados selecionados na tabela DINTEGRACAOTAF. 


Primeiro deve-se importar para o sistema o Layout atualizado(na tela de Gerador de Saídas, disponibilizado no diretório de instalação do sistema. Vide exemplo: C:\TOTVS\CORPORERM\ObjetosGerenciais\Layout - TAF.TOTVSGEN)  para integração com o TAF. Ao executar o processo informe os parâmetros para seleção e demais informações solicitadas pelo layout.


DICA!!! Marque o campo "Gravar preferências do Usuário" para agilizar novas (re)gerações.




Image Added


Especificação das tabelas criadas para auxiliar o processo

Nome da Tabela: DINTEGRACAOTAFA tabela deverá ser criada com a mesma estrutura da TAFST1 para que não tenhamos de alterar o layout de integração banco X banco já existente. A tabela poderá ser alterada de acordo com necessidades surgidas no momento da implementação porém a existências destes campos é obrigatória para a comunicação com o webservice do TAF. 

Uma vez que os dados desta tabela serão são a ligação entre as informações do TOTVS Gestão Fiscal e o TAF não será permitida a exclusão dos mesmo. (Melhoria - Implementação futura) Para solucionar um possível problema com performance deverá ser criada uma tabela espelho desta (DINTEGRACAOTAFHIST) para que os registros desta tabela sejam transferidos via processo de Liberação de Período. 

varcharno40          noTAFCODMSGvarchar
CAMPOTIPOCOMPUTEDTAMANHOPRECISÃOSCALEPERMITE NULOTAFFILDESCRIÇÃO
CODCOLIGADAint-

nãoCódigo da Coligada
IDINTEGRACAOTAFint-

nãoID de Integração RM x TAF
TAFFILvarchar40no1          noTAFSEQvarcharno3          no
TAFTPREGvarcharno10          no
simEmpresa e Filial de integração
TAFCODMSGvarchar1TAFKEYvarcharno100          nonãoTipo da mensagem de integração
TAFSEQvarchar3TAFMSGtextno16          yes
TAFSTATUSvarcharno1          no
simSequencial da mensagem de integração
TAFTPREGvarcharTAFIDTHRDvarcharno10          nosimTipo do Registro a ser integrado
TAFKEYTAFTICKETvarcharno36100          noTAFDATAvarcharnosimChave do Registro a ser integrado
TAFMSGtext168          nosim
TAFHORAvarcharno8          no
Mensagem de integração
TAFSTATUSvarcharD_E_L_E_T_varcharno1          no
R_E_C_N_O_intno4100no
R_E_C_D_E_L_intno4100no

Observação: O tipo dos campos foram espelhados nas configurações da tabela TAFST1. Poderão ser alterados de acordo com os padrões da base do RM. O processo de integração deverá considerar os formatos exigidos pelo layout do TAF.

Índices sugeridos

NOMEDESCRICAOCHAVETAFST1_PKclustered, unique, primary key located on PRIMARYR_E_C_N_O_TAFST101nonclustered located on PRIMARYTAFFIL, TAFCODMSG, TAFSEQ, TAFKEY, R_E_C_N_O_, D_E_L_E_T_TAFST102nonclustered located on PRIMARYTAFSTATUS, TAFIDTHRD, TAFKEY, TAFSEQ, R_E_C_N_O_, D_E_L_E_T_TAFST103nonclustered located on PRIMARYTAFSTATUS, TAFCODMSG, TAFKEY, TAFSEQ, R_E_C_N_O_, D_E_L_E_T_TAFST104nonclustered located on PRIMARYTAFSTATUS, TAFIDTHRD, TAFTPREG, TAFTICKET, TAFKEY, TAFSEQ, R_E_C_N_O_, D_E_L_E_T_TAFST105nonclustered located on PRIMARYTAFTICKET, TAFKEY, R_E_C_N_O_, D_E_L_E_T_TAFST106nonclustered located on PRIMARYTAFFIL, TAFSTATUS, TAFCODMSG, TAFTICKET, TAFKEY, TAFSEQ, R_E_C_N_O_, D_E_L_E_T_
simStatus do Registro
TICKETCODEvarchar50

simCódigo do Lote do Registro
Observação: Estes índices são espelhados nas configurações da tabela TAFST1 e poderão ser alterados de acordo com os padrões da base RM.

Tabela de log da integração

Nome da Tabela: DINTEGRACAOTAFLOG

Nesta tabela devem ser serão gravados os registros referentes às tentativas de integração do registro RM com o TAF.

CAMPOTIPOTAMANHO
TAFKEYvarchar100
DESCRIÇÃO
CODCOLIGADAint

-

Código da Coligada
IDLOGint

-

Id do Log da Integração RM x TAF
DATALOGdatetime
Data do Log da Integração RM x TAF
CODIGOERROint
6
-Código do erro na Integração RM x TAF
MENSAGEMmemo

256

Log da Integração RM x TAF
IDINTEGRACAOTAFint-Sequencial do registro da DINTEGRACAOTAF


(Melhoria - Implementação futura) Observação: Esta tabela também deverá ser incluída no processo de Liberação de Período. Os registros serão gravados por este processo na tabela DINTEGRACAOTAFLOGHIST. Esta implementação será entregue em liberações futuras.


Parametrização


Para atender ao processo de integração das informações da REINF com o TAF será necessário que sejam criados alguns parâmetros que deverão ser preenchidos pelo usuário é necessário o preenchimento dos parâmetros para integração de acordo com o seu ambiente TAF.

Localização: Processo 03.05 - Integração | 03.05.04 05 - TAF

Servidor:  Onde o TAF está instalado (de onde o webservice da REINF é distribuído)

Porta:  Pota na qual o webservice da REINF escutaNão aconselho a criação de um parâmetro somente para digitar a url do webservice assim como foi feito no processo da NF-e. Em conversa com os analistas do RH fui informado que isto foi feito por eles e agora estão alterando o parametrizador pois estão sendo criados outros webservices para o e-social e da forma que estava teriam de criar um parâmetro para cada webservice. Desta forma no momento da chamada do webservice a url é montada em tempo de execução com os dados informados no parâmetro.

Usuário:  O mesmo utilizado para  login no TAF

Senha: A mesma utilizada para login no TAF

Tipo de ambiente: Homologação ou Produção

Sugestões de tela

Image Removed

          É obrigatório a informação de todos os parâmetros para que os registros sejam integrados com o TAF via WebService.

Tela

Image Added

obs.: Caso na Base de Dados não seja encontrado o Script com os Parâmetros da Integração com o TAF, será visualizada uma mensagem informando a inconsistência.

Image Added



O Cadastro


No Acesse o menu Obrigações Fiscais | Federais deverá ser criada uma entrada de Menu para a REINF com um TAF, o sub-menu "Integração RM X TAF

Image Removed

Para os registro deverá ser criado um anexo para armazenar as operações de integração e erros ocorridos.

Image Removed

A geração da integração (execução do layout TAF do gerador de saídas) poderá ser chamada pelo menu de processos do cadastro e também pelo menu Obrigações Acessórias | TAF. Avaliar a possibilidade de criação de um processo para a exportação do XML que será retornado pelo TAF pelo  

".

Image Added

O Log de integração é acessado através do Menu Anexos | Log da Integração do Registro.

Image Added


 Os registros não poderão ser editados ou excluídos, apenas visualizados conforme imagem abaixo.

Image Added



(Melhoria - Implementação futura) Marcar os lançamentos selecionados no processo como já exportados. Para isto deverá ser utilizado o campo DLAF.STATUSEXPORTFAZ.


Integração TAF - WebService - Envio 

  • Este processo chama o método POST do web service do TAF.
  • Se não houver nenhum registro selecionado na visão serão selecionados todos os registros com status Image Added - Incluído
  • Se houver registros selecionados somente estes serão integrados.
  • Após o envio o status do registro deverá ser alterado de acordo com o resultado da chamada do serviço.

Integração TAF - WebService - Consulta

  • Este processo chama o método GET do web service do TAF.
  • Se não houver nenhum registro selecionado na visão serão selecionados todos os registros com status Image Added "Registro Enviado para o TAF" ou "Enviado Integração Banco x Banco"
  • Se houver registros selecionados somente estes serão consultados.
  • Os registros consultados terão seu status alterado de acordo com o resultado da consulta.
  • Deverá ser verificada a necessidade de alterar o status dos Lançamentos Fiscais associados aos registros do TAF. (Melhoria - Implementação futura)


Integração TAF - WebService - Excluir (Melhoria - Implementação futura)

  • Este processo deve chamar o método DELETE do web service do TAF.
  • Este processo deve exigir a seleção de pelo menos um registro para ser executado para garantir que um clique indevido no menu apague todos os registros listados na visão.
  • Os registros processados com sucesso devem ser deletados da tabela de integração.

Integração TAF - Banco x Banco

  • Este Processo deve ser utilizado no caso de impossibilidade de uso do web service do TAF para integração dos registros.
  • Este processo consiste na gravação dos registros que estão na tabela de integração com o status "Image Added - Incluído" na tabela TAFST1. Os registros processados deverão: 
    • Permanecer gravados na tabela de integração e ter seu status alterados para Integrados via Banco de Dados
    • Ser gravados na tabela TAFST1 para posterior integração com o TAF.
    • Posteriormente ser consultados através do processo Integração TAF - WebService - Consulta

(Melhoria - Implementação futura)

  • Implementar a opção de integração ao TAF de um Lançamento Fiscal específico ou um intervalo. Este filtro poderá ser feito por data ou número do documento. Este processo poderá ser chamado pelo processos na visão de Lançamentos Fiscais de Entrada/Saída e também pela visão do novo cadastro criado para a integração com o TAF.
  • Integração on line de Lançamentos Fiscais. Ao salvar um registro de Lançamento Fiscal  gravar os registros correspondentes no layout de integração TAF. Verificar no layout de integração quais são os registros relacionados ao Lançamento Fiscal, como itens, CliFor, observação, etc. 

O web service de integração com o TAF

    • Para mais informações a respeito acesse: http://tdn.totvs.com.br/pages/viewpage.action?pageId=270904682
    • Para a integração dos registros deve-se chamar o método POST do webservice : O objetivo do método é enviar informações que devem ser gravadas na tabela transacional do TAF  ( TAFST2 ), permitindo que os dados sejam submetidos aos processos de integração.
    • Para consultar o status da integração deve-se chamar o método GET do webservice: O método GET retorna os status dos registros integrados de acordo com os parâmetros (atributos) enviados na URL.
    • Para deletar um registro ou conjunto de registros deve-se chamar o método DELETE: O método DELETE permite excluir toda a cadeia de integração de um TICKETCODE; Um ticket submetido a exclusão tem seus TAFKEYS avaliados, rastreados e excluídos, desde a sua inclusão na TAFST2 e TAFXERP até o cadastro no TAF caso já tenha ocorrido o Processamento. 
Image Removed

 Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico.