FAQ - Instalação do Monitor DFe Protheus

Tenha suas dúvidas técnicas sobre a instalação do Monitor DFe Protheus esclarecidas.

Aplicação do Pacote


Qual é a diferença entre aplicar o pacote em base de produção e em base de homologação?

Ambos os processos de aplicação são semelhantes, porém é fundamental ressaltar que a atualização em um ambiente de produção deve ser cuidadosamente planejada, levando em consideração a importância de manter a funcionalidade do sistema para os usuários. É crucial comunicar a todos os setores da empresa sobre a atualização, uma vez que a janela de manutenção pode ser mais restrita nesse ambiente. Em homologação, geralmente não é necessário interromper as atividades, já que seu propósito é facilitar os testes de novos recursos antes da aplicação oficial em produção.


O que fazer se o repositório não conseguir ser acessado em modo exclusivo?

Certifique-se de que não há nenhum usuário conectado no sistema e nenhum serviço consumindo dados do ambiente, como Jobs e Webservices. Para habilitar o modo exclusivo, é necessário parar todos os serviços do Protheus e iniciar apenas o serviço que será utilizado para a aplicação do pacote e do compatibilizador do dicionário de dados. Prefira escolher um serviço no qual os usuários não possam acessar acidentalmente. Uma maneira de garantir isso é criar um Appserver separado com uma porta nova, que nenhum usuário tenha configurado em suas estações de trabalho.

 

Configurações


Como escolher nomes apropriados para as tabelas do sistema?

Os nomes das tabelas devem ser compostos por três caracteres e devem iniciar com a letra Z ou SZ. É altamente recomendável que sigam uma sequência lógica, como por exemplo, ZA1, ZA2, ZA3, e assim por diante. Isso facilitará a identificação do intervalo de tabelas utilizadas pelo sistema e auxiliará na escolha de novas tabelas no futuro, além de contribuir para a documentação do sistema na empresa. Vale ressaltar que os nomes das tabelas devem ser únicos e não podem se repetir dentro do arquivo SX2.


Quais são as implicações se as respostas para as perguntas sobre o campo de número da nota fiscal, zeros à esquerda, e manifesto de confirmação não estiverem corretas?

Se as definições de zeros à esquerda no número da nota e nas séries não estiverem corretas, pode haver dificuldade para o sistema identificar um XML como lançado no arquivo SF1 (Documento de Entrada). Isso ocorre porque uma das formas de identificação de um lançamento é pela combinação do número da nota, séries, fornecedor e loja, que formam a chave única de um registro SF1 no Protheus.
A configuração do manifesto de confirmação deve ser cuidadosamente avaliada de acordo com o ambiente no qual o sistema está sendo instalado. Se for em um ambiente de homologação, é aconselhável desabilitar essa opção. Isso porque, caso esteja habilitada, o sistema realizará a integração com o portal e efetivará o manifesto de confirmação assim que um XML for identificado e classificado. É importante ressaltar que uma vez realizado o manifesto, não será possível desfazê-lo.

 

Configuração dos Pontos de Entrada

Como identificar se um ponto de entrada específico já está em uso e quais alterações são necessárias?

Para identificar um ponto de entrada em uso, é recomendável contatar a equipe responsável pela gestão das versões dos arquivos. Geralmente, esses pontos de entrada estarão armazenados em um repositório de objetos ou em pastas no servidor do Protheus.

Outra maneira de identificar os pontos de entrada em uso é acessando o módulo de configuração SIGACFG, por meio do menu Ambiente > Cadastros > Catálogo de Personalização (CFGA030). Neste local, é possível encontrar todos os pontos de entrada identificados pelo Protheus que estão compilados no repositório de objetos. No entanto, é importante ressaltar que ainda será necessário localizar o arquivo fonte para realizar as adaptações e recompilação no ambiente.



Quais são as etapas para compilar os pontos de entrada e garantir que estejam corretos?

