Linha Datasul

Árvore de páginas

Versões comparadas

Versão antiga 16

changes.mady.by.user Paulo Ricardo Pacher

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Tatiana Cristine da Rocha

Gravado em

Chave

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


01. DADOS GERAIS

Produto:

Solucoes_totvs_cross
SolucaoCrossTOTVS Backoffice

Linha de Produto:

Linhas_totvs
LinhaLinha Datasul

Segmento:

Segmentos_totvs
SegmentoBackoffice

Módulo:

Modulos_cross_segmentos
ModulosCrossSegmentosTOTVS Backoffice (Linha Datasul) - Obrigações Fiscais (MOF)

Função:

Cenários Automatização Eventos -html.mcd.cenarioEventoTributos

Agendar Geração Automática de Eventos -html.mcd.agendadorEventoTributos

País:Brasil
Requisito/Story/Issue (informe o requisito relacionado) :

DBACKRTDTS-6700, DBACKRTDTS-6715, DBACKRTDTS-6716, DBACKRTDTS-6717, DBACKRTDTS-6718, DBACKRTDTS-6726, DBACKRTDTS-6729, DBACKRTDTS-6730


02. SITUAÇÃO/REQUISITO

Com a entrega do programa Embora o programa Evento Tributos (html.mcd.eventoTributos, permitindo aos usuários a criação individual (por documento) dos eventos da RT, surgiu a necessidade de permitir a geração em lote dos mesmos, deixando ) permita a gestão individual por documento, a implementação da geração em lote é fundamental para escalar a operação. Essa evolução mitiga o risco de erros manuais e garante a conformidade fiscal em larga escala, tornando o processo de entrega significativamente mais ágil e seguro.

03. SOLUÇÃO

Para suprir esta necessidade, foi criado um novo programa para permitir a criação de cenários de automatização dos eventos e a viabilizar a geração em lote dos mesmos, listando os documentos fiscais baseando-se nas regras dos cenários configurados.

Cada evento será gerado com base na origem (fiscal, recebimento, faturamento, …) configurada no cenário.

03. SOLUÇÃO

, a solução foi estruturada em duas frentes: o Cenário Automatização Eventos (html.mcd.cenarioEventoTributos), que centraliza a inteligência das regras e cenários fiscais, e o Agendar Geração Automática de Eventos (html.mcd.agendadorEventoTributos), que garante a execução programada e automática desses processos.

Essa arquitetura é suportada por uma atualização no banco de dados (novos campos, índices e tabelas), assegurando rastreabilidade eperformance.

A nova estrutura garante que a geração em lote seja feita de forma ágil, segura e totalmente alinhada às exigências da Reforma TributáriaDesenvolvido o programa html.mcd.cenarioEventoTributos, que permite a criação de cenários que serão utilizados para a geração automática dos eventos da RT.


:

Totvs custom tabs box
tabsDicionário, Cenários Automatização Eventos, PlanilhaAgendador Evento Tributos
idsdicionario,cenarios,planilhaagendador
Criado o campo log-tp-gerac na tabela evento-trib-dfe:

Totvs custom tabs box items
defaultyes
referenciadicionario


Para possibilitar a geração automática dos eventos, foram realizadas as seguintes alterações no dicionário de dados: 


1) Tabela evento-trib-dfe, criado novo o campo para identificar se evento foi criado a partir do cenário: 

Foram realizadas alterações de tabelas e criação de novas tabelas para suprir as necessidades de automatização dos novos eventos:

Totvs custom tabs box
tabsAlterações de Dicionário, cenario-evento-trib, cenario-regras-evento-trib, hist-evento-trib, agenda-evento-trib
idsalteracoes,cenarioevento,cenarioregras,hist,agenda
Totvs custom tabs box items
defaultyes
referenciaalteracoes
Field NameData TypeFormatLabelColumn LabelDescripton/Help TextMandatory
log-tp-geracLogicalYES/NOGerado cenárioGerado cenárioGerado cenárioNO


Criados

índices na tabela evento-trib-dfe para os campos log-gerac-auto e log-tp-gerac:

novos índices: 

Index NameField Name
Índice 
log-gerac-autolog-gerac-auto
Índice 
log-tp-geraclog-tp-gerac
Criadas as tabelas


