Mudanças entre as edições de "Manuais:UniDANFE/Integrando o UniDANFE ao ERP"

De unimake
Ir para: navegação, pesquisa
 
(26 revisões intermediárias por 2 usuários não estão sendo mostradas)
Linha 1: Linha 1:
==Integrando o UniDANFE ao sistema ERP==
+
__NOTITLE__
 +
=Integrando o UniDANFE ao sistema ERP=
  
A integração do UniDANFE ao sistema ERP é bem simples: toda ela será feita por meio de execuções (run) do aplicativo UniDANFE.exe com a passagem de parâmetros, os quais indicam ao UniDANFE qual ação deve ser executada.
+
A integração do UniDANFE ao sistema ERP pode ser realizada de duas formas:
  
==Formato da Chamada ao UniDANFE==
+
a) Por meio de execuções (RUN) do aplicativo UniDANFE.exe com a passagem de parâmetros
''<caminho-completo>\unidanfe.exe parametro=valor parametro="valor com espaços deve estar entre aspas" parametro=valor ...''
 
:: Onde:
 
:::* ''caminho-completo'': pasta onde o UniDANFE foi instalado (ex: c:\unimake\uninfe)
 
:::* ''parâmetro'': nome do parâmetro. Não deve haver espaços entre o nome do parâmetro e o símbolo "="
 
:::* ''valor'': valor do parâmetro. Deve estar entre aspas sempre que contiver espaços. Não deve haver espaços entre o símbolo "=" e o valor.
 
:: Exemplo:
 
::: ''c:\unimake\uninfe\unidanfe.exe a="c:\minha pasta\{{CURRENTYEAR}}-{{CURRENTMONTH}}\010101011-procNFe.xml" m=1 v=0 ee=1 c=2
 
  
==Sobre os Exemplos desse Documento==
+
# [[Manuais:UniDANFE/Integrando o UniDANFE ao ERP/Formato da chamada ao UniDANFE|Formato da chamada ao UniDANFE]]
Todos os exemplos de chamada ao UniDANFE serão no formato ''...\unidanfe.exe parâmetros'', devendo o desenvolvedor substituir "..." pela pasta de instalação.
+
# [[Manuais:UniDANFE/Integrando o UniDANFE ao ERP/Lista completa dos comandos de integração|Lista completa dos comandos de integração]]
 +
# [[Manuais:UniDANFE/Integrando o UniDANFE ao ERP/Exemplos de chamada ao UniDANFE em diversas linguagens|Exemplos de chamada ao UniDANFE em diversas linguagens]]
  
==Ações Possíveis==
+
b) Por meio de DLL linkada ao sistema ERP
# Geração de Documento Auxiliar (DANFE, DACTE, DAMDFE, Extrato SAT, CC-e, cancelamento, etc)
+
 
#* [[UniDANFE/Integrando o UniDANFE ao ERP/Gerar documento auxiliar|Gerar/imprimir/distribuir o Documento Auxiliar  dos Documentos Ficais Eletrônicos (NF-e, NFC-e, CT-e, MDF-e, CF-e SAT, etc)]]
+
# DLL Win32 (UNIDANFE_DFE.DLL)
#* [[UniDANFE/Integrando o UniDANFE ao ERP/Buferizar impressões|Buferizar as impressões do UniDANFE]]
+
## [[Manuais:UniDANFE/Integrando o UniDANFE ao ERP/MetodosDLL|Documentação e exemplos]]
# Configurações
+
 
#* [[UniDANFE/Integrando o UniDANFE ao ERP/Painel de controle|Acessar o painel de controle]]
+
# DLL em C# (Unimake.Unidanfe)
#* [[UniDANFE/Integrando o UniDANFE ao ERP/Acessar a configuração|Acessar a interface de configuração]]
+
## [[Manuais:Unimake.Unidanfe|Documentação e exemplos]]
#* [[UniDANFE/Integrando o UniDANFE ao ERP/Acessar a configuração de e-mail|Acessar a interface de configuração de contas de e-mail]]
 
# E-mails
 
#* [[UniDANFE/Integrando o UniDANFE ao ERP/Gerenciar e-mails|Gerenciar os e-mails gerados (a enviar, enviados ou com erros)]]
 
#* [[UniDANFE/Integrando o UniDANFE ao ERP/Forçar envio de e-mails|Forçar o envio dos e-mails da caixa “a enviar”]]
 
#* [[UniDANFE/Integrando o UniDANFE ao ERP/Gerar relatório de e-mails|Gerar relatório dos e-mails]]
 
# [[UniDANFE/Integrando o UniDANFE ao ERP/Gerenciar uploads|Gerenciar os uploads pendentes]]
 
# Licenças
 
#* [[UniDANFE/Integrando o UniDANFE ao ERP/Gerenciar licenças|Consultar, comprar, renovar, download de licenças Plus]]
 
#* [[UniDANFE/Integrando o UniDANFE ao ERP/Exportar XML de licenças|Gerar XML com a lista das licenças instaladas]]
 
# Sistema
 
#* [[UniDANFE/Integrando o UniDANFE ao ERP/Consultar versao|Consultar a versão instalada]]
 
#* [[UniDANFE/Integrando o UniDANFE ao ERP/Autoupdate|Atualizar o sistema automaticamente]]
 
  
 
==Veja também==
 
==Veja também==
 
* [[Manuais:UniDANFE/Executando Manualmente|Executando o UniDANFE manualmente]]
 
* [[Manuais:UniDANFE/Executando Manualmente|Executando o UniDANFE manualmente]]
 
* [[Manuais:UniDANFE/DANFEMon|Utilizando UniDANFE em conjunto com o DANFE Mon]]
 
* [[Manuais:UniDANFE/DANFEMon|Utilizando UniDANFE em conjunto com o DANFE Mon]]
 
 
 
 
 
 
b) Acessando a interface de configurações do UniDANFE
 
 
Ao carregar o UniDANFE com o parâmetro “configurar=1” a interface administrativa de configuração é apresentada.
 
 
Ex: UniDANFE.exe configurar=1
 
 
Acrescentando o parâmetro “import=<nome do xml de configuração>”, uma configuração do UniDANFE, previamente exportada, será importada automaticamente. Nesse caso, a interface administrativa não será mostrada. Caso a configuração recebida por parâmetro já exista na base de dados, a base de dados será sobreposta por ela.
 
 
Ex: UniDANFE.exe configurar=1 import=”c:\uninfe\unidanfe\tmp\unidanfe_minha_config1.xml”
 
 
c) Acessando o Gerenciador de Licenças do UniDANFE
 
 
Ao carregar o UniDANFE com o parâmetro “licenciar=1” o gerenciador de licenças do UniDANFE Plus é apresentado.
 
 
d) Consultando a versão/release do UniDANFE
 
 
Ao carregar o UniDANFE com o parâmetro “versao=1” o UniDANFE cria um arquivo com o nome “versao.xml” na mesma pasta onde estiver instalado, contendo a versão, release e compilação atual do UniDANFE.
 
 
e) Consultando e-mails a enviar, enviados ou com erros Ao acessar a interface administrativa de e-mails, é possível ver os e-mails nas pastas “A Enviar”, “Enviados” e “Com Erro”. e.1) A Enviar
 
 
Ao gerar um e-mail para ser enviado ao destinatário, o UniDANFE o coloca na pasta “A enviar”. Concluída a operação do DANFE/CC-e/DACTE (impressão, geração do e-mail, cópia do PDF ou XML para uma pasta local ou da rede, etc), o UniDANFE é fechado de modo a liberar o sistema ERP que porventura estivesse preso por tê-lo chamado. No mesmo momento, uma outra instância do UniDANFE é iniciada para disparar todos os e-mails da pasta “A Enviar”. Em caso de erro durante a tentativa de envio, a mensagem gerada é gravada junto ao e-mail, e pode ser consultada pressionando-se o botão “Erros”. O UniDANFE faz até 50 tentativas de envio dos e-mails. Após isso, ele move automaticamente a mensagem para a pasta “Com Erro”.
 
 
- O botão “Anexos” permite ver os anexos da mensagem selecionada; - O botão “Editar” permite editar a mensagem selecionada. Esse botão funciona apenas para mensagens nas pastas “A enviar” e “Com erro”. - O botão “Excluir” permite excluir a mensagem selecionada. - O botão “Erros” permite consultar os erros gerados nas tentativas de envio da mensagem selecionada; - O botão “Enviar” dispara o processo de envio das mensagens da pasta “A enviar”. - O botão “Remetentes” acessa a tela de configuração de contas de remetentes de e-mails. e.2) Enviados
 
 
Após o envio com sucesso da mensagem de e-mail, a mesma é movida para a pasta “Enviados”, onde pode ser consultada posteriormente. As mensagens desta pasta ficam cronologicamente separadas pelo mês e ano da emissão do documento para facilitar sua consulta e localização. - Os botões “Anexos”, “Editar”, “Excluir”, “Erros” e “Remetentes” possuem as mesmas funções descritas no item e.1; - O botão “Reenviar” permite reenviar a mensagem selecionada. Ao ser pressionado, a mensagem é movida para a pasta “A enviar”, de onde pode ser enviada pressionando-se o botão “Enviar” daquela pasta.
 
 
e.3) Com Erro
 
 
Após 50 tentativas de envio sem sucesso, a mensagem de e-mail é movida para a pasta “Com Erro”. Uma vez nessa pasta, o administrador do sistema pode ainda consultar os erros ocasionados durante as tentativas de envio e solucioná-los. Para mover as mensagens dessa pasta para a pasta “A enviar” para nova tentativa de envio, basta pressionar o botão “Reenviar”. f) Forçando o envio dos e-mails presos na caixa “a enviar”
 
 
Para forçar o UniDANFE a enviar os e-mails presos na pasta “A Enviar”, basta pressionar o botão “Enviar”. Se uma instância do UniDANFE já estiver enviando e-mails, outra não será aberta, para evitar consumo de recursos da máquina.
 
 
Também é possível executar esse procedimento via parâmetros da linha de comando, conforme segue:
 
 
Ex: UniDANFE.exe envia_email=1 g) Gerando um relatório dos e-mails da pasta “Enviados” O UniDANFE pode gerar um arquivo XML com as informações básicas dos e-mails contidos na pasta “Enviados”, para fins de relatório e conferências em geral. Também é possível imprimir o relatório através do UniDANFE. Ex: UniDANFE.exe rel_email=1 A tela abaixo é exibida, solicitando o período da data de emissão dos documentos que se deseja listar, além da pasta de onde devem ser lidos os e-mails, bem como se o relatório deve ser impresso ou não.
 
 
Para informar diretamente o período através da linha de comando, utilize o exemplo abaixo. Se o período for passado por parâmetro, a tela de seleção não será exibida ao operador. Nesse caso, se não informados, os outros parâmetros serão assumidos por padrão, sendo Pasta=“Enviados” e Imprimir=“Não”: UniDANFE.exe rel_email=1 datai=“01/09/2010” dataf=“16/09/2010” ou UniDANFE.exe rel_email=1 datai=“2010-09-01” dataf=“2010-09-16” Além do período, é possível passar os outros campos por parâmetro. Exemplo: UniDANFE.exe rel_email=1 datai=“01/09/2010” dataf=“16/09/2010” imprimir=1 pasta=“Enviados” Ao utilizar esse recurso, será criado um arquivo do tipo XML na pasta do UniDANFE com as informações dos e-mails, de acordo com o período informado, com a seguinte nomenclatura: Rel_email_nnnnnnn.xml, onde nnnnnn = “enviados”, “enviar” ou “erros”, conforme o caso. Se o parâmetro “imprimir” contiver o valor “1”, ao invés de gerar o arquivo XML com as informações dos e-mails, será gerado um relatório com as respectivas informações e enviado para a impressora padrão. h) Carregando a tela de configuração de contas de e-mail (remetentes) É possível executar o UniDANFE para acessar diretamente a tela de cadastro de remetentes de e-mail. Para isso, basta passar o parâmetro configurar_remetente=1 ao UniDANFE, na linha de comando. Ex: UniDANFE.exe configurar_remetente=1 i) Consultando uploads pendentes
 
 
Através dessa tela é possível consultar os arquivos que aguardam para serem enviados ao servidor FTP. AO clicar em cada registro da grid as informações do arquivo são exibidas logo abaixo, bem como a última mensagem de erro gerada durante a última tentativa de envio. Essas informações serão úteis para a configuração do sistema.
 
 
j) Gerando um arquivo XML com a lista das licenças instaladas Para gerenciamento das licenças via software externo (ERP), é possível solicitar ao UniDANFE gerar um arquivo XML (licencas.xml) com as principais informações das licenças Plus instaladas. Exemplo: UniDANFE.exe listar_licencas=1 k) Atualizando o sistema automaticamente O UniDANFE possui o recurso de Autoupdate quando funciona integrado ao DANFE Mon. Para isso, basta instalar o UniDANFE e o DANFE Mon na mesma pasta e configurar a periodicidade com que deseja que o sistema procure por atualização na internet. Para quem não instalou o DANFE Mon, há a possibilidade de solicitar ao UniDANFE que procure pelas atualizações sempre que desejar. Para isso basta acessar a opção “Atualizar” do painel de controle ou passando o parâmetro seguinte na linha de comando: Exemplo: UniDANFE.exe autoupdate=1 display=0 pc=“c:\pasta da configuração do UniDANFE” Onde: Autoupdate=1 é o comando que indica ao UniDANFE que este deve procurar pela atualização; Display (0/1) – indica ao UniDANFE se deve mostrar a tela com o status da atualização (abaixo); PC = pasta onde se localiza a configuração do UniDANFE (opcional).
 
 
 
l) Buferizando as impressões do UniDANFE.
 
 
O UniDANFE pode trabalhar de modo a buferizar todas as impressões de documentos em papel A4, para imprimi-las apenas quando o usuário desejar. Pode-se, por exemplo, trabalhar um período inteiro emitindo os documentos, gerando e-mails, etc, e efetuar as impressões dos DANFEs apenas no final da tarde. Para isso basta executar o UniDANFE passando o parâmetro “buffer=n”, podendo “n” ser: Buffer=1 - Inicia a buferização. A partir dele, nenhum documento gerado em A4 é impresso mais. Suas “imagens” são armazenadas na pasta "buffer" para posterior impressão. Buffer=2 - Finaliza a buferização, enviando todos os documentos em buffer para a impressora. i=<impressora> = quando buffer=2, o usuário pode enviar o parâmetro para definir em qual impressora deseja que os documentos sejam impressos. Se for omitido, serão impressos nas impressoras definidas no momento da geração dos documentos. Buffer=3 - finaliza a buferização, sem imprimir. Todos os documentos em buffer são apagados. Buffer=4 - pausa a buferização. A partir desse comando o sistema não buferiza mais os documentos até receber outro buffer=1. Os documentos buferizados não são apagados e ficam aguardando outro buffer=1 para reiniciar, ou buffer=2 ou 3 para finalizar a buferização.
 

Edição atual tal como às 13h53min de 17 de fevereiro de 2022

Integrando o UniDANFE ao sistema ERP

A integração do UniDANFE ao sistema ERP pode ser realizada de duas formas:

a) Por meio de execuções (RUN) do aplicativo UniDANFE.exe com a passagem de parâmetros

  1. Formato da chamada ao UniDANFE
  2. Lista completa dos comandos de integração
  3. Exemplos de chamada ao UniDANFE em diversas linguagens

b) Por meio de DLL linkada ao sistema ERP

  1. DLL Win32 (UNIDANFE_DFE.DLL)
    1. Documentação e exemplos
  1. DLL em C# (Unimake.Unidanfe)
    1. Documentação e exemplos

Veja também