Descrição
A Integração Fiscal Online 3.0 foi desenvolvida para possibilitar a sincronização das informações de maneira mais ágil entre os sistemas Construshow e Fiscal, possibilitando uma conferência e acompanhamento mais assertivo das apurações de impostos e demais informações que são compartilhadas entre os sistemas por meio da integração.
⚠️Importante: Este manual aborda apenas a configuração da Integração Fiscal numa instalação do Construshow com TMS
Índice
| Table of Contents |
|---|
Pré-Requisitos
O módulo Fiscal deve estar instalado, atualizado e configurado corretamente no servidor.
As Configurações de Documento no Construshow devem estar parametrizadas para exportar para o módulo Fiscal.
Pelo menos um estabelecimento no módulo Fiscal deve estar ativo e configurado para uso.
É fundamental ter conhecimento sobre os parâmetros de exportação do SPED no módulo Fiscal.
Ao garantir o cumprimento desses pré-requisitos, a exportação do SPED poderá ser realizada com sucesso. No entanto, é importante destacar que a familiaridade prévia com o módulo Fiscal e suas funcionalidades é crucial para garantir que o processo seja executado sem problemas. Por isso, recomendamos que sejam realizados testes preliminares e que sejam seguidas as orientações específicas do manual de utilização do módulo Fiscal para a exportação do SPED e integração do Fiscal com o Construshow.
Passo a passo
Funcionamento
O envio para o Fiscal dos registros contidos nas filas de integração poderá ser disparado manualmente dentro do Construshow no menu Cadastros >> Agendador de Tarefas >> Status, ou automaticamente pelo serviço de Job de integração, conforme intervalo de acionamento previamente definido no Agendador de Tarefas.
A implementação tem como benefícios:
Automatizar o processo de envio possibilitando a escolha do melhor horário para que sejam exportadas as informações para o sistema Fiscal.
Padronização do envio de informação e mantendo a consistência independente da máquina ou usuário que esteja realizando as movimentações.
Envio para o sistema fiscal de documentos individualizados, assim não existindo mais a necessidade de gerar a informação diariamente.
Visão Geral:
1 - Instalação do Active MQ, Atualização do Fiscal.(Quando instalado ou atualizado o módulo fiscal para versões mais atuais já é instalado automaticamente o Active MQ)
2 - Configuração do arquivo de Integração Fiscal
3 - Configuração do Construshow (versão 2211 ou superior):
Menu Contábil/Fiscal >> Exportação Fiscal: Conferência das opções que estão marcadas na antiga rotina de Exportação Fiscal dentro do Construshow
menu Configurações Gerais >> Contábil/Fiscal >> Geral >> Botão Configurações: Definir as mesmas opções que foram conferidas no Fiscal Antigo nas abas de Dados adicionais e Operação Fiscal.
IP do servidor ActiveMQ: Deve ser o IP local da máquinaPorta do ActiveMQ: 61.613
Marcar checkbox “Utiliza Integração Fiscal” e salvar.
4 - Configurações do Fiscal caso cliente já utilize o módulo Fiscal
Active MQ: Cadastros:Gerais >> Configurações Gerais do Fiscal >> Configuração do Active MQ
De-Para: Gerais >> Configurações Gerais do Fiscal > >> Configuração do Fiscal Online
5 - Configuração do Construshow TMS e do serviço de Job de Integração Fiscal
6 - Agendador de Tarefas
7 - Monitor Fiscal
6.1 - Carga inicial de Cadastros
6.2 - Carga de Movimentações
6.3 - Carga de Periódicos
6.4 - Status de Integração
6.5 - Situação dos Registros
8 - Como fazer o Acompanhamento Fiscal Online para consultar as integrações realizadas pelo Construshow?
1 - Instalação e Configuração do Serviço de Integração
Antes de mais nada, é necessário verificar se já existe no servidor uma instalação do ActiveMQ. Para isso, abra os serviços do Windows, e procure por ActiveMQ . Caso não exista o serviço instalado, será necessário instalar o mesmo, executando o instalador localizado em L:\Suporte\Instala\Instalador\Atualizadores\Fisco-Contabil. Nas últimas versões do Fiscal, o atualizador já instala os dois serviços (ActiveMQ e o serviço Viasoft Integração Fiscal).
...
Caso após a instalação, o serviço ActiveMQ não iniciar, é provável que o Java não esteja instalado, ou esteja desatualizado na máquina. Para resolver, basta instalar o JRE do Java, em sua versão mais recente. O instalador pode ser conseguido em G:\Java\JRE. Se o serviço do Viasoft Integração Fiscal não se manter iniciado, ocorre quando o banco de dados e aplicação do módulo fiscal estão incompatíveis um com outro, sendo necessário apenas atualizar o Fiscal.Se houver a necessidade de instalar individualmente o serviço do ActiveMQ, segue o caminho do diretório de instalação: F:/AUDIT/ERP/Exes/Fiscos/ActiveMQ/InstalaActiveMQViasoft.exe
Além do Active MQ, também é possível conferir nos Serviços do Windows o Viasoft Integração Fiscal. Após a instalação o Status do serviço deve aparecer em execução.
A troca de informações no Fiscal Online 3.0 ocorre por meio da geração de arquivos do tipo .JSON, que são enviados ao serviço de Mensageria (ActiveMQ), de onde serão processados pelo Serviço de Integração do Fiscal, desenvolvido em Java, e inseridos por ele na base do Fiscal.
Após instalado e executado o Serviço do Active MQ, ao abrir o navegador e digitar o endereço da sessão (irá pedir usuário e senha, por padrão será “admin” para ambos), será possível conferir o Gerenciador da Mensageria conforme o print abaixo.http://localhost:8161/admin/queues.jsp
...
Se o serviço do Active MQ não se manter iniciado é possível tentar uma das seguintes soluções:
Excluir todo o conteúdo da pasta C:\Viasoft\ActiveMQ\data (onde o C: pode variar de acordo com a unidade onde foi instalado o serviço do Active MQ).
Verificar se não existe algum serviço do Java em execução no Gerenciador de tarefas (ou no prompt usar o comando tasklist) e pará-lo, pois ele pode estar utilizando a mesma porta que é usada pelo Active MQ, ou gerar conflito de execução.
Atualizar módulo Fiscal (EXE e banco).
2 - Configuração do arquivo para comunicação com Servidor XE
Após instalado o serviço, precisamos configurar a conexão com o banco dentro do arquivo application.properties localizado na pasta de instalação do serviço (esta pasta foi definida no momento da instalação).
Oracle:
spring.datasource.url=jdbc:oracle:thin:@DW208:1521:VIASOFT2
spring.datasource.username=VIASOFTCTB
spring.datasource.password=VIASOFTCTB
spring.datasource.driver-class-name=oracle.jdbc.OracleDriver
spring.jpa.database-platform=org.hibernate.dialect.Oracle10gDialect
spring.jpa.properties.hibernate.dialect=br.com.viasoft.integracaofiscal.config.CustomOracleDialect
Também devemos configurar o host e a porta do ActiveMQ caso seja necessário (utiliza uma instalação existente e ou com porta diferente e ou em uma máquina diferente).
spring.activemq.broker-url=tcp://localhost:61616
spring.activemq.user=
spring.activemq.password=
Abaixo temos um exemplo onde o banco de dados do Construshow se encontra na instância 2 e a instalação foi feita no diretório E:\Viasoft\Server\Fiscos\IntegracaoOnlineFiscal. É destacado os campos que podem variar de acordo com as definições do usuário.
...
3 - Configuração do Construshow
Antes de iniciarmos a configuração referente ao Fiscal Online no sistema do Construshow, é necessário conferir quais são as opções que estão marcadas dentro do Fiscal antigo para cada estabelemento, para posteriormente deixá-las selecionadas na Configuração do Fiscal Online no Construshow, acessando o menu Contábil/Fiscal >> Exportação Fiscal e verificando quais caixas de seleção estão marcadas nas abas Dados Adicionais e Operação Fiscal. Uma dica neste caso seria tirar dois prints para que estas opções possam ser conferidas e marcadas na configuração do Fiscal Online, ou confirmar com a contabilidade quais os parâmetros de exportação devem ser marcados para cada estabelecimento.
Adição técnica 13/02: As opções de exportação do fiscal antigo ficam armazenadas em arquivo .INI, e considerando que as implantações são feitas no servidor e que não necessariamente o cliente gera por ele, é necessário confirmar com a contabilidade o que precisa ser marcado nas parametrizações de exportação. Apenas a partir do Fiscal novo é que estas opções ficam registradas em banco de dados.
...
Após a configuração do serviço de aplicação, integração e conferência das opções que estão marcadas dentro do Fiscal antigo, é hora de configurar o Construshow (versão 2211 ou superior) para que se comunique com o servidor do ActiveMQ e sejam definidos os parâmetros de Exportação para o Fiscal . Para isso, basta acessar dentro do Construshow o menu Configurações Gerais >> Contábil/Fiscal >> Geral.
3 .1 - Configuração dos Parâmetros de Exportação
Clique no botão de Configurações para definir as mesmas opções da aba de Dados Adicionais e Operação Fiscal conferidas no Fiscal Antigo.
...
2 - Configurações de IP, Porta do Active MQ e habilitar integração Fiscal
IP do servidor ActiveMQ: Deve ser o IP local da máquina
Porta do ActiveMQ: 61.613
Após definida a porta e o IP, é necessário marcar a opção “Utiliza Integração Fiscal” e salvar a configuração.
...
Pode existir situações (principalmente quando a base do cliente é muito antiga) em que ao salvar na tela de Configuração do Construshow ele pede obriga a definição de configurações não relacionadas ao Fiscal. Neste caso, basta estar diretamente via banco o IP, a Porta do Active MQ e a marcação do checkbox “Utiliza Integração Fiscal”:
UPDATE FILIALCONFEXPFISCAL SET integrafiscal3 = 'S' WHERE ESTAB = XYXY;
UPDATE FILIALCONFEXPFISCAL SET INTEGRAFISCAL3IP = '127.0.0.1' WHERE ESTAB = XYXY;
UPDATE FILIALCONFEXPFISCAL SET INTEGRAFISCAL3PORT = 61613 WHERE ESTAB = XYXY;
4 - Configurações do Fiscal
Após a instalação do módulo Fiscal, da Integração Online e do Serviço de Mensageria (ActiveMQ), é necessário configurarmos o Fiscal e em seguida realizarmos a carga inicial.
Mais detalhes sobre como configurar o Fiscal para os clientes que já estão em operação podem ser obtidos neste link. Abaixo temos os prints das duas configurações:
Active MQ: Cadastros: Gerais >> Configurações Gerais do Fiscal >> Configuração do Active MQ
...
De-Para: Gerais >> Configurações Gerais do Fiscal > >> Configuração do Fiscal Online Caso o cliente já utilize o Fiscal, é necessário realizar a configuração do De/Para. Com este procedimento o sistema irá realizar a comparação das pessoas do sistema Gerencial com as pessoas do sistema Fiscal. A chave de comparação utilizada será CNPJ, INSCRIÇÃO ESTADUAL e CÓDIGO DO IBGE da Cidade do Endereço. As pessoas que possuírem estas chaves em comum, serão relacionadas, ao passo que, no cadastro da pessoa do Sistema Fiscal, será inserido o IDORIGEM conforme o padrão definido pelo layout. Caso o cliente não utilize o Fiscal, não é necessário realizar o De-Para
...
5 - Configuração do Construshow TMS e do serviço de Job de Integração Fiscal
Após a configuração do Construshow e do Fiscal, precisamos instalar (caso não esteja instalado) o serviço de Job responsável pela Integração com o Fiscal. Para isto, basta acessar o prompt de comando e navegar até a pasta do Construshow que contém o arquivo ViasoftServerConstruShowJob.exe e que iremos instalar como um Serviço do Windows. Após navegar até a pasta que contém o executável, utilizamos o comando ViasoftServerConstruShowJob.exe /install para que o executável seja instalado como um serviço do Windows e seja iniciado automaticamente com o sistema.
...
O serviço irá buscar o caminho da conexão com o banco de dados no arquivo Construshow.conexoes, ou no caminho que estiver definido no arquivo de configuração do Job denominado ViasoftServerConstrushowJob.conf.
...
6 - Agendador de Tarefas
Após instalarmos o serviço do Job do Fiscal, é hora de configurarmos a periodicidade de sincronização automática dos registros do Construshow para o Fiscal. Para isto, dentro do Construshow basta acessarmos o menu Cadastros >> Agendador de Tarefas, e no canto esquerdo da tela selecionamos a opção de Agendamento e clicamos no botão Incluir.
...
Após incluir, no campo tarefa pesquise por JobFilaFiscal, selecione um intervalo de execução em Minutos e clique em Salvar
...
7 - Monitor Fiscal
O Monitor Fiscal é uma rotina que foi criada totalmente a partir do TMS o qual possui uma hierarquia de pastas e estrutura de instalação diferente do que foi desenvolvido para o Construshow no Delphi 7. O funcionamento do Monitor Fiscal no TMS dispensa o uso do Servidor XE e da execução de script de carga inicial via banco de dados, pois podemos fazer todo este procedimento via interface de usuário. A seguir será detalhado como fazer a carga inicial para cada tipo de agrupamento de registros.
7.1 - Carga inicial de Cadastros
O grupo de Cadastros envolve registros de Pessoas, Mercadorias e não precisa ser definido um período específico, pois o objetivo é fazer a carga de todas as Pessoas e Mercadorias do Construshow para o Estabelecimento Fiscal.
No exemplo abaixo consultamos o registro de Pessoas que ainda não foram sincronizadas para a Fila Fiscal, que é a tabela do banco de dados o qual controla os envios para o Fiscal. Note que elas estão com o status “Não Integrado”.
...
Para Sincronizarmos os registros de Pessoas, basta clicarmos na caixa de seleção para Marcar todos os registros retornados na grade do Monitor, e clicarmos no botão Sincronizar. Temos também o botão Sincronizar em Massa, o qual podemos utilizar para fazer a carga apenas do que estiver com status Não Integrado, ignorando os registros que já estão na fila para sincronização ou que já foram integrados. Após a sincronização a situação será alterada para “Na Fila”.
...
Podemos aguardar o Job fazer a sincronização de forma automática conforme o período estipulado no Agendador de Tarefas ou forçar a integração dos registros para o Fiscal. Para isto, basta acessarmos o Agendador de Tarefas e forçarmos a sincronização.
...
Após a sincronização, caso a sincronização ocorra com sucesso, o registro irá mudar a situação para Integrado.
...
7.2 - Carga de Movimentações
Para os registros do grupo Movimentações precisamos informar a Data Inicial e Data Final dos registros os quais queremos consultar. Nos registros de Entrada e Saída é possível selecionar para que seja consultado apenas uma configuração de Documento ou estabelecimento específico. Lembrando que para que sincronize de outro estabelecimento, é necessário que ele já esteja configurado para sincronização do Fiscal Online.
Para fazer a carga basta selecionarmos o Período desejado, clicar em Consultar, selecionar o registro e clicar em Sincronizar.
...
7.3 - Carga de Periódicos
A carga de Periódicos são registros enviados apenas mensalmente. O print abaixo demonstra o envio da carga de Inventário. Note que precisamos informar o Motivo do Inventário para que o registro possa ser sincronizado.
...
7.4 - Status de Integração
O Status de Integração permite Consultar o Status de registros de todos os grupos de registros que ainda estão na Fila Fiscal com status Pendente, Reenvio e com Advertência. Nesta mesma tela também é possível selecionar registros específicos para que sejam reenviados.
...
6.5 - Situação dos Registros
A seguir será explicado brevemente as Situações que são apresentados no Monitor Fiscal envolvendo os registros consultados. As situações variam de acordo com o campo ENV_STATUS da tabela FILAFISCAL do banco de dados.
Não Integrado: Indica que o registro não está na fila fiscal para ser sincronizado.
Na Fila: Registro Pendente de sincronização ao Fiscal.
Reenvio: Registro marcado para reenvio.
Integrado: Registro que está na FilaFiscal e que foi enviado ao Fiscal.
Advertência: Registro o qual o módulo Fiscal retornou erro. Quando isso ocorre, temos na coluna Aviso uma descrição do erro.
8 - Como fazer o Acompanhamento Fiscal Online para consultar as integrações realizadas pelo Construshow?
Com a configuração finalizada e após a execução do JobFiscal do ViasoftServerMCP_XE.exe, dentro do módulo Fiscal acesse o menu Processos >> Importação >> Acompanhamento Fiscal Online.
...
Nele temos filtros os quais nos permitem consultar apenas notas em que a Situação está Com Erro ou Importado. Também é possível filtrar que pesquise apenas um tipo específico de Registro. Após a definição dos filtros clicamos no Executar para que seja apresentado o resultado.
Exemplo prático de análise do acompanhamento de Integração Online no Fiscal:
Abaixo temos um exemplo bem prático de caso em que após a alteração do registro de cadastro de Pessoas, o sistema retornou o campo Situação “Com erro” devido inconsistência no cadastro da Cidade vinculada ao Registro de Pessoa. Podemos observar no campo de Descrição que o sistema está pegando o código da cidade, sendo que o previsto no Layout Fiscal Online está no formato CODIGO PAIS| CÓDIGO UF | CÓDIGO MUNICIPIO (todos do IBGE), e no botão JSON podemos observar como o Construshow montou o registro.
...
Após o ajuste na geração do formato JSON baseado no Layout Fiscal Online pelo desenvolvedor, ao executarmos novamente o mesmo ainda exibe o histórico dos erros, porém o que consideramos importante é sempre o Recebimento mais atual, onde a Situação agora aparece como “Importado”, indicando que o mesmo foi importado com sucesso ao Fiscal.
...
Também é possível conferir que após a importação bem-sucedida, quando acessamos o menu Cadastros: Específicos >> Pessoas (Emitentes) >> Pessoas, todos os dados da Pessoa e que são pertinentes ao Fiscal foram sincronizados.
...
Caso a integração por algum motivo não seja bem sucedida, também é possível consultar o arquivo de log gerado pelo XE. E:\Viasoft\Server\Fiscos\IntegracaoOnlineFiscal\WinSWFiscalOnline.out.log.
Outra verificação neste sentido é consultando no banco de dados se os registros que não foram sincronizados constam na
tabela FILAFISCAL e se o campo ENV_STATUS está com Status “P” (Pendente).
Caso ocorra alguma situação em que o registro na FILAFISCAL mudou o Status para “S” e mesmo assim não apareça no Fiscal, podemos alterar via banco o status para “P”, executar a sincronização pelo XE e verificar no Active MQ se aparece o JSON deste registro. Outra forma de analisar o erro é através da tabela VIASOFTFISCAL.log_integracao.
select * from VIASOFTFISCAL.log_integracao where ids like '%NOTA|3000|3408%' order by DATARECEBIMENTO desc;
Dicionário do Banco de Dados
| Info |
|---|
Caso tenha interesse em saber os campos do banco de dados que se relacionam a cada campo do sistema, sugerimos a leitura do artigo a seguir: https://nimitz.atlassian.net/l/c/NDGXWDD6 |
Erros Comuns
Situações que podem ocorrer durante o uso da rotina
Versão
...
Versão do Sistema
...
Versão do Banco de Dados
...
Versão da Documentação
...
Autor/Revisor
...
23.010
...
23.010
...
1.0
...