2) Criado novas tabelas para permitir a geração automática:


Tabela cenario-evento-trib

, cenario-regras-evento-trib, hist-evento-trib, agenda-evento-trib (Conferir nas abas acima)
Totvs custom tabs box items
defaultno
referenciacenarioevento
DatabaseTable NameLabelDescription
mgindcenario-evento-trib
DatabaseTable NameLabelDescription
mgindcenario-evento-tribCenários Eventos
Cenários Eventos
TributosCadastro de cenários para automatização da geração dos eventos
Field NameData TypeFormatLabelColumn LabelDescripton/Help TextMandatoryObservação
num-id-cenarioDecimal>>>>>>>>>9Código cenárioCenárioCódigo do cenárioYESNúmero sequencial (autoincremento)
cod-eventoCharacterx(8)EventoEventoCódigo do eventoYESExemplo: 112110, 211110, 211130
modulo-orig-infoCharacterx(5)Módulo origemMóduloMódulo origem da informaçãoYESExemplo: MOF, MRE, MFT
status-cenarioLogicalYES/NOStatusStatusCenário ativo ou inativoYESYES - Ativo / NO - Inativo
Índice primário
idx-cen-eventonum-id-cenario


Índice secundário
idx-cen-evento-2cod-evento | modulo-orig-info | status
totvs


Tabela cenario-

custom

regras-

tabs-box-items
defaultno
referenciacenarioregras

evento-trib: 

DatabaseTable NameLabelDescription
mgindcenario-regras-evento-tribRegras cenários eventos tributosCadastro das regras de cenários para automatização da geração dos eventos
Field NameData TypeFormatLabelColumn LabelDescripton/Help TextMandatoryObservação
num-id-cenarioDecimal>>>>>>>>>9CenárioCenárioCódigo do cenárioYESCódigo do registro "pai"
num-id-regraDecimal>>>>>>>>>9RegraSequênciaSequência da regraYESNúmero sequencial (autoincremento)
data-inicialDatedd/mm/aaaaData inicialDt InicialData inicial de validade da regraYES
data-finalDatedd/mm/aaaaData finalDt FinalData final de validade da regraNO
cod-estabelCharacterx(5)EstabelecimentoCod EstabCódigo do estabelecimentoNO
cod-emitenteInteger>>>>>>>>9EmitenteEmitenteEmitente do documento. Cliente ou FornecedorNO
cod-fin-nfeInteger>9Finalidade NFeFin. NFeFinalidade de emissão da NF-eNO
cod-tipo-nf-cred-debInteger99Tipo NF Cred/DebTp NF Cred/DebTipo de nota fiscal de crédito e débitoNO
nat-operacaoCharacterx(6)Nat. operaçãoNat. Oper.Natureza de operaçãoNO
it-codigoCharacterx(16)ItemItemCódigo do ItemNO
cod-cclass-tribCharacterx(9)Código classificação tributáriaCod. Class. Trib.Código Classificação TributáriaNO
cod-cred-presCharacterx(10)Código crédito presumidoCod. Cred. PressCódigo Crédito PresumidoNO
cod-class-fiscCharacter9999.99.99Classificação fiscalClassif. FiscalClassificação Fiscal (NCM)NO
cod-nbsCharacterx(20)Código NBSCód. NBSCódigo NBSNO
cod-cta-patCharacterx(18)Conta patrimonialConta PatrimonialCódigo Conta PatrimonialNO
cod-mod-dfeCharacterx(5)Modelo do documento fiscal eletrônicoModelo DFeCódigo do modelo do documento fiscal eletrônicoNO
envio-autoLogicalYES/NOEnvia automanticamenteEnvio AutoEnviar evento automaticamenteYESINITIAL NO
Índice primário
idx-cen-regra

num-id-cenario | num-id-regra



Índice secundário
idx-regra-validadedata-inicial | data-final
idx-regra-estabcod-estabel
idx-regra-EMITcod-emitente
idx-regra-ativocod-cta-pat
idx-regra-doccod-fin-nfe | cod-tipo-nf-cred-deb | nat-operacao
idx-regra-itemit-código | cod-cclass-trib | cod-cred-pres | cod-class-fisc | cod-nbs
totvs


