Manual de instalação, configuração e utilização do Enviador XML - PDF Download grátis
Download "Manual de instalação, configuração e utilização do Enviador XML"
Carmem Castelo Fragoso
1 Manual de instalação, configuração e utilização do Enviador XML 1. Conceitos e termos importantes XML Empresarial: é um sistema web (roda em um servidor remoto) de armazenamento e distribuição de documentos fiscais. Enviador XML: é um sistema local (roda no computador do usuário) que interage com o XML Empresarial para prover o armazenamento dos documentos fiscais existentes no computador do usuário. Web Service de Recebimento: é o serviço remoto que recebe e processa os documentos, fazendo a interface entre o aplicativo instalado no computador local e o sistema de armazenamento XML Empresarial. Web Service de Licença: é o serviço remoto que recebe e avalia os pedidos de licença de uso do Enviador XML..NET Framework 4.0: é uma plataforma de software que fornece recursos sob os quais o Enviador XML é desenvolvido. Ela é necessária para o funcionamento do Enviador XML. 2. Descrição O Enviador XML é um software aplicativo que monitora diretórios do computador onde está instalado e faz o envio dos arquivos XML existentes nestes diretórios para o Web Service de Recebimento. O Enviador XML executa periodicamente uma varredura nos diretórios configurados e move os arquivos processados para um outro diretório nomeado de forma sugestiva de acordo com o resultado do envio para o Web Service de Recebimento. IMPORTANTE: O Enviador XML não pode ser utilizado em casos onde os arquivos são necessários para o uso de algum outro software instalado no mesmo computador. O envio de um documento resultará em uma das seguintes situações: DF-e Armazenado: O documento foi armazenado. DF-e Substituído: O documento foi atualizado.
2 Manual de instalação, configuração e utilização do Enviador XML 2 DF-e Existente: O documento já estava armazenado. Falta DF-e Gerador: O documento necessita outro documento anterior que não está armazenado. Ex: Um cancelamento de NF-e exige que a NF-e esteja previamente armazenada. DF-e de homologação: O documento foi emitido em ambiente de homologação. Rejeição da Sefaz: O documento apresenta o protocolo de uso com rejeição. Tipo desconhecido: O documento não foi reconhecido pelo sistema. DF-e Inválido: O documento foi reconhecido, porém apresenta alguma inconsistência que desrespeita a estrutura esperada em algum item. Falha na estrutura: O arquivo não respeita a estrutura XML. Não armazenável: O documento é de um tipo sabido não ser armazenável (arquivos intermediários gerados pelos sistemas de emissão). Nenhum participante autorizado: Nenhuma das pessoas constantes no documento está ativada como cliente do sistema de armazenamento. Sem participação do remetente: O CPF/CNPJ que enviou o documento não consta no mesmo. Falha no recebimento: O sistema remoto de armazenamento apresentou uma falha ao processar o documento. Falha genérica: Houve uma falha no envio do documento (rede, hardware etc). 3. Instalação e configuração O Enviador XML requer o.net Framework 4.0. Caso necessário, o.net Framework 4.0 será baixado e instalado na primeira execução do aplicativo. O instalador do Enviador XML deve ser baixado na página inicial do XML Empresarial, na seção Como instalar? ou diretamente no link Para fazer a instalação, basta executar o instalador e seguir as orientações do assistente de instalação. Não há nenhuma configuração especial a fazer nestas etapas, há apenas opções comuns de criação atalhos e diretório de destino da instalação.
3 Manual de instalação, configuração e utilização do Enviador XML 3 Depois que a instalação tiver sido concluída, é necessário executar o programa (por padrão, a opção de executar após a instalação está ativada). Na primeira vez que o programa é executado, é mostrada a mensagem de que não há nenhuma licença configurada. Neste momento, é necessário solicitar uma licença de uso para o CPF/CNPJ interessado. A licença será avaliada imediatamente pelo Web Service de Licença. Ou seja, não será necessário fazer a liberação manualmente, como ocorre com o Controle de Notas. Figura 1 - Mensagem de licença não existente Para solicitar uma licença, basta acessar o menu Configurações >> Licenças. A seguinte janela será mostrada: Figura 2 Janela de licenças Em seguida, basta informar o CPF/CNPJ desejado e clicar em salvar. O pedido será avaliado automaticamente. Se for mostrada a mensagem Uso concedido, significa que o pedido de uso foi autorizado. Qualquer outra mensagem significa que a licença não foi autorizada.
4 Depois de a licença ter sido liberada, deve-se configurar o(s) diretório(s) que serão monitorados pelo CPF/CNPJ configurado. Basta acessar o menu Configurações >> Diretórios: Figura 3 - Tela de configuração de diretórios Na seção Configurar diretórios, escolha o CPF/CNPJ e clique no campo Diretório para selecionar a pasta desejada. Depois, clique em Salvar. Os diretórios configurados aparecerão na seção Diretórios Configurados. Além das configurações necessárias, é possível alterar algumas outras opções de como o aplicativo se comporta. Estas configurações devem ser feitas de acordo com as características de cada empresa. Basta acessar o menu Configurações >> Preferências: Figura 4 Janela de preferências
5 IMPORTANTE: Na primeira execução, após fazer as configurações necessárias, o serviço de monitoramento dos diretórios deverá ser iniciado manualmente, clicando no menu Arquivo >> Iniciar Monitoramento. Nas demais vezes, o sistema iniciará a varredura automaticamente, desde que exista pelo menos uma licença e um diretório configurados. 4. Utilização O aplicativo sempre iniciará automaticamente com o Windows, de forma que, em geral, o usuário não manipulará diretamente o aplicativo, exceto para conferências de arquivos enviados ou adição de licenças e diretórios. Por este motivo, o aplicativo permite sua execução com a janela principal oculta. A janela principal é ocultada ao clicar no botão fechar ou no menu Arquivo >> Ocultar janela. Também é possível definir que a janela principal não seja mostrada quando o programa inicia, na janela Preferências. A janela principal exibe também a lista dos arquivos enviados, com o respectivo resultado do envio. A verificação de um arquivo pode ser feita pelo nome, período e pelo CPF/CNPJ que fez o envio, porém este recurso só deve ser usado em casos extremos, para verificar o motivo de algum documento esperado não ser localizado no XML Empresarial, pois a verificação cotidiana e usual deve ser feita no próprio portal, através das ferramentas de detecção de documentos faltantes. O aplicativo também mantém um histórico dos eventos e eventuais falhas gerados durante a execução. Estes históricos arquivos ficam armazenados em uma pasta dentro do aplicativo, e podem ser visualizados acessando o menu Outros >> Ver Log. Para dúvidas sobre questões possivelmente não apresentadas neste manual, entre em contato com o suporte técnico. Telefone: