Passar para o conteúdo principal
Todas as coleçõesIntegraçõesEnviar documentos da Qive (Arquivei) para ERPs da TotvsQive Conexão | TOTVS Protheus
Manual Extrator de Notas Emitidas no Protheus
Manual Extrator de Notas Emitidas no Protheus

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

F
Escrito por Felipe Machado de Oliveira
Atualizado há mais de 2 meses

O conteúdo a seguir traz as configurações necessárias para habilitar o serviço de extração de XMLs emitidos pelo TSS (TOTVS Service SOA), a partir do ERP Protheus, e integração direta com o portal Qive, permitindo a visualização de todas as Notas Fiscais Eletrônicas emitidas pela sua empresa de forma organizada e prática.

  1. Pré-requisitos para implantação

  2. Primeiros passos

  3. Configuração

  4. Extração manual

  5. Log de integração

  6. Automatizando a extração

    1. Schedule

    2. Onstart

Pré-requisitos para implantação

  • Possuir uma conta Qive com permissão de consumo de XML via API.

  • Entrar em contato com suporte Qive para ter acesso ao pacote de instalação.

  • Possuir acesso direto ao banco de dados do TSS (TOTVS Service SOA), com IP, porta e nome do banco.

Primeiros passos

  1. Escolher um ambiente para aplicação do pacote: esse ambiente deve ficar separado do balanceamento de carga, podendo ser uma porta exclusiva ou no ambiente do Schedule (agendador de tarefas).

  2. Aplicação do pacote de atualização disponibilizado pela Qive: deve ser aplicado o pacote correspondente a release do Protheus.

  3. Criação das rotinas no menu: acessar o módulo de configuração (SIGACFG) e adicionar as rotinas no módulo de faturamento (ou outro que desejar) seguindo a estrutura Atualizações > Diversos > Qive - Emitidas. Para maiores detalhes sobre criação de menu, acesse essa página.
    ​
    ​Descrição: Configuração
    ​Programa: EMIT000

    Módulo: Faturamento

    Tipo: Função de Usuário
    ​

    Descrição: Extração Manual
    ​Programa: EMIT001

    Módulo: Faturamento

    Tipo: Função de Usuário
    ​

    Após a criação, o menu deve ficar semelhante à estrutura abaixo.
    ​

Configuração

Acessar o menu recém criado na estrutura SIGAFAT > Atualizações > Diversos > Qive - Emitidas > Configuração. Clique em Avançar.
​

Selecione o portal de captura Qive e informe as credenciais da API (ID e KEY). Após informá-las, clique em Avançar

Caso as credenciais estejam inválidas, o sistema apresenta a mensagem "As credenciais informadas não são válidas!", do contrário, a próxima etapa é apresentada.

Nessa etapa, deve ser informado os parâmetros de conexão com o banco de dados do TSS, conforme exemplo abaixo:
​

IP do servidor utilizado pelo TSS: 127.0.0.1

Porta do servidor utilizado pelo TSS: 7890

Banco e nome utilizado pelo TSS: MSSQL/TSS

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

Habilita a extração de NFC-e (modelo 65): Sim para extrair e Não para não extrair

Adiciona o nome do banco na query para banco Oracle: Sim para adicionar e Não para não adicionar. Recomenda-se que esteja selecionado Sim para ambiente Oracle.

Extrair Logs: Opção para extrair os logs do serviço para uma pasta local.

Cada campo apresentado em tela corresponde a um parâmetro (SX6) do Protheus. Os parâmetros são criados automaticamente ao acessa a rotina e iniciam com os caracteres MV_QIVE.

Após preenchimento de todos os campos, clicar em Concluir para o sistema validar a conexão com o TSS, apresentando mensagem de erro ou sucesso.

Extração manual

A extração manual tem o objetivo de integrar os XMLs emitidos a partir de um filtro estabelecido pelo usuário. Esse filtro pode ser por data de autorização do SEFAZ, série, número ou chave de acesso.