Tabela hist-

custom-tabs-box-itemsdefaultnoreferenciahist

evento-trib: 

DatabaseTable NameLabelDescription
mgindhist-evento-tribHistórico Eventos TributosHistórico de alterações cadastrais de cenários e regras dos eventos
Field NameData TypeFormatLabelColumn LabelDescripton/Help TextMandatoryObservação
dat-alteracaoDate99/99/9999Data AlteraçãoData AlteraçãoData da AlteraçãoYES
cod-hora-alterCharacter99:99:99Hora AlteraçãoHora AlteraçãoHora da AlteraçãoYES
cod-eventoCharacterx(8)EventoEventoCódigo do eventoYESExemplo: 112110, 211110, 211130
nome-tabelaCharacterx(30)Nome TabelaNome TabelaNome da tabela alteradaYES
cod-campoCharacterx(30)Field Name CampoField Name CampoField Name do CampoYES
cod-usuarioCharacterx(20)Código UsuárioCódigo UsuárioCódigo do usuário logadoYES
num-id-cenarioCharacterx(20)Código cenárioCódigo cenárioCódigo cenárioYES
num-id-regraCharacterx(20)Código sequência regraCódigo sequência regraCódigo sequência regraNO
cod-label-campoCharacterx(50)Label CampoLabel CampoLabel do CampoNO
cod-conteudo-iniCharacterx(300)Conteúdo InicialConteúdo InicialConteúdo inicial do campo, antes da alteraçãoNO
cod-conteudo-finCharacterx(300)Conteúdo FinalConteúdo FinalConteúdo final do campo, após a alteraçãoNO
Índice primário
idx-hist-1

dat-alteracao | cod-hora-alter | num-id-cenario | num-id-regra | cod-campo



Índice secundário
idx-hist-2nome-tabela | cod-usuario
totvs


Tabela agenda-

custom-tabs-box-items

evento-trib:

defaultno
referenciaagenda
DatabaseTable NameLabelDescription
mgindagenda-evento-tribAgendamento Eventos TributosGestão dos agendamentos para geração automática dos Eventos
Field NameData TypeFormatLabelColumn LabelDescripton/Help TextMandatoryObservação
cod-eventoCharacterx(8)EventoEventoCódigo do eventoYESExemplo: 112110, 211110, 211130
dt-cria-agendaDatedd/mm/aaaaData agendamentoData agendamentoData em que foi realizado o agendamentoNO
cod-hora-agendaCharacter99:99:99Hora agendamentoHora agendamentoHora em que foi realizado o agendamentoNO
cod-estabelCharacterx(5)EstabelecimentoCod EstabCódigo do estabelecimentoYES
periodo-execucaoInteger>9PeríodoPeríodoPeríodo dos documentosNO1 - Dia anterior, 2 - Últimos 7 dias, 3 - Mês anterior (fechado), 4 - Hoje, 5 - Mês atual (até hoje)
num-ped-hojeInteger>>>>>>>>>9Número PedidoPedidoNúmero PedidoYESNúmero do pedido que será gerado na data de hoje.
num-ped-hoje-idCharacterx(50)Número Pedido IDPedido IDNúmero Pedido IDYES
num-ped-recorrenteInteger>>>>>>>>>9Número Pedido RecorrênciaPed. Recor.Número Pedido RecorrênciaNO
num-ped-recorrente-idCharacterx(50)Número Pedido Recorrência IDPed. Reco. IDNúmero Pedido Recorrência IDNO
Índice primário
idx-agend-eventcod-evento, cod-estabel


Índice secundárioCampos
idx-agend-estabcod-estabel
idx-pedidonum-ped-hoje
idx-pedido-idnum-ped-hoje-id
idx-recorrencianum-ped-recorrente
idx-recorrencia-idnum-ped-recorrente-id

Listagem

Foi desenvolvido o programa

Cenários Automatização Eventos,

que permite cadastrar os cenários e regras que serão utilizados para a geração automática dos eventos.

(html.mcd.cenarioEventoTributos) - Cenários Automatização Eventos:

Image Removed

Ao selecionar registros na tabela da listagem, o botão Remover é habilitado. Ao acionar o botão Remover será apresentada uma tela para conferência dos registros que solicita uma confirmação da ação de exclusão dos registros. Caso selecionado 

A solução oferece autonomia na parametrização da busca de documentos eletrônicos, permitindo ajustes conforme o tipo de evento e as particularidades de cada estabelecimento.


1) Listagem:

Na listagem é apresentado a lista de todos os cenários que foram inseridos na base, contendo as ações de Editar ou Duplicar um cenário já existente. 

Image Added
















2) Botão Remover:

Ao selecionar algum registro na listagem, o botão Remover é habilitado, e se acionado será apresentada uma lista para conferência dos registros para exclusão. 

Caso selecionado Sim, os registros são excluídos do sistema e a listagem é atualizada. Caso selecionado Não, nenhuma alteração é realizada e o usuário retorna para a listagem dos registros.

Image Modified 

Formulário de Inclusão/Edição

O formulário de inclusão de cenários pode ser acessado a partir da listagem pelo botão Novo cenário. Este botão irá redirecionar o usuário para a tela de inclusão de cenários:











3) Botão Histórico:

Ainda na listagem, é possível visualizar o histórico de atividade como inclusão, edição e exclusão nos cenários. Para isto, basta acionar o botão Histórico e será apresentado a lista do histórico de atividade em cenários.

É  possível também filtrar as atividades por meio do botão Busca avançada, filtrando por data inicial e final da alteração, usuário e cenário. 

Image Added

Image Added













4) Inclusão e Edição:

É possível realizar a inclusão de cenários através do botão Novo cenário, a partir da listagem. Este botão irá redirecionar o usuário para a tela de inclusão de cenários:


Quanto a tela de inclusão, existem

Quanto a tela de inclusão, existem

alguns comportamentos a serem destacados:

  • Cenário: o campo Cenário é um campo de sequência para controle interno dos cenários, portanto, não pode ser alterado e é carregado automaticamente ao abrir a tela;
  • Evento: o campo Evento possui, no momento, a possibilidade de incluir três eventos:
 211110,
  •  211110,  211128 e 211130. O campo Módulo origem é carregado conforme o evento escolhido.
  • Módulo origem: o campo Módulo origem determina quais são os parâmetros para inclusão e listagem das regras. No momento, apenas três módulos estão disponíveis: Ativo Fixo, Obrigações Fiscais e Recebimento.
  • Status: o campo Status indica se o cenário está ativo ou não. Só é possível cadastrar um cenário ativo por evento e não é possível ter mais de um cenário ativo com o mesmo evento para diferentes módulos.

O formulário de edição apresenta os mesmos campos que o formulário de inclusão, porém os campos Evento e Módulo origem não podem ser alterados. O formulário de edição pode ser acessado a partir do ícone de lápis presente nos registros da listagem principal.

Image Removed

As colunas da listagem de regras são alteradas conforme o módulo que foi selecionado:

  • Módulos Recebimento, Faturamento e Obrigações Fiscais: Regra, Data Inicial, Data Final, Estabelecimento, Emitente, Natureza de Operação e Item.
  • Módulo Ativo Fixo: Regra, Data Inicial, Data Final, Estabelecimento e Conta Patrimonial.

Image Removed

Os campos do formulário de inclusão e edição de regras também são condicionados pelo módulo de origem escolhido:

Módulos Recebimento, Faturamento e Obrigações Fiscais: Regra, Data Inicial, Data Final, Estabelecimento, Emitente, Finalidade NF-e, Tipo de nota fiscal de crédito e débito, Natureza de Operação, Item, Código Classificação Tributária, Código Crédito Presumido, Classificação Fiscal (NCM) e Código NBS


Totvs custom tabs box items
defaultno
referenciacenarios


Cenários Automatização Eventos (html.mcd.cenarioEventoTributos)


Totvs custom tabs box
tabsListagem,Formulário de Inclusão/Edição,Geração
idslistagem,params,execucao
Totvs custom tabs box items
defaultyes
referencialistagem
Totvs custom tabs box items
defaultno
referenciaparams
Informações
titleImportante!


Status do cenário

Pode ser cadastrado mais de um cenário para o mesmo evento, desde que esteja com o Status Inativo, pois apenas um cenário pode estar com o Status ativo.

Caso tente cadastrar um novo cenário, para um evento que já possui cenário ativo, ocorrerá mensagem de erro em tela "Não é permitido cadastrar um cenário ativo para um mesmo evento com outro módulo de configurado", ou "Já existe um cenário cadastrado para o mesmo evento e módulo de origem com status ativo".

O cenário que será considerado na geração dos eventos será o cenário com Status ativo.


O formulário de edição apresenta os mesmos campos que o formulário de inclusão, porém os campos Evento e Módulo origem não podem ser alterados. O formulário de edição pode ser acessado a partir do ícone de lápis presente nos registros da listagem principal.

Image Added














4.1) Cadastro/Manutenção de regras: 

Para cada cenário pode existe várias regras, pois o sistema oferece autonomia na configuração de buscas de documentos eletrônicos, adaptando-se às necessidades de cada evento e estabelecimento.


4.1.1) Listagem:

As colunas da listagem de regras são alteradas conforme o módulo que foi selecionado:

  • Módulos Recebimento, Faturamento e Obrigações Fiscais: Regra, Data Inicial, Data Final, Estabelecimento, Emitente, Natureza de Operação e Item.
  • Módulo Ativo Fixo: Regra, Data Inicial, Data Final, Estabelecimento e Conta Patrimonial.

Image Removed

Caso já exista um cenário ativo para o evento que está sendo cadastrado, o formulário de regras não será aberto para inclusão de regras, evitando que o usuário realize todo o cadastrado antes de receber o erro.

O campo Regra é utilizado para controle interno e não pode ser alterado. Seu valor é calculado automaticamente pelo sistema. 
O campo Tipo de Nota Fiscal de Crédito e Débito só será habilitado caso a Finalidade NF-e escolhida seja NF-e Nota de Crédito ou NF-e Nota de Débito. As opções do campo são apresentadas conforme o tipo que foi escolhido.

Não é permitido cadastrar regras idênticas e caso o usuário cadastre uma regra genérica, isto é, com os campos marcados com a opção Todos, será exibido um alerta, no entanto, a inclusão irá ocorrer normalmente.

A edição de regra tem o mesmo comportamento da inclusão, com a diferença de que o campo Data Inicial ficará desabilitado. A edição pode ser acessada pelo ícone de lápis presente na listagem de regras.

Image Removed

Para excluir regras do cadastro, basta selecionar os registros desejados na tabela de listagem de regras e o botão Remover será habilitado. Ao acionar o botão Remover será apresentada uma tela para conferência dos registros que serão apagados solicitando uma confirmação da ação. Caso selecionado Sim, os registros são excluídos do sistema e a listagem é atualizada para refletir a nova configuração. Caso selecionado Não, nenhuma alteração é feita nos registros e o usuário volta para a tela de listagem.

Image Removed 

Importante! A efetivação do salvamento das regras no sistema irá ocorrer somente ao clicar no botão Salvar presente acima do formulário de cenários no canto superior direito da página. Enquanto isso, qualquer regra adicionada ou alterada não foi efetivada no sistema.

Totvs custom tabs box items
defaultno
referenciaexecucao

Geração:

O relatório pode ser executado de forma On-line, onde o arquivo é baixado no navegador, Batch, onde a geração do arquivo é executada via RPW e o arquivo salvo na pasta do servidor RPW, e também Central de Documentos, onde o arquivo é gerado na pasta do servidor.

Além disso, é possível escolher entre tipo de relatório Resumido, onde são apresentados os valores apenas a nível de documento, e Detalhado, onde são apresentados os valores a nível de documento e item do documento.

Image Removed

Informações
titleImportante!

Ao clicar em Gerar, o programa irá por padrão exibir a seguinte mensagem de aviso:

Image Removed

Totvs custom tabs box items
defaultno
referenciaplanilha
Totvs custom tabs box
tabsResumida, Detalhada
idsresumida,detalhada

Após a execução, será gerada a planilha Demonstrativo_Apurac_CBS_IBS.xml, junto com o arquivo de acompanhamento, conforme tipo de execução selecionado na tela de parametrização.

Totvs custom tabs box items
defaultyes
referenciaresumida

Para a execução Resumida, serão geradas apenas as abas de Parâmetros e Documento.

Image Removed

Image Removed

