Passar para o conteúdo principal

TOTVS Protheus: Como instalar e configurar o extrator de notas emitidas

Entenda como realizar a instalação do extrator de notas emitidas da Qive no Protheus e quais suas funcionalidades.

Escrito por Julia S.

O Extrator de Notas Emitidas automatiza a integração entre o seu ERP Protheus e a Qive, garantindo que todos os XMLs autorizados pelo TSS (TOTVS Service SOA) sejam espelhados em sua conta de forma organizada e segura. Esta funcionalidade faz parte do pilar de Gestão de Documentos Fiscais, eliminando a necessidade de uploads manuais das notas que a sua empresa emite.


Pré-requisitos para a implantação

Para utilizar o serviço de extração, certifique-se de que sua operação atende aos seguintes pontos:

  • Conta Qive: Possuir um plano com permissão para consumo de XML via API.

  • Pacote de instalação: O pacote deve ser solicitado diretamente ao time de Suporte da Qive.

  • Acesso ao banco de dados: É necessário ter em mãos os dados de acesso ao banco do TSS (IP, porta e nome do banco).

Primeiros passos: Preparação do ambiente

Antes de iniciar a configuração técnica, é necessário preparar o Protheus para receber as novas funções:

  1. Ambiente: Escolha um ambiente separado do balanceamento de carga. Recomendamos utilizar uma porta exclusiva ou o ambiente do Schedule (agendador de tarefas).

  2. Aplicação do pacote: Aplique o pacote de atualização enviado pela Qive de acordo com a sua release do Protheus.

  3. Criação de menus: No módulo de configuração (SIGACFG), adicione as rotinas abaixo no módulo de Faturamento (ou similar), no caminho Atualizações > Diversos > Qive - Emitidas:

Rotina de Configuração

  • Descrição: Configuração

  • Programa: EMIT000

  • Módulo: Faturamento

  • Tipo: Função de Usuário

Rotina de Extração Manual

  • Descrição: Extração Manual

  • Programa: EMIT001

  • Módulo: Faturamento

  • Tipo: Função de Usuário


Configuração da integração

Com os menus criados, siga este fluxo para conectar o ERP à sua conta Qive:

  1. Acesse SIGAFAT > Atualizações > Diversos > Qive - Emitidas > Configuração e clique em Avançar.

  2. Selecione o portal de captura Qive e informe suas credenciais de API (ID e KEY). Clique em Avançar.

  3. Informe os parâmetros de conexão com o banco de dados do TSS:

    • IP do servidor utilizado pelo TSS: Ex: 127.0.0.1

    • Porta do servidor utilizado pelo TSS: Ex: 7890

    • Banco e nome utilizado pelo TSS: Ex: MSSQL/TSS

    • Diretório dos logs do serviço de extração: Ex: \Qive\

    • Habilita a extração de NFC-e (modelo 65): Selecione Sim ou Não.

    • Adiciona o nome do banco na query para banco Oracle: Marque Sim se utilizar ambiente Oracle.

    • Extrair Logs: Ative para salvar os logs em uma pasta local.

  4. Clique em Concluir. O sistema validará a conexão e criará automaticamente os parâmetros MV_QIVE no dicionário de dados (SX6).


Executando uma Extração Manual

A extração manual é ideal para validar a configuração inicial ou recuperar notas de períodos específicos:

  1. Acesse SIGAFAT > Atualizações > Diversos > Qive - Emitidas > Extração Manual e clique em Avançar.

  2. Preencha os filtros desejados (Data de/até, Série, Número ou Chave de Acesso).

  3. Clique em Concluir. O sistema informará a quantidade de XMLs encontrados e processados.

Após o término, as notas estarão disponíveis no portal Qive no menu NF-e > Emitidas.


Log de Integração

O sistema gera arquivos de log a cada execução (manual ou automática), salvos no diretório configurado no parâmetro MV_QIVELOG. O nome do arquivo segue o padrão emitidas_AAAAMMDD.log.

Esses arquivos registram a query de busca no TSS e o status de integração de cada chave de acesso, sendo fundamentais para auditoria e suporte técnico.

Automatizando a extração das notas

Para manter sua gestão de documentos fiscais sempre atualizada, você deve automatizar a rotina. Existem duas formas principais:

Opção 1: Schedule (Agendador de Tarefas)

Ideal para maior controle de horário e monitoramento via Protheus.

  • Rotina: U_SchEmit('codigo_empresa','codigo_filial')

  • Exemplo: U_SchEmit('01','0101')

  • Módulo: 05 (Faturamento)

  • Recorrência sugerida: Diária.

Opção 2: OnStart (Configuração via Appserver.ini)

Método mais simples de manutenção, utilizando um Appserver exclusivo. No seu arquivo Appserver.ini, configure conforme o exemplo abaixo:

[OnStart] Jobs=EXTRACAO_EMITIDAS RefreshRate=86400

[EXTRACAO_EMITIDAS] Main=U_JobEmit Environment=NOME_DO_SEU_AMBIENTE NPARMS=2 PARM1=01 PARM2=0101

Nota técnica: O RefreshRate em 86400 segundos equivale a uma execução a cada 24 horas.


Atenção: Esta funcionalidade de extração de emitidas via TSS é independente do Qive Conexões | TOTVS Protheus (voltado para recebidas). Caso ainda não possua este recurso contratado, entre em contato com o nosso time de suporte ou sucesso do cliente.

Respondeu à sua pergunta?