Recomenda-se que seja executado a primeira extração de forma manual para identificar possíveis falhas de configuração ou problemas de integração.

Acessar o menu SIGAFAT > Atualizações > Diversos > Qive - Emitidas > Extração Manual. Clique em Avançar.

Informar os parâmetros para compor o filtro desejado para extração.

Data de: Data inicial de autorização do XML na SEFAZ.

Data até: Data final de autorização do XML na SEFAZ.

Série da NF: Série de notas geradas.

Número da NF de: Número inicial de notas geradas.

Número da NF até: Número final de notas geradas.

Chave da NF: Chave de acesso da nota gerada.

Após informar os parâmetros, clique em Concluir. Será apresentado mensagem de processamento com quantidade de XMLs encontrados a partir do filtro.

Ao finalizar, os XMLs emitidos devem estar disponíveis no portal Qive pelo menu "NF-e" (Documentos), pasta "Emitidas", conforme imagem abaixo:

Log de integração

Os arquivos de log são gerados a cada execução da extração, seja ela manual ou automática e ficam disponíveis no diretório informado na etapa de configuração, parâmetro MV_QIVELOG. São gerados arquivos por dia de execução com o nome emitidas_20241025, por exemplo. Para acessá-los, basta clicar no botão Extrair Logs na última etapa da rotina de configuração ou baixá-los diretamente do servidor.

O log é composto pelos parâmetros utilizados para extração, a query de busca dos XMLs nas tabelas do TSS e a situação da integração por chave de acesso.

Automatizando a extração

A automação da extração das notas emitidas é essencial para garantir a informação atualizada no portal Qive. Deve ser levado em consideração a recorrência de tempo para cada extração. Recomenda-se que a extração seja realizada diariamente. Sendo assim, escolha uma das opções a seguir para configurar em seu ambiente.

Schedule

Utilizando a opção Schedule ou agendador de tarefas do Protheus, é possível ter maior controle sobre quando a rotina será acionada. Para mais informações sobre como configurar uma tarefa agendada, consulte este material se estiver com uma versão mais antiga do Protheus ou este material se estiver com uma versão mais recente.

As informações necessárias para cadastro da rotina estão a seguir:

  • Rotina: U_SchEmit('codigo_empresa','codigo_filial'), onde o codigo_empresa corresponder ao código do primeiro grupo de empresa utilizado e codigo_filial corresponder a primeira filial dessa empresa. Por exemplo: U_SchEmit('01','0101').

  • Empresa/Filial: escolher apenas uma empresa/filial, podendo ou não ser a mesma informada nos parâmetros da rotina.

  • Módulo: selecionar conforme o módulo desejado, sendo o padrão o módulo 05 (Faturamento).

  • Descrição: descrever o propósito do serviço que é "extração dos XMLs emitidos e integração via API com o portal Qive".

  • Recorrência: recomenda-se que a recorrência seja diária, mas fica a critério da empresa decidir esse ponto.

Onstart

Utilizando a opção Onstart não é possível garantir o momento exato da execução, porém é um formato mais simples e fácil de sustentação. Para esse formato, basta criar ou utilizar um Appserver exclusivo, ou seja, fora do balanceamento de carga e alterar o arquivo de configuração Appserver.ini conforme dados abaixo. Para mais detalhes sobre esse tipo de configuração, acesse essa página.

Informações necessárias para configuração estão a seguir:

[OnStart]
Jobs=EXTRACAO_EMITIDAS
RefreshRate=86400

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

A recorrência deve ser informada em segundos no parâmetro RefreshRate, sendo assim, para que a extração seja diária ele deve ocorrer a cada 24h, logo 86400 segundos.

No parâmetro Main, deve ser informado o nome da função que realiza a extração, U_JobEmit.

No parâmetro Environment, deve ser informado o nome do ambiente existente no arquivo de configuração.

Os parâmetros PARM1 e PARM2 correspondem a primeira empresa e filial, não havendo necessidade de informar todas as existentes.

Respondeu à sua pergunta?