Totvs custom tabs box items
defaultno
referenciadetalhada

...

Image Added


4.1.2) Inclusão e Edição:

Os campos do formulário de inclusão e edição de regras também são condicionados pelo módulo de origem escolhido:

  • Módulos Recebimento, Faturamento e Obrigações Fiscais: Regra, Data Inicial, Data Final, Estabelecimento, Emitente, Finalidade NF-e, Tipo de nota fiscal de crédito e débito, Natureza de Operação, Item, Código Classificação Tributária, Código Crédito Presumido, Classificação Fiscal (NCM) e Código NBS.
  • Módulo Ativo Fixo: Regra, Data Inicial, Data Final, Estabelecimento e Conta Patrimonial.

Image Added

















Quanto a tela de inclusão e edição de regras, existem alguns comportamentos a serem destacados:

  • O campo Regra é utilizado para controle interno e não pode ser alterado. Seu valor é calculado automaticamente pelo sistema.
  • O campo Tipo de Nota Fiscal de Crédito e Débito só será habilitado caso a Finalidade NF-e escolhida seja NF-e Nota de Crédito ou NF-e Nota de Débito. As opções do campo são apresentadas conforme o tipo que foi escolhido.
  • A edição de regra tem o mesmo comportamento da inclusão, com a diferença de que o campo Data Inicial ficará desabilitado. A edição pode ser acessada pelo ícone de lápis presente na listagem de regras.

Image Added













Para realizar o cadastro das regras, é fundamental compreender como o sistema as aplica na seleção dos documentos candidatos à geração de eventos.
A seguir, detalhamos esse funcionamento de forma simplificada.

As regras são formadas por filtros aplicados nos documentos fiscais.
Para que um documento seja considerado, ele precisa atender todos os filtros ao mesmo tempo.

🧩 Como o sistema avalia os documentos?

O sistema analisa o documento fiscal em 2 camadas:

📘 1. Capa do Documento

  • Estabelecimento
  • Emitente 
  • Finalidade NFE 
  • Tipo NF crédito/débito 
  • Natureza de operação 

📦 2. Itens do Documento

  • Código do item 
  • Classificação tributária 
  • Código NBS 
  • Classificação tributária 
  • Crédito presumido 
  • Conta patrimonial* (foi criado para uso no evento 211130 somente).

🔐 Regra de Ouro: condição “E”

👉 O documento só será listado se atender TODOS os critérios configurados.

🧪 Exemplo prático

🎯 Configuração da regra:

  • Estabelecimento = 1
  • Item = .compras
  • Crédito Presumido = 4

Image Added

👁️ O que é listado?


Situação do EventoResultado exibido

🔹 Evento não utiliza itens. Ex: Evento 211128

Mostra apenas a capa do documento

🔹 Evento utiliza itens.  Ex: Evento 211110

Mostra a capa +  itens filtrados

✔️ Documento listado : → Atendeu todos os filtros

❌ Documento não listado : → Falhou em pelo menos um filtro

🧠 Dica importante

Se um documento não apareceu, verifique:

  • ✔️ Capa (estabelecimento, emitente, etc.)
  • ✔️ Itens e tributos da RTC CBS/IBS (código, classificação, crédito presumido, cClassTrib)

👉 Todos precisam estar exatamente iguais ao que foi configurado na regra.


Informações
titleImportante!


Regra genérica

Caso o usuário cadastre uma regra genérica, isto é, com os campos marcados com a opção Todos, será exibido um alerta "Atenção! Não é recomendado criar regras genéricas, pois podem gerar eventos para todos os documentos", no entanto a inclusão irá ocorrer normalmente.


4.1.3) Botão Remover:

Ao selecionar algum registro na listagem, o botão Remover é habilitado, e se acionado será apresentada uma lista para conferência dos registros para exclusão. 

Caso selecionado Sim, os registros são excluídos do sistema e a listagem é atualizada. Caso selecionado Não, nenhuma alteração é realizada e o usuário retorna para a listagem dos registros.

Image Added 










Informações
titleImportante!


Salvar inclusão ou edição de regras 

A efetivação do salvamento das regras no sistema irá ocorrer somente ao clicar no botão Salvar presente acima do formulário de cenários no canto superior direito da página. Enquanto isso, qualquer regra adicionada ou alterada não foi efetivada no sistema.


4.1.4) Botão Histórico: 

É possível visualizar um histórico de atividade nas regras dos cenários por meio do botão Histórico. Ao acionar o botão, é apresentada uma tela com a atividade nas regras dos cenários de automatização de eventos. 

Image Added


Totvs custom tabs box items
defaultno
referenciaagendador

 

Agendar Geração Automática de Eventos (html.mcd.agendadorEventoTributos)


Foi desenvolvido um programa que permite o agendamento da geração automática dos eventos, seguindo os cenários e regras pré-definidos. Vale ressaltar que o sistema processa apenas as regras do cenários com status Ativo. Ao final de cada execução, será gerado um relatório em Excel para conferência dos documentos eletrônicos e eventos processados.


1) Listagem:

Na listagem é apresentado a lista de todos os agendamentos do tipo Oficial, contendo a ação de eliminar o agendamento.   

Image Added


2) Botão Novo Agendamento:

O agendamento oferece dois tipos de execução, e para cada tipo de execução, os parâmetros da tela se adaptam:


Prévia: 

  • Esta opção não efetiva a criação os eventos e deve ser usada para conferencia e validação, dos documentos eletrônicos encontrados e dos eventos gerados. 
  • A geração prévia não cria o agendamento na listagem da tela principal. Quando o geração é solicitada pelo botão Gerar Agendamento RPW será apresentado uma mensagem em tela informando o numero do pedido, exemplo "Prévia gerada com sucesso! Acompanhe o pedido 272836 no programa Monitor de Pedidos";
  • O campo Evento possui, no momento, a possibilidade de geração para três eventos:  211110,  211128 e 211130;
  • A Data Inicial e Data Final é o período em que os documentos eletrônicos serão buscados para geração do evento. A data inicial e final deve ser no máximo um período de 1 mês, do contrário ocorrerá a mensagem de erro "O intervalo entre a Data Inicial e Data Final não pode ser superior a 1 mês".  

Image Added


Oficial:

  •  Esta opção efetiva a criação dos eventos em lote;
  • A geração oficial cria o agendamento na listagem da tela principal;
  • O campo Evento possui, no momento, a possibilidade de geração para três eventos:  211110,  211128 e 211130;
  • O campo Periodicidade é o período em que os documentos eletrônicos serão buscados para a geração do evento. As opção são: 
    • Dia anterior: É a data de ontem, exemplo: Hoje é 23/03/2026, para essa opção será a data de 22/03/2026 até 22/03/2026;
    • Últimos 7 dias: É o período de 7 dias atrás, exemplo: Hoje é 23/03/2026, para essa opção será a data de 16/03/2026 até 22/03/2026;
    • Mês anterior (fechado): É o período do mês anterior, exemplo: Hoje é 23/03/2026, para essa opção será a data de 01/02/2026 até 28/02/2026;
    • Hoje: É a data de hoje, exemplo: Hoje é 23/03/2026, para essa opção será a data de 23/03/2026 até 23/03/2026;
    • Mês atual (Até hoje): Será o mês atual até da data de hoje, exemplo: Hoje é 23/03/2026, para essa opção será a data de 01/03/2026 até 23/03/2026.

Image Added


Informações
titleImportante!


Geração Oficial

Poderá ser feito apenas um agendamento Oficial por Evento e Estabelecimento. Caso tente criar um agendamento do tipo Oficial para um mesmo Evento e Estabelecimento já criado, irá ocorrer a mensagem de erro. 

Para criar novo agendamento oficial, para um mesmo Evento e Estabelecimento já criado, o agendamento oficial deve ser primeiramente eliminado e então poderá criar um novo agendamento.   


3) Botão Atualizar:

Cada registro de agendamento na listagem há um um Status, podendo ser: 

  • Aguardando: Significa que a geração ainda está em espera na fila do RPW, ou processando a geração; 
  • Falha: Significa que ocorreu erro durante a geração dos eventos;
  • Concluído: Significa que o processamento foi concluído.

 Quando o agendamento está com o Status Aguardando na listagem, o botão Atualizar pode ser acionado para conferência do Status do pedido, e se o pedido já foi processado o status é atualizado na listagem, podendo ficar como Falha ou Concluído.