Cada ponto de entrada possui uma estrutura adequada para garantir seu pleno funcionamento, a qual está detalhada no manual de instalação, na seção 3. Alguns pontos de entrada devem conter a instrução do sistema no início do arquivo fonte, enquanto outros devem ficar no final. É importante destacar os pontos de entrada MT100LOK e MT100TOK, pois possuem uma particularidade diferente dos demais. Ambos são executados duas vezes durante o processo de importação de um XML, sendo suas adaptações planejadas para ocorrerem somente uma vez, na etapa final da importação. Por isso, é crucial seguir a estrutura indicada no manual.

As adaptações devem ser realizadas por um desenvolvedor ADVPL. Dependendo da lógica implementada, podem ser necessárias outras adaptações além das previstas no manual. Por exemplo, ao utilizar a função FunName(), é importante considerar que o retorno dessa função pode variar conforme o programa origem que a chamou.

A compilação de um ponto de entrada deve ser feita com o repositório em modo exclusivo, garantindo que nenhum usuário ou processo esteja acessando o RPO. Certifique-se de compilar em todos os repositórios utilizados pelo sistema, especialmente nos casos em que o serviço é separado e cada porta acessa um repositório diferente (EPR e Job).

Mesmo que um ponto de entrada não esteja sendo utilizado atualmente, é recomendável compilá-lo de acordo com as orientações do manual. Para facilitar, é possível acessar a versão original por meio de um link disponível no manual, no início da seção 3.

Após concluir todas as adaptações de compilações, acesse o sistema através do menu criado, onde será apresentada uma mensagem de alerta caso algum ponto de entrada não tenha sido compilado.


Como proceder se surgir um erro ao compilar os pontos de entrada?

Os pontos de entrada presentes no manual em sua forma original foram compilados sem erros. Caso seja identificado algum problema de compilação, é recomendável contatar a equipe de onboarding, gerente de conta ou suporte que esteja acompanhando o processo. Para os pontos que foram adaptados, o responsável pelas alterações deve ser contatado, pois será a melhor pessoa para corrigir o problema.

 

Criação da Rotina no Menu


Quais são as implicações de adicionar a rotina em um menu diferente do sugerido?

Normalmente não há problemas. Sugerimos seguir a configuração do menu conforme disponível para os usuários do Protheus. No entanto, é importante considerar que, dependendo do módulo, alguns campos de tabelas padrões podem não estar visíveis para os usuários. Por esse motivo, o módulo de compras é utilizado como padrão, pois possui todos os campos necessários para a importação de um XML e a geração de um documento de entrada.


O que fazer se a rotina não aparecer no menu?

Certifique-se de verificar se está acessando o Protheus no ambiente correto e se o usuário utilizado tem o menu configurado no seu perfil. Para confirmar essas informações, acesse o módulo de configuração SIGACFG, por meio do menu Usuários > Senhas > Usuários. Lembre-se de que no Protheus, um menu pode ser configurado para um grupo de usuários, portanto, verifique também o grupo ao qual o usuário pertence e o menu do grupo através do menu Usuários > Senhas > Grupos.


Autenticação do Sistema


Como proceder se a autenticação do sistema falhar ou o ID de integração não for aceito?

O ID de autenticação contém dois hashes diferentes, um para o ID e outro para a CHAVE. Um hash é uma sequência de caracteres aleatórios usado para identificar exclusivamente um registro ou conta. Se um ID diferente de um hash de 40 caracteres foi inserido no sistema, é necessário revisar os parâmetros ARQV_ID e ARQV_KEY.

Considere também verificar se há alguma restrição de acesso externo pela porta 443 no servidor do Protheus e se o endereço api.arquivei.com.br está autorizado.

Confirme também se a filial está autorizada para utilizar o sistema. Para obter essa informação, consulte o contrato da ferramenta ou entre em contato com a pessoa responsável pelo processo de implantação.

Se mesmo assim o sistema não estiver liberando, recomendamos entrar em contato com o time de onboarding, gerente de conta ou suporte que esteja acompanhado na implantação. As credenciais de autenticação do sistema raramente apresentam falhas, mas eventualmente podem ser enviadas para você de forma incorreta, por isso, é importante verificar cada caractere com atenção.

 

Configuração do Job de Leitura de Arquivos


Qual é a diferença entre configurar o Job via OnStart e via Schedule, e qual método é mais apropriado para o meu ambiente?

A opção OnStart implica em ter um serviço específico para executar a integração dos XMLs, enquanto o Schedule é o serviço padrão do Protheus para agendamento de tarefas, com uma interface gráfica para auxiliar na configuração. A melhor escolha é seguir a estrutura já estabelecida no ambiente. Se a equipe já está habituada a utilizar um método específico para executar os Jobs, é recomendável manter esse padrão.

Embora não conte com uma interface gráfica, a opção OnStart é mais simples e rápido de configurar do que o Schedule. A utilização do Schedule pode se tornar mais complexa dependendo da quantidade de tarefas já cadastradas na aplicação.

A sugestão da equipe técnica é optar pela configuração exclusiva no OnStart, garantindo que seja dedicado apenas à integração de recebimento dos XMLs. Isso ajudará a evitar possíveis interferências de outras tarefas e tornará a identificação de falhas mais fácil.


Como diagnosticar e corrigir erros comuns encontrados ao configurar o appserver ou o Schedule?

Para identificar possíveis problemas e monitorar o desempenho dos serviços de integração, é recomendado acessar os registros de log localizados nas pastas "protheus_data\importador_xml\logs\cxnfarq" e "protheus_data\importador_xml\logs\cxnfemp". Caso o seu ambiente for TCloud, esse acesse deve ocorrer via FileZilla, WinSCP ou similar. Esses registros são gerados diariamente e devem ser atualizados de acordo com a frequência configurada no serviço. Caso ocorra alguma falha durante o processo, as mensagens de esclarecimento serão exibidas nessas pastas. No entanto, se o registro de log não estiver disponível para o dia em questão, isso pode indicar um problema na configuração do serviço, sendo assim, o log mais apropriado para acompanhamento é o do próprio serviço ou appserver configurado.

Uma sugestão para identificar possíveis problemas na configuração do serviço é acessar o Protheus na porta designada para o Job. Algumas mensagens de erro podem se tornar mais evidentes ao acessar o sistema, como questões relacionadas ao repositório de objetos.


C
omo garantir que o Job está configurado corretamente para ler e gerenciar os XMLs?

Para verificar se os XMLs estão sendo integrados corretamente, é recomendável acessar o log de integração dos XMLs no arquivo cxnfarq_<data_atual>.log na pasta "protheus_data\importador_xml\logs\cxnfarq". Esse log irá exibir a quantidade de XMLs encontrados e o processo de cada um, fornecendo informações de registro e a mensagem "XML registrado com sucesso!". Não se preocupe se alguns XMLs forem ignorados ou não registrados, pois isso é um comportamento esperado.

Para acompanhar o serviço de gerenciamento de XML, verifique o log cxnfemp_<data_atual>.log na pasta "protheus_data\importador_xml\logs\cxnfemp". Neste registro, você encontrará a identificação dos CNPJs liberados, a descrição dos serviços em execução, como o CXNFJOB1 e CXNFJOB4, e o tempo de finalização do processamento. Essa informação é repetida de acordo com a frequência configurada no serviço.

Se ocorrer algum erro, ele será registrado no log correspondente com uma mensagem parecida com os erros padrões do Protheus, contendo detalhes sobre o problema e as etapas de execução.

 

Integração com o portal da Qive


Como se dá a comunicação entre o Qive e o Protheus?

A integração dos XMLs com o Protheus é realizada por meio das APIs do Qive, que são executadas pelo serviço de integração dos XMLs (função CXNFARQ). A comunicação é feita pela porta 443, que é o padrão para comunicação HTTPS, utilizando a tecnologia FWRest do ADVPL. 

A cada requisição do serviço, são extraídos vários XMLs que são então armazenados diretamente no banco de dados do Protheus, nas tabelas específicas do sistema. Esses registros são gerados com base nas informações do XML e na filial correspondente ao CNPJ do destinatário/tomador.

Um serviço adicional (função CXNFEMP) é responsável por identificar todos os novos XMLs integrados e processá-los na filial correspondente. Ele busca informações do fornecedor e do lançamento do XML para exibição na tela de documentos pendentes de importação.