Informações gerais
Objetivo: |
Implementada a integração de documentos recebidos no CRC para o sistema Domínio via API. |
Detalhes: |
|
Informações adicionais: |
|
Com essa implementação agora é possível realizar a integração dos recebimentos realizado no CRC via API para o sistema Domínio.
Para ter acesso ao menu no CRC é necessário liberar o acesso para o usuário, no controle de acesso aos menus do módulo Controle.
Parametrizando o perfil.
Para os envios automáticos dos recebimentos é necessária a criação de 1 ou mais perfis, todas as abas necessitam de preenchimento, algumas não são obrigatórias.
1 - Aba Dados.
Cada perfil terá um código sequencial e uma descrição, a descrição aceita até 100 caracteres.
O preenchimento será de acordo com a necessidade, temos na aba "Dados" o campo "Filtro", que é para realizar a seleção dos clientes que serão usados nos envios.
No filtro de cliente e tipo de documento é possível utilizar o campo "Tipos" com a opção de ignorar ou não a informação preenchida, por exemplo:
Tipo de cliente (Vazio = Todos) com a opção Igorar.
Buscamos essa informação do cadastro de clientes, aba Diversos:
Se informado o tipo e habilitado o "ignorar", não serão selecionados os recebimentos desse cliente.
Se informar o tipo, mas não habilitar a opção "ignorar", somente os clientes com os tipos informados terão os recebimentos enviados .
O mesmo acontece com o tipo de documento, mas esse será o próprio código do tipo de documento, sempre separando por vírgula "," quando houver mais de um tipo a ser informado.
Inserimos o botão info para facilitar o entendimento:
Usuário Responsável:
Esse campo é parametrizado com o usuário responsável, pois se acontecer algum problema durante o envio será disparado um e-mail, por isso o usuário responsável precisa ter os dados de e-mail parametrizados no módulo de Controle:
Configurações Domínio:
Os dados abaixo serão fornecidos pelo sistema Domínio, pois são as credenciais para conexão com a API.
- Cliente ID;
- Cliente Secret;
- Audience.
2 - Empresas /Filiais.
A Domínio disponibiliza para cada empresa/filial uma chave de comunicação por CNPJ "Integration Key", portanto para cada filial será gerada uma chave diferente, por isso é necessário o cadastro dessa chave corretamente para cada empresa e filial, pois é validado o CNPJ no momento do disparo da integração.
Após inserir as informações clicar no + para carregar os dados na grid:
3 - E-mails para Notificações:
O preenchimento dos e-mails para notificações não é obrigatório, mas se preenchido os contatos informados receberão um e-mail no caso de algum erro de envio dos recebimentos.
Ao informar o e-mail clicar no + para inserir na grid.
4 - Periodicidade.
Após preencher todos os parâmetros para filtros como clientes, empresas e filiais que vão enviar os recebimentos, agora vamos para a parte mais importante que é o agendamento desses envios.
Temos algumas opções, mas em comum e imprescindível o preenchimento do horário e quantidade de dias retroativos que o sistema irá buscar para enviar os recebimentos.
Importante: O serviço irá iniciar de 5 em 5 minutos, mas o envio dos recebimentos só ocorrerá no horário agendado no perfil, se houver algum recebimento realizado após o horário do perfil agendado será enviado somente no dia seguinte, conforme a parametrização, mas se o envio precisar ser na data atual é possível um novo disparo alterando a hora do envio.
4.1 - Seleção por dias da semana:
Selecionar os dias da semana, hora de envio e quantidade de dias retroativos.
4.2 - Selecionar por dias do Mês.
Apenas nessa opção temos mais um condição, é possível, caso o dia informado seja um feriado escolher 3 opções:
- Enviar normalmente no dia selecionado;
- Antecipar para o dia útil anterior;
- Postergar para o dia útil seguinte.
4.3 - Enviar todos os dias.
Havendo recebimentos será sempre enviado, nessa opção informaremos apenas a hora e dias retroativos, sem necessidade de informar os dias, sejam da semana ou do mês.
No campo dias retroativos tem um INFO com detalhe dessa opção.
5 - Log
O log vai trazer as informações sempre que o serviço iniciar e possui um prazo de 10 dias da sua data de criação para ser deletado automaticamente do banco de dados.
Sempre que o serviço iniciar será gerado um log identificado sempre pela coluna "Lote":
É preciso informar a data que precisa e clicar em Pesquisar:
Como podemos observar, tenho 2 perfis cadastrados, portanto o lote é o mesmo independente de qual perfil está sendo validado.
Temos o início, em seguida a descrição de qual perfil foi iniciado e concluído para depois termos o FIM, que encerra essa execução.(Lote)
Quando o serviço iniciar os envios antes ou depois do horário agendado teremos no log a seguinte descrição:
Antes do horário de envio:
No exemplo abaixo, o perfil 1 está com o horário do agendamento para 12h e o serviço iniciou o envio às 11:49, portanto a mensagem é que não esta dentro das regras de periodicidade de execução.
Depois do horário de envio:
No perfil 2 o horário era às 9:30 da manhã, já foi executado, portanto a mensagem é o nome no perfil (código do perfil - 2, descrição - TESTE 2 DOM) já foi executado.
Quando o serviço iniciar o envio e não tiver documentos recebidos para serem enviados a descrição do log informará que não foram encontrados documentos para envio:
Temos filtros simples e avançados para facilitar a busca das informações desejadas, no caso irei filtrar o lote:
Filtrei o lote 7
No filtro avançado marquei para filtrar todos os que continham XML na descrição:
Então, podemos observar todos os registros de envio dos recebimentos com os números dos documentos:
Agora irei mostrar um exemplo de documentos enviados no horário do agendamento:
O Lote 1 corresponde ao envio de documentos do perfil 1 e 2;
Tivemos integração iniciada e finalizada do perfil 2, em seguida iniciada do perfil 1, finalizando ao término dos envios.
Para cada documento integrado são gerados 2 processos no log, o envio do recebimento e o retorno da consulta, que vai mostrar se o recebimento foi ou não integrado:
Quando constar como armazenado na API, é porque a integração ocorreu com sucesso:
Importante:
Não serão integrados documentos de adiantamento ou devolução, os documentos com adiantamento associado, desde que liquidados, serão integrados normalmente, somente não serão integrados quando a baixa do documento por associação de adiantamento ou devolução for parcial, ou seja, quando o documento tem adiantamento associado, mas não esta liquidado ainda.
6 - Documentos.
Nessa aba teremos todo os documentos que foram integrados com o sistema Domínio. Os dados da empresa e filial, os dados do documento, data de recebimento, a data do envio e o retorno da consulta:
Quando houver alguma inconsistência, que esta aguardando processamento da Domínio, basta clicar com o botão direito do mouse para ter o retorno atualizado.
Com o botão direito do mouse escolher a opção "Atualizar consulta".
E será realizada atualização e processada a integração:
Se algum documento teve o recebimento cancelado e gerado novamente, ou até mesmo precisou ser reenviado mesmo que já tenha sido integrado, basta clicar com o botão direito do mouse e escolher a opção reenviar:
Como a mensagem diz, será reenviado na próxima execução do serviço, conforme periodicidade, ou seja, se já executado somente no próximo dia, se o reenvio foi antes do horário agendado será enviado assim que executado o serviço no horário de envio.
Se algum auxílio ou esclarecimento for necessário, conte conosco através de nossos canais de atendimento.
Telefone: (11) 5018-2525.
Portal do Cliente: https://portaldocliente.praxio.com.br/
#PodeContar
#IA
Este artigo foi útil?
Que bom!
Obrigado pelo seu feedback
Desculpe! Não conseguimos ajudar você
Obrigado pelo seu feedback
Feedback enviado
Agradecemos seu esforço e tentaremos corrigir o artigo