4) Botão Monitor de Pedidos:

Esse botão é um facilitador para a consultar os pedidos agendados no programa Monitor Pedidos Execução (HTML). O monitor será aberto já com o filtro aplicado, buscando pelo programa gerador dos eventos que é  "cdGeraEventosAuto", posicionando assim a listagem com os pedidos gerados a partir do programa Agendar Geração Automática de Eventos.


5) Ação de Remover: 

A ação de Remover, que consta na listagem do programa Agendar Geração Automática de Eventos, irá eliminar o agendamento da listagem e os agendamento recorrentes também. Ou seja, os pedidos para a geração dos eventos em lote serão eliminados lá servidor RPW.  

 

6) Relatório excel

Após cada pedido processado, será gerado uma planilha para acompanhamento no diretório SPOOL do servidor RPW um relatório excel com o nome "ConfDoctosEventosAuto+Ano+Mês+Dia+_+Hora+Min+Segundo".

Exemplo: ConfDoctosEventosAuto20260316_111101.xls 


Image Added


Como o processamento para geração dos eventos funcionará? 

  • Ao iniciar o processamento o produto irá buscar o cenário ativo e regras, de acordo com os parâmetros informados em tela;
    • A data inicial da regra deve ser menor/igual a data inicial da geração. Se a data final da regra for diferente de branco, e se a data final da regra for menor que a inicial da geração, então a regra deve ser desconsiderada.
  • Após localizar todas as regras, respeitando as datas, então as regras serão enviadas para para a API do módulo responsável.
    • O módulo responsável é o que foi informando durante o cadastro de cenário para o Evento em questão.
  • A API do módulo responsável, ou API da área, irá buscar todos os documentos eletrônicos, e itens do documentos dependendo do evento, para a geração dos eventos;
    • As notas fiscais eletrônicas devem estar lançadas dentro da base Datasul, para que sejam consideradas na busca da API da área.  
  • Se o tipo de geração for oficial, a criação dos eventos será efetivada na base, podendo ser consultados no programa Evento Tributos (html.mcd.eventoTributos);
  • Será gerado a planilha de conferência no diretório SPOOL do servidor RPW, contendo a listagem de erro, documentos, itens do documento, eventos e parâmetros. 


O relatório irá conter as abas: 

  • Inconsistências: Irá apresentar essa aba apenas se ocorrer alguma inconsistência durante o processamento, listando os erros encontrados;
  • Documentos: Irá apresentar essa aba apenas se encontrar os documentos eletrônicos, para a geração dos eventos, listando todos os documentos encontrados de acordo com as regras configuradas no programa Cenários Automatização Eventos (html.mcd.cenarioEventoTributos);
  • Itens do Docto: Irá apresentar essa aba apenas se encontrar os itens dos documentos eletrônicos, para a geração dos eventos que são pelos itens da nota, listando todos os itens encontrados de acordo com as regras configuradas no programa Cenários Automatização Eventos (html.mcd.cenarioEventoTributos);
  • Eventos:  Irá apresentar essa aba apenas se gerar os Eventos, de acordos com os documentos e itens do documentos (se houver conforme evento), listando todos os eventos gerados. 
  • Parâmetros: Essa aba sempre será apresentada, listando os parâmetros informados para o agendamento e geração dos eventos.   


Principais mensagens de erro apresentadas no relatório: 

  • Se não encontrar cenário cadastrado de acordo com os parâmetros informados em tela, irá gerar a mensagem de erro 58214 e abortará a geração;
  • Se não encontrar regras para o cenário encontrado de  acordo com os parâmetros informados em tela, irá gerar a mensagem de erro 58215 e abortará a geração;
  • Se não encontrar a API das áreas, irá gerar a mensagem de erro 58216 e abortará a geração;
  • Se não encontrar documentos conforme regras cadastradas para o cenário, irá gerar a mensagem de erro 58217 e abortará a geração.

 

Informações
titleImportante!


Inconsistências

Poderá ser apresentado outras mensagens de inconsistências, e todas as mensagens serão listadas na aba Inconsistências da planilha, garantindo a segurança da geração dos eventos em lote durante o processamento. 

 


04. ASSUNTOS RELACIONADOS

...