GOVERNO DO ESTADO DA PARAÍBA 31/01/2019

SECRETARIA DE ESTADO DA RECEITA

NFe 2 TXT – XML para TXT

Versão: 1.1

1. Introdução ............................................................................................................................................ 2
1.1 Características ................................................................................................................................. 2
1.2 Fluxograma ...................................................................................................................................... 3
1.3 Descrição ......................................................................................................................................... 4
2. Instruções de uso ................................................................................................................................. 5
2.1 Localizando ...................................................................................................................................... 5
2.2 Executando e configurando .............................................................................................................. 5
2.3 Conhecendo melhor ......................................................................................................................... 8
2.4 Estrutura hierárquica da NFe ............................................................................................................ 9
2.5 Processando ...................................................................................................................................10
2.6 Banco de dados ..............................................................................................................................13
2.7 Log do processamento ....................................................................................................................14
2.8 Scripts .............................................................................................................................................15
2.9 Arquivos de texto.............................................................................................................................17
2.10 XML de NFe/NFCe e Evento ...........................................................................................................18

NFe 2 TXT – XML para TXT Pág. 1 / 18

 GOVERNO DO ESTADO DA PARAÍBA 31/01/2019
SECRETARIA DE ESTADO DA RECEITA

1. INTRODUÇÃO
O escopo deste documento é o provimento de orientações de uso do aplicativo “NFe 2 TXT”.
O objetivo desta ferramenta é a extração de XML de inúmeros arquivos de NFe e/ou NFCe
(nota fiscal eletrônica e nota fiscal do consumidor eletrônica, respectivamente), disponibilizando o
resultado em arquivos de texto facilmente acessíveis por bancos de dados, insumo significativo
para o trabalho de administrações tributárias, escritórios de contabilidade e demais empresas que
fazem uso destes documentos fiscais eletrônicos.

1.1 CARACTERÍSTICAS

Este é um aplicativo muito simples, gratuito, de livre distribuição e utilização, projetado para
processar com agilidade um grande volume de arquivos, utilizando o mínimo possível de recursos
do computador.

É portável (não requer instalação) e tem como únicos requisitos a presença de "msxml3.dll" e
"comctl32.dll" no diretório "System32" do Windows (proporcionado pela instalação padrão).
Eventualmente, estas DLLs podem ser corrompidas pela instalação de programas de
terceiros. Neste caso, execute o aplicativo noutro computador (não vale a pena o esforço para
correção).

Foi testado com sucesso nas seguintes versões de sistema operacional: Windows XP SP3;
Windows Vista; Windows 7; Windows 8; Windows 8.1; e, Windows 10.
Apresentou desempenho de processamento da ordem de 10.000 arquivos por minuto, no
entanto, isto pode ser afetado por diversos fatores (velocidade do HD, por exemplo).
Recomenda-se a adoção de uma regra de exceção no Antivírus para evitar a desnecessária
concorrência com o aplicativo.

Adicionalmente, provê scripts (.BAT e .SQL) para criação e carga de Banco de Dados MySQL.

É capaz de processar a versão 4.0 da NFe/NFCe, bem como todas as anteriores.

Consulte o leiaute no "Manual de Orientação do Contribuinte - versão 6.00", disponível na
seguinte URL: http://www.nfe.fazenda.gov.br/portal/listaConteudo.aspx?tipoConteudo=33ol5hhSYZk=

NFe 2 TXT – XML para TXT Pág. 2 / 18

 GOVERNO DO ESTADO DA PARAÍBA 31/01/2019
SECRETARIA DE ESTADO DA RECEITA

1.2 FLUXOGRAMA

Abaixo, o fluxograma do aplicativo:

NFe 2 TXT – XML para TXT Pág. 3 / 18

 GOVERNO DO ESTADO DA PARAÍBA 31/01/2019
SECRETARIA DE ESTADO DA RECEITA

1.3 DESCRIÇÃO

Antes de extrair o conteúdo, o aplicativo aglutina (concatena) todos os pequenos (~100KB)

arquivos XML em grandes (~25MB) arquivos XML.

O objetivo original desta etapa era reduzir o imenso número de pequenos arquivos, passando
a trabalhar com um número reduzido de arquivos maiores, evitando, assim, a reconhecida
dificuldade que o sistema operacional Windows possui de lidar com isto.
Apenas para exemplificar o conceito, teste fazer uma cópia de 100.000 arquivos de 0,2MB e
compare com o tempo de fazer a cópia de um único arquivo de 20GB. O segundo caso é
muitíssimo mais veloz que o primeiro.

Porém, durante os experimentos realizados ao longo do desenvolvimento do aplicativo, optou-

se por substituir a abordagem de processamento do XML, de “DOM” (Document Object Model)
para “SAX” (Simple API for XML).
Com isto, esta etapa parece ter se tornado desnecessária (de fato, atualmente, esta é a mais
custosa do processo). Numa versão posterior, provavelmente será removida do aplicativo.

A etapa seguinte consiste na extração (transformação) do XML dos grandes arquivos,

disponibilizando o resultado em versáteis arquivos de texto (85 arquivos relativos a NFe/NFCe;
5 arquivos relativos a eventos), objetivo principal do aplicativo e onde se obteve o melhor
desempenho.

Adicionalmente, o aplicativo disponibiliza scripts (01.Load_NFe.bat e 02.Create_Table.sql)

para criação de banco de dados e carga dos arquivos de texto em suas tabelas.
Estes scripts consideram como destinatário um banco de dados MySQL no computador local.
Trata-se de software livre para uso não-comercial.
Escritos em linguagem padrão, podem ser facilmente convertidos/ajustados para outros
bancos de dados. Caso o usuário deseje, o próprio aplicativo realiza a execução destes scripts.

Por fim, o aplicativo registra o log do processamento no disco (útil para análise de
desempenho).
Todas as etapas descritas acima são configuráveis, conforme se verá adiante.

NFe 2 TXT – XML para TXT Pág. 4 / 18

 GOVERNO DO ESTADO DA PARAÍBA 31/01/2019
SECRETARIA DE ESTADO DA RECEITA

2. INSTRUÇÕES DE USO

2.1 LOCALIZANDO

Coloque o aplicativo num diretório qualquer do seu computador.

Coloque todos os arquivos XML (NFe, NFCe, Evento de NFe) num subdiretório chamado
“XML”.

2.2 EXECUTANDO E CONFIGURANDO

Execute o aplicativo.
Observe que é possível configurar uma porção de parâmetros:
 Na aba “Diretórios”, é possível definir os nomes dos subdiretórios;
 Na aba “Configurações”, é possível selecionar o que se deseja realizar, bem como definir
parâmetros de conexão (usuário, senha e porta) com um banco de dados MySQL local.

Se você estiver em dúvida, apenas clique no botão “Processar Arquivo(s)”.

NFe 2 TXT – XML para TXT Pág. 5 / 18

 GOVERNO DO ESTADO DA PARAÍBA 31/01/2019
SECRETARIA DE ESTADO DA RECEITA

NFe 2 TXT – XML para TXT Pág. 6 / 18

 GOVERNO DO ESTADO DA PARAÍBA 31/01/2019
SECRETARIA DE ESTADO DA RECEITA

NFe 2 TXT – XML para TXT Pág. 7 / 18

 GOVERNO DO ESTADO DA PARAÍBA 31/01/2019
SECRETARIA DE ESTADO DA RECEITA

2.3 CONHECENDO MELHOR

Caso deseje saber mais, descanse o mouse sobre o item da tela.

O aplicativo irá prover uma descrição (hint) do objetivo do item.

NFe 2 TXT – XML para TXT Pág. 8 / 18

 GOVERNO DO ESTADO DA PARAÍBA 31/01/2019
SECRETARIA DE ESTADO DA RECEITA

2.4 ESTRUTURA HIERÁRQUICA DA NFe

No lado direito da tela, o aplicativo provê a estrutura hierárquica da NFe/NFCe.

Isto é algo bastante útil para identificar onde está a informação que se deseja analisar dentro
do complexo universo deste documento fiscal eletrônico.

Ao clicar num item da árvore, o aplicativo mostra na “barra de mensagens” (parte inferior da
tela) o código de identificação. Com esta informação, pode-se pesquisar no Manual da NFe
(disponível no site da Receita Federal) qual o respectivo conteúdo.

Sempre que desejar, dê um clique duplo na “barra de mensagens”; o aplicativo irá copiar o
conteúdo na área de transferência do Windows (para colar em qualquer outro lugar).

NFe 2 TXT – XML para TXT Pág. 9 / 18

 GOVERNO DO ESTADO DA PARAÍBA 31/01/2019
SECRETARIA DE ESTADO DA RECEITA

2.5 PROCESSANDO

Feitas as opções de configuração, após clicar no botão “Processar Arquivo(s)”,

o sistema iniciará o processamento.

Na “barra de mensagens”, é possível acompanhar o que está sendo feito em cada momento.
Acima dela, existe uma “barra de progresso” azul que serve apenas para sinalizar ao usuário
que o processamento está em andamento (não identifica o percentual de conclusão).

Na aba “Processamento”, é apresentado um log do que já foi realizado pelo aplicativo e os

respectivos tempos de execução.

Pode ficar à vontade para realizar outra atividade. O sistema não solicitará sua intervenção e
utiliza pouquíssimos recursos de processador e memória (menos de 5MB). Ao término, emitirá
mensagem de conclusão.

NFe 2 TXT – XML para TXT Pág. 10 / 18

 GOVERNO DO ESTADO DA PARAÍBA 31/01/2019
SECRETARIA DE ESTADO DA RECEITA

NFe 2 TXT – XML para TXT Pág. 11 / 18

 GOVERNO DO ESTADO DA PARAÍBA 31/01/2019
SECRETARIA DE ESTADO DA RECEITA

NFe 2 TXT – XML para TXT Pág. 12 / 18

 GOVERNO DO ESTADO DA PARAÍBA 31/01/2019
SECRETARIA DE ESTADO DA RECEITA

2.6 BANCO DE DADOS

Se você possui um banco de dados MySQL local e marcou a opção “Executar script SQL”, o
sistema criará automaticamente o banco de dados “NFe” e realizará a carga com o conteúdo dos
arquivos de texto que foram extraídos dos arquivos XML de NFe, NFCe e Eventos.

O aplicativo irá criar automaticamente os subdiretórios que irão conter os arquivos resultantes
do processamento.

NFe 2 TXT – XML para TXT Pág. 13 / 18

 GOVERNO DO ESTADO DA PARAÍBA 31/01/2019
SECRETARIA DE ESTADO DA RECEITA

2.7 LOG DO PROCESSAMENTO

No subdiretório de “log do processamento”, irá disponibilizar o log do processamento.

NFe 2 TXT – XML para TXT Pág. 14 / 18

 GOVERNO DO ESTADO DA PARAÍBA 31/01/2019
SECRETARIA DE ESTADO DA RECEITA

2.8 SCRIPTS

No subdiretório de “scripts SQL”, irá disponibilizar um arquivo de automação “batch file”

(01.Load_NFe.bat) e um arquivo SQL de criação do banco de dados (02.Create_Table.sql).
Fique à vontade para fazer ajustes e alterações nestes arquivos. Os comentários irão auxiliá-lo
na compreensão do conteúdo.

NFe 2 TXT – XML para TXT Pág. 15 / 18

 GOVERNO DO ESTADO DA PARAÍBA 31/01/2019
SECRETARIA DE ESTADO DA RECEITA

NFe 2 TXT – XML para TXT Pág. 16 / 18

 GOVERNO DO ESTADO DA PARAÍBA 31/01/2019
SECRETARIA DE ESTADO DA RECEITA

2.9 ARQUIVOS DE TEXTO

No subdiretório de “arquivos de texto”, irá disponibilizar os arquivos de texto resultantes da

extração do XML dos arquivos de NFe, NFCe e Eventos.
Cada arquivo corresponde a uma tabela no banco de dados “NFe”.

NFe 2 TXT – XML para TXT Pág. 17 / 18

 GOVERNO DO ESTADO DA PARAÍBA 31/01/2019
SECRETARIA DE ESTADO DA RECEITA

2.10 XML DE NFe/NFCe E EVENTO

Apenas para ilustrar, imagens da visualização de arquivos XML de NFe e Evento:

NFe 2 TXT – XML para TXT Pág. 18 / 18