Histórico da Página

Painel

borderStyle	none

DADOS GERAIS SOBRE OS RECURSOS

Painel

Este Plugin possibilita o Downlod de Notas Fiscais dentro dos módulos de Vendas e Cliente.

Esse plugin permite que seja configurada conexão com uma API que requisita no ERP ou outro local definido pelo cliente, o arquivo PDF referente a Nota fiscal que se deseja baixar, e faz com que esse arquivo PDF seja baixado localmente no computador ou smartphone do usuário.

É importante ressaltar que não fornecemos a api que obtém o arquivo do ERP e disponibiliza para o SFA. É necessário que haja do lado do cliente, uma API à qual nosso plugin irá se conectar e fazer a requisição de download, por essa razão, é preciso também que e essa API esteja adequada ao modelo de REQUEST e RESPONSE esperado pelo SFA para obter o arquivo PDF.

Dessa forma, quando o Plugin estiver ativo e as configurações realizadas corretamente, pela tela de Títulos na WEB ou no aplicativo, é possível baixar o arquivo PDF referente ao registro selecionado.

Painel

Índice

maxLevel	4
minLevel	2
printable	false
separator	pipe

Deck of Cards

id	38783

Card

label	Escopo Funcional

ESCOPO FUNCIONAL/MANUAL

Detalhamento da utilização do Recurso

Para que esse fluxo funcione na Aplicação SFA, o cliente precisa disponibilizar a API nos moldes propostos nesta documentação, seja por meio de desenvolvimento interno/próprio ou por uma empresa que ofereça esse serviço para clientes Protheus. Caso opte pelo serviço da unidade TOTVS, a negociação será feita diretamente com a unidade.

Após disponibilizar essa API, o cliente deve informar à equipe/Consultor do TOTVS CRM SFA a URL da API e as credenciais, considerando que a API segue o modelo de request e response detalhado no card ESCOPO FUNCIONAL desta documentação.

Configuração do Recurso

Este Plugin tem como objetivo fazer a comunicação com o ERP correspondente e permitindo que o usuário visualize e baixe um PDF do documento DANFE direto pela aplicação TOTVS CRM SFA.

Para configurar é necessário ativar o Card referente a esse fluxo em: Configuração > Integração > Plugins de Integração

Após ativar, clique em "Configurar' no Card correspondente e serpa exibido os seguintes campos:

Campo	Descrição
URL	Informe a URL em que a API para download estará sendo servida (Ex: https://IP:PORTA/rest/KFATRO03)
Usuário	Informe o Usuário da autenticação básica
Senha	Informe a senha da autenticação básica
Job	Informe o nome do serviço Pentaho que faz a comunicação com a URL fornecida DOWNLOADNOTAFISCAL
Rep	Informe o repositório onde está o Job dentro do arquivo .jar da integração COMMON_SERVICES
Timeout	Informe de processamento para aguardar retorno da API

Detalhes do Fluxo de Download de NF's

Com a configuração realizada, acesse o módulo Venda > Notas Fiscais > Listar

Nessa tela são exibido todos os registros de Notas fiscais que foram importadas do ERP, porém agora exibe uma coluna com o Ícone de Download:

Ao clicar no Ícone do registro que pretende consultar, a aplicação exibe a janela de comunicação com o Carte e a consulta da DANFE é realizada.

Após a consulta, o Download da Nota Fiscal é automaticamente realizado.

ESCOPO TÉCNICO DA API NOTA FISCAL

Plugin

Pelo tools opção 5

deverá ser

é criado o seguinte registro:

Card

label	Escopo Técnico

Card

label	Escopo Técnico

Bloco de código

title	Plugin
linenumbers	true

pluginintegracao {
	codigo: DOWNNF,
    descricao: API Para download Danfe (PDF),
	idnAtivo: 0
}

Bloco de código

title	Campos de Condiguração
linenumbers	true

Campo "URL Nota Fiscal"
	idpluginintegracao: select idpluginintegracao from pluginintegracao where codigo = 'DOWNNF',
	codigoelemento: DOWNNF,
	agrupador: 0,
	sglcampo: DOWNNF_URL
	valor: {valor inserido no campo URL}
Campo "Usuário"
	idpluginintegracao: select idpluginintegracao from pluginintegracao where codigo = 'DOWNNF',
	codigoelemento: DOWNNF,
	agrupador: 0,
	sglcampo: DOWNNF_USER
	valor: {valor inserido no campo USUÁRIO}

Campo "Senha"
	idpluginintegracao: select idpluginintegracao from pluginintegracao where codigo = 'DOWNNF',
	codigoelemento: DOWNNF,
	agrupador: 0,
	sglcampo: DOWNNF_PASSWORD
	valor: {valor inserido no campo Senha}

Campo "Timeout Consulta"
	idpluginintegracao: select idpluginintegracao from pluginintegracao where codigo = 'DOWNNF',
	codigoelemento: DOWNNF,
	agrupador: 0,
	sglcampo: DOWNNF_TIMEOUT
	valor: {valor inserido no campo Timeout consulta}
Campo "Rep"
	idpluginintegracao: select idpluginintegracao from pluginintegracao where codigo = 'DOWNNF',
	codigoelemento: DOWNNF,
	agrupador: 0,
	sglcampo: DOWNNF_REP
	valor: {COMMONS_SERVICES}
Campo "Job"
	idpluginintegracao: select idpluginintegracao from pluginintegracao where codigo = 'DOWNNF',
	codigoelemento: DOWNNF,
	agrupador: 0,
	sglcampo: DOWNNF_JOB
	valor: {DOWNLOADNOTAFISCAL}

Segue

protótipo

Dados de tela que serão preenchidos:

Image Removed

IMPLEMENTAÇÃO NA LISTAGEM DE NOTA FISCAL

Image Added

Implementação na listagem de nota fiscal

Na tela, "Venda → Nota Fiscal → Listar",

exibir

exibe o botão Image Modifiedpara download do PDF, ao lado do botão de visualização conforme protótipo, de acordo com as configurações do plugin:

- idnAtivo = 1: select idnAtivo from pluginintegracao where codigo = 'DOWNNF'

Ao clicar no botão de download a aplicação deverá consultar o carte de acordo com a sql:

Bloco de código

title	URL_PENTAHO
linenumbers	true

select valor from pluginintconfig where codigoelemento='CONF_GERAL' AND sglcampo='PENTAHO_URL'

A url do download

deve ser

é montada da seguinte forma: URL=${Configurações do Pentaho.URL}/kettle/executeJob/?rep={}&job={}

No body da requisição, passar as seguintes informações:

Bloco de código

title	Consulta de Nota Fiscal
linenumbers	true

{
	idnotafiscal:
}

O retorno desta url será o arquivo em base64 para download:

Bloco de código

title	Código 200 - Ok
linenumbers	true

{
    mensagem: {base64}
}

Integração com API Download de Notas fiscais

Criar a variável

Lista de variáveis de integração abaixo:

ERP	TODOS
CONTEXTO	API
DESCRIÇÃO	Se valor 1, a URL será no formato {URL_API_NOTA_FISCAL_CLIENTE}/{empresa}/{filial}/{documento}/{serie}; se a variável estiver inativa, então a URL montada será no formato {URL_API_NOTA_FISCAL_CLIENTE}/{filial}/{documento}/{serie}.
TABELA	WSCONFIGINTEGRACAO
CAMPO	VALOR
VALOR	1
IDNATIVO	1
CODIGOERP	API_DOWNNF

Criar

Detalhes de Job DOWNLOADNOTAFISCAL

Também é Criado para Pentaho-Carte o Job DOWNLOADNOTAFISCAL no repositório COMMONS_SERVICES;

A URL de consulta

deve ser

é montada no seguinte padrão:

GET: {URL_API_NOTA_FISCAL_CLIENTE}/{empresa}/{filial}/{documento}/{serie}

HEADERS: Authorization: Basic {TOKEN}

Informações da request serão obtidas a partir das consultas abaixo;
Se o campo EMPRESA estiver como NULL, então o parâmetro EMPRESA não

deve ser

é repassado na URL da request. Dessa forma {URL_API_NOTA_FISCAL_CLIENTE}/{filial}/{documento}/{serie}:

Bloco de código

language	sql
title	Consulta de Dados de Notas Fiscais
linenumbers	true

SELECT n.numeronotafiscal AS DOCUMENTO,
       n.serie            AS SERIE,
       l.numeromatricula  AS FILIAL,
       CASE
         WHEN Cast(w.valor AS VARCHAR) = '1' THEN
         Split_part(n.codigoerp, '#', 1)
         ELSE NULL END    AS EMPRESA
FROM   notafiscal n
       INNER JOIN local l
               ON l.idlocal = n.idlocalfilialfaturamento
       LEFT JOIN wsconfigintegracao w
              ON w.codigoerp = 'API_DOWNNF'
                 AND w.idnativo = 1
WHERE  n.idnotafiscal = :IDNOTAFISCAL;


SELECT ( CASE
           WHEN sglcampo = 'DOWNNF_PASSWORD' THEN valor
         END ) AS SENHA,
       ( CASE
           WHEN sglcampo = 'DOWNNF_USER' THEN valor
         END ) AS USUARIO,
       ( CASE
           WHEN sglcampo = 'DOWNNF_URL' THEN valor
         END ) AS URL
FROM   pluginintconfig
WHERE  codigoelemento = 'DOWNNF'
       AND sglcampo IN ( 'DOWNNF_PASSWORD', 'DOWNNF_USER', 'DOWNNF_URL' );

O retorno recebido será no formato base64, e

deve ser

é retornado para aplicação sem transformações dentro do XML do RESPONSE:

Bloco de código

title	Código 200 - Ok
linenumbers	true

{
    mensagem: {base64}
}

Retornos:

Painel

title

API - Nota Fiscal

Códigos de Retornos

Bloco de código

title	Retorno 500 - Internal Server Error
linenumbers	true

{"code":500,"detailedMessage":"","message":"Internal Server Error"}

Bloco de código

title	Retorno 404 - Nota Fiscal não encontrada
linenumbers	true

{
    "errorCode": 404,
    "errorMessage": "Nao encontrou a NF 01_05_000001838_11 "
}

Bloco de código

title	Retorno 200 - Ok
linenumbers	true

{
    mensagem: {base64}
}

Árvore de páginas

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

DADOS GERAIS SOBRE OS RECURSOS

ESCOPO FUNCIONAL/MANUAL

Detalhamento da utilização do Recurso

Configuração do Recurso

Detalhes do Fluxo de Download de NF's

ESCOPO TÉCNICO DA API NOTA FISCAL

Plugin

Implementação na listagem de nota fiscal

Integração com API Download de Notas fiscais

Detalhes de Job DOWNLOADNOTAFISCAL