GF - Como Fazer - Carta de Cobrança Automatizada pelo Gerenciador de Processos

De CIGAM WIKI

Como Fazer Finanças

Carta de Cobrança Automatizada

[editar]

[Versão 231002.c 1]Nesse processo disponibilizamos o relatório de Cartas de Cobrança como uma rotina capaz de rodar de forma agendada e automatizada pelo Agendador de Processos do CIGAM, promovendo a hiper automação das rotinas do cliente em seu gerenciamento da geração das Cartas de Cobrança a nível de envio por e-mail.

Configuração de Servidores - Carta de Cobrança

[editar]

Deverão ser criados 2 servidores em BPM/Workflow/Cadastros/Servidores conforme:

  • Um servidor do tipo “Servidor de Tarefas” com as seguintes características:
    • Nome sugestão: “MAQUINA LOCAL”
    • Opção “padrão” desmarcada


  • E por fim, precisa ser criado um servidor do tipo “Aplicação: CIGAM Magic Spaces (xpa/xpi)” com as seguintes característica:
    • Nome sugestão: “BROKER (FINANC)”
    • Endereço Servidor: "cigam-web8:13520/broker" para ambientes em SQL ou "cigam-web8:13530/broker" para ambientes Oracle.
    • Tipo: MGRqISPI.dll

Inclusão no gerenciador de processos - Carta de Cobrança

[editar]

Depois de criados os servidores, deve-se ir até BPM/Workflow/Movimentos/Gerenciador de processos para realizar o cadastro e parametrização da Carta de Cobrança, conforme abaixo:

Clique em “Agendar Processo”:

  • Insira em “Servidor de Tarefas” o código do servidor “Maquina Local”.
  • Em “Servidor de Aplicação” informe o código do servidor “BROKER (FINANC).

No campo “Tarefa” tecle F5 e selecione a opção “CARTAS DE COBRANÇA”:

Depois no campo “Parâmetros”, tecle novamente F5 e insira os filtros conforme necessidade.


Detalhamento de campos Parâmetros

[editar]

  • Considerar apenas lançamentos à vencer: Este campo é responsável por definir o tipo de registro a ser gerado no agendamento.

    • Marcado: o agendamento será configurado como aviso de vencimento, enviando somente lançamentos em aberto com vencimento próximo.
    • Desmarcado: o agendamento será configurado como carta de cobrança, enviando somente lançamentos em aberto já vencidos.

  • Nome Relatório: Informe o nome do modelo de relatório a ser utilizado, este modelo deve estar previamente cadastrado no relatório Cartas de Cobrança.

Menu: Finanças > Gestão Financeira > Relatórios > Operacionais > Abertos > Etiquetas/Cartas > Cartas de Cobrança.



  • Unidade de Negócio Inicial: Faixa inicial de Unidade de Negócio.
  • Unidade de Negócio Final: Faixa final de Unidade de Negócio.
  • Atraso mais de (dias): Este campo é utilizado apenas para carta de cobrança, ou seja, agendamentos com o campo "Considerar apenas lançamentos à vencer" desmarcado. Se o agendamento for em visão de aviso de vencimento não deve ser informado.

    Informe aqui a quantidade de dias em atraso desejado, esse valor irá compor os filtros de vencimento gerados pelo sistema em conjunto com a Recorrência. Exemplo: informando "15" dias de atraso e a data de execução do agendamento será "04/10/2023", serão retirados 15 dias dessa data e enviados lançamentos com vencimento até "19/09/2023".

  • Portador Inicial: Faixa inicial de portador.
  • Portador Final: Faixa final de portador.
  • TG Portador: Filtro de TG de portadores.
  • Categoria TG Inicial: Faixa inicial de categoria da TG.
  • Categoria TG Final: Faixa final de categoria da TG.
  • Sel. Múltipla Portadores: Este campo permite a seleção múltipla de portadores, para utiliza-lo separe os portadores informados por vírgulas e sem espaços (Exemplo: C01,C03,C05).
  • Histórico Inicial: Faixa inicial de histórico.
  • Histórico Final: Faixa final de histórico.
  • Conta Inicial: Faixa inicial de conta financeira.
  • Conta Final: Faixa final de conta financeira.
  • Tipo Pagamento Inicial: Faixa inicial de tipo de pagamento.
  • Tipo Pagamento Final: Faixa final de tipo de pagamento.
  • Usar o nome do modelo como assunto do e-mail: Quando marcado envia o e-mail com o assunto contendo o nome do modelo informado no campo "Nome Relatório".
  • Considerar previsões financeiras: Quando marcado irá considerar lançamentos de previsão na geração do relatório e envio por e-mail.
  • Incluir o Complemento do Histórico: Quando marcado incluirá no e-mail o complemento do histórico informado no lançamento.
  • Posição Inicial (Compl. Histórico): Campo destinado a informar a posição inicial do complemento do histórico do lançamento.
  • Tamanho (Compl. Histórico): Campo destinado a definir a máscara a ser utilizada no complemento do histórico no lançamento a partir da posição inicial.
  • [Versão 251103 1]Vencimento maior que (dias): Este campo é utilizado apenas para aviso de vencimento, ou seja, agendamentos com o campo "Considerar apenas lançamentos à vencer" marcado. Se o agendamento for em visão de carta de cobrança não deve ser informado.

Informe aqui a quantidade de dias a vencer desejado, esse valor irá compor os filtros de vencimento gerados pelo sistema em conjunto com a Recorrência. Exemplo: informando "7" dias com data de execução do agendamento como "04/10/2023", serão adicionados 7 dias dessa data e enviados lançamentos com vencimento "11/10/2023".

IMPORTANTE: Apenas um filtro de portador deverá ser informado, sendo Portador Inicial e Final, ou TG Portador e suas categorias, ou Seleção Multipla de Portadores.

Recorrência

[editar]

A execução da carta de cobrança agendada exige uma regra de filtros determinada e inicialmente imutável até que seja alterada, ou seja, não se deve executar esta rotina pelo agendador caso se queira usar regras de filtro de vencimento que mudem a cada execução.

Após o preenchimento dos parâmetros informe o usuário de execução e programe a recorrência. Para programar a recorrência acesse a guia Recorrência, estarão presentes 5 opções de execução, porém, essa funcionalidade não comporta agendamentos por minuto ou hora, utilize dia, semana ou mês conforme necessidade. De acordo com o formato informe o período que o agendamento deve ser executado e o início do intervalo de execução. Conforme os parâmetros de recorrência o sistema automaticamente definirá uma faixa de filtros de vencimento para cada execução, abaixo detalharemos cada recorrência.

    A fim de evitar possíveis duplicidades no envio de cartas de cobrança não é permitido a utilização de execuções por minuto ou hora, devendo ser preenchido com um período maior ou igual a um dia.
    


Recorrência Dia

[editar]

1. Carta de Cobrança:

Neste primeiro exemplo utilizaremos a opção diária em visão de Carta de Cobrança. Nesse formato os filtros de vencimento serão gerados conforme o dia de execução e o atraso cadastrado nos parâmetros.

O sistema montará a faixa de filtros da seguinte forma:

  • O filtro de vencimento inicial para carta de cobrança terá o valor fixo de 00/00/0000 de modo a localizar todos lançamentos da base de dados.
  • O filtro de vencimento final será o resultado do cálculo de subtração do valor informado no campo "Atraso mais de (dias)" em relação data atual em que é executado o agendamento.

Exemplo:

Tenho um agendamento diário de Carta de Cobrança com "Atraso mais de (dias)" informado com "15", período "1" e a execução do agendamento será feito em "04/10/2023". O sistema retirará 15 dias de "04/10/2023", resultando em 19/09/2023, a faixa de filtros de vencimento será "00/00/0000 a 19/09/2023". Nessa execução serão enviados todos lançamentos que se encaixarem como carta de cobrança e tenham o vencimento até a data 19/09/2023.

Após a execução o agendamento terá sua próxima execução atualizada conforme o período informado, como nesse cenário o período é "1" o próximo envio de cartas ficará para o dia seguinte 05/10/2023. O sistema mantém o mesmo comportamento para formar a faixa de filtros de vencimento resultando nos filtros "00/00/0000 a 20/09/2023".


2. Aviso de Vencimento:

Neste segundo exemplo utilizaremos a opção diária em visão de Aviso de Vencimento. Nesse formato os filtros de vencimento serão gerados conforme o dia de execução e o período da recorrência, não utilizando o "Atraso mais de (dias)" dos parâmetros.

O sistema montará a faixa de filtros da seguinte forma:

  • O filtro de vencimento inicial será o resultado da soma do valor informado no campo "Vencimento maior que (dias)" em relação data em que é executado o agendamento.
  • O filtro de vencimento final será o resultado da soma do valor informado no campo "Vencimento maior que (dias)" em relação data em que é executado o agendamento.

Exemplo:

Tenho um agendamento diário de Aviso de Vencimento com período "1" e a execução do agendamento será feita em "08/09/2023". Para os filtros de vencimento (inicial e final) será somado o valor do campo "Vencimento maior que (dias)", neste caso o campo informado com "7" resultará em "15/09/2023". Nessa execução serão enviados todos lançamentos que se encaixarem como aviso de vencimento e tenham o vencimento em 15/09/2023.

Após a execução o agendamento terá sua próxima execução atualizada conforme o período informado, como neste exemplo o período é "1" o próximo envio de avisos ficará para o dia seguinte 09/09/2023. O sistema mantém o mesmo comportamento para formar a faixa de filtros de vencimento resultando nos filtro de vencimento "16/09/2023 a 16/09/2023".


Recorrência Semana

[editar]

1. Carta de Cobrança:

Neste primeiro exemplo utilizaremos a opção semanal em visão de Carta de Cobrança. Nesse formato os filtros de vencimento serão gerados conforme o dia de execução e o atraso cadastrado nos parâmetros.

O sistema montará a faixa de filtros da seguinte forma:

  • O filtro de vencimento inicial para carta de cobrança terá o valor fixo de 00/00/0000 de modo a localizar todos lançamentos da base de dados.
  • O filtro de vencimento final será o resultado do cálculo de subtração do valor informado no campo "Atraso mais de (dias)" em relação data atual em que é executado o agendamento.

Exemplo:

Tenho um agendamento semanal de Carta de Cobrança com "Atraso mais de (dias)" informado com "15", período "1" e a execução do agendamento será feito em "04/10/2023". O sistema retirará 15 dias de "04/10/2023", resultando em 19/09/2023, a faixa de filtros de vencimento será "00/00/0000 a 19/09/2023". Nessa execução serão enviados todos lançamentos que se encaixarem como carta de cobrança e tenham o vencimento até a data 19/09/2023.

Após a execução o agendamento terá sua próxima execução atualizada conforme o período informado, como nesse cenário o período é "1" o próximo envio de cartas ficará para a próxima semana no dia 11/10/2023. O sistema mantém o mesmo comportamento para formar a faixa de filtros de vencimento resultando nos filtros "00/00/0000 a 26/09/2023".


2. Aviso de Vencimento:

Neste segundo exemplo utilizaremos a opção semanal em visão de Aviso de Vencimento. Nesse formato os filtros de vencimento serão gerados conforme o dia de execução, "Vencimento maior que (dias)" dos parâmetros e o período da recorrência.

O sistema montará a faixa de filtros da seguinte forma:

  • O filtro de vencimento inicial para aviso de vencimento será o dia atual da execução + valor informado no campo "Vencimento maior que (dias)".
  • O filtro de vencimento final será o resultado do cálculo de adição do período da recorrência em relação ao vencimento inicial.

Exemplo:

Tenho um agendamento semanal de Aviso de Vencimento com período "1", "Vencimento maior que (dias)" como "1" e execução do agendamento como "08/09/2023". Para o filtro inicial será somado um dia a data de execução, resultando em "09/09/2023". Para o filtro final será adicionado o valor do período (1 semana = 7 dias) ao filtro de vencimento inicial, resultando em "15/09/2023". A faixa de filtros de vencimento gerada pelo sistema será "09/09/2023 a 15/09/2023". Nessa execução serão enviados todos lançamentos que se encaixarem como aviso de vencimento e tenham o vencimento entre 09/09/2023 a 15/09/2023.

Após a execução o agendamento terá sua próxima execução atualizada conforme o período informado, como nesse cenário o período é "1" o próximo envio de avisos ficará para a semana seguinte em 15/09/2023. O sistema mantém o mesmo comportamento para formar a faixa de filtros de vencimento resultando nos filtros "16/09/2023 a 22/09/2023".


Recorrência Mês

[editar]

1. Carta de Cobrança:

Neste primeiro exemplo utilizaremos a opção mensal em visão de Carta de Cobrança. Nesse formato os filtros de vencimento serão gerados conforme o dia de execução e o atraso cadastrado nos parâmetros.

O sistema montará a faixa de filtros da seguinte forma:

  • O filtro de vencimento inicial para carta de cobrança terá o valor fixo de 00/00/0000 de modo a localizar todos lançamentos da base de dados.
  • O filtro de vencimento final será o resultado do cálculo de subtração do valor informado no campo "Atraso mais de (dias)" em relação data atual em que é executado o agendamento.

Exemplo:

Tenho um agendamento mensal de Carta de Cobrança com "Atraso mais de (dias)" informado com "15", período "1" e a execução do agendamento será feito em "08/09/2023". O sistema retirará 15 dias de "08/09/2023", resultando em 24/08/2023, a faixa de filtros de vencimento será "00/00/0000 a 24/08/2023". Nessa execução serão enviados todos lançamentos que se encaixarem como carta de cobrança e tenham o vencimento até a data 24/08/2023.

Após a execução o agendamento terá sua próxima execução atualizada conforme o período informado, como nesse cenário o período é "1" o próximo envio de cartas ficará para o próximo mês no dia 08/10/2023. O sistema mantém o mesmo comportamento para formar a faixa de filtros de vencimento resultando nos filtros "00/00/0000 a 23/09/2023".


2. Aviso de Vencimento:

Neste segundo exemplo utilizaremos a opção mensal em visão de Aviso de Vencimento. Nesse formato os filtros de vencimento serão gerados conforme o dia de execução, "Vencimento maior que (dias)" dos parâmetros e o período da recorrência.

O sistema montará a faixa de filtros da seguinte forma:

  • O filtro de vencimento inicial para aviso de vencimento será o dia atual da execução + valor informado no campo "Vencimento maior que (dias)".
  • O filtro de vencimento final será o resultado do cálculo de adição do período da recorrência em relação ao vencimento inicial.

Exemplo:

Tenho um agendamento mensal de Aviso de Vencimento com período "1", "Vencimento maior que (dias)" como "1" e a execução do agendamento como "08/09/2023". Para o filtro inicial será somado um dia a data de execução, resultando em "09/09/2023". Para o filtro final será adicionado o valor do período (1 mês = 31 dias) a data atual de execução (08/09/2023), resultando em "08/10/2023". A faixa de filtros de vencimento gerada pelo sistema será "09/09/2023 a 08/10/2023". Nessa execução serão enviados todos lançamentos que se encaixarem como aviso de vencimento e tenham o vencimento entre 09/09/2023 a 08/10/2023.

Após a execução o agendamento terá sua próxima execução atualizada conforme o período informado, como nesse cenário o período é "1" o próximo envio de avisos ficará para o mês seguinte em 08/10/2023. O sistema mantém o mesmo comportamento para formar a faixa de filtros de vencimento resultando nos filtros "09/10/2023 a 07/11/2023".


Funcionamento da rotina - Carta de Cobrança

[editar]

Ao executar o agendamento os lançamentos que se encaixarem nos parâmetros e recorrência cadastrados serão enviados por e-mail para os contatos válidos da empresa. Essa rotina somente enviará por e-mail, não imprimindo as cartas em tela.

Importante: para os lançamentos serem enviados corretamente a empresa do lançamento deverá obrigatoriamente estar parametrizada da seguinte forma:

    1. Checkbox "Enviar Carta" na guia Geral do cadastro de empresas como "Sim";
    2. Ao menos um contato válido a receber carta de cobrança cadastrado na empresa. Contatos válidos são aqueles que possuam e-mail existente informado e checkbox "Recebe e-mail de Carta de Cobrança" marcado.


Conferindo execuções do processo agendado - Carta de Cobrança

[editar]

Podemos visualizar as execuções de processos de carta de cobrança de duas formas, a primeira é selecionando a guia "Histórico":

A segunda forma se trata de entrar no gerenciador de processos e clicar em “LOGS DE execução/ocorrencia”:

Sempre haverão dois registros de execução, um de início e um registro com o resultado da execução, ambos com chance de sucesso, erros ou advertências. No resultado de sucesso da carta de cobrança teremos um registro nos informando na ação que o processo foi finalizado, enquanto no aviso de vencimento será listada a quantidade de cartas emitidas e o filtro de data de vencimento conforme parametrizado na recorrência.

Possíveis erros e advertências

[editar]

Advertências:

1. Não existem dados com os filtros informados.

Resultados de execução:

Para Carta de Cobrança:

Para Aviso de Cobrança:

    "Executado com avisos: Não existem dados com os filtros informados. Nenhuma Carta de Cobrança foi listada."

Esta advertência surge quando não é encontrado nenhum lançamento a ser enviado como carta de cobrança, recomendamos que selecione o ícone de engrenagem para editar o agendamento e faça as seguintes revisões:

    • Em Parâmetros: Revise os filtros informados.
    • Nos Lançamentos: Valide se a empresa esta apta a receber carta de cobrança, parametrizações necessárias se encontram na seção de funcionamento da rotina deste manual.


Erros:

1. Recorrência diferente ou menor que 1 dia.

Resultado da execução:

    "Erros encontrados: Recorrência para o processo agendado é diferente de Dia ou menor do que 1 dia. As datas de Vencimento como parâmetro estão iguais à da última execução, o que ocasionaria duplicidade na geração do relatório. Altere a recorrência para no mínimo 1 dia."

Para garantir a integridade da geração de cartas de cobrança e evitar possíveis duplicidades, a funcionalidade não permite execuções por minuto ou hora. Altere a recorrência do agendamento clicando no ícone de engrenagem para dia, semana ou mês.


2. Modelo de relatório informado não existe.

Resultado da execução:

    "Erros encontrados: Modelo de relatório informado não existe, informe no parâmetro Nome do Relatório o nome do modelo existente/válido."

Nessa situação o sistema não está encontrando um modelo de relatório para gerar a Carta de Cobrança, recomendamos que os seguintes pontos sejam revisados:

    • Em Parâmetros: edite o agendamento pelo ícone de engrenagem e execute o F5 em Parâmetros, verifique se o campo Nome Relatório está informado corretamente com o nome do modelo previamente cadastrado na rotina de Cartas de Cobrança.
    • No modelo: em Cartas de Cobrança verifique se o relatório informado em "arquivo modelo" está acessível.


3. Utilize apenas um dos filtros de portadores disponíveis.

Resultado da execução:

    "Erros encontrados: Utilize apenas um dos filtros de portadores disponíveis: Portador Inicial e Final, TG de Portador ou Lista de portadores."

Nos Parâmetros do agendamento disponibilizamos a filtragem de portadores por faixa, TG ou seleção múltipla, porém, apenas um dos filtros deve ser utilizado. Edite os parâmetros do agendamento e informe apenas Portador Inicial e Portador Final, ou TG e demais campos de categoria, ou Sel. Múltipla Portadores.


4. TG informada não é de Portador.

Resultado da execução:

Esse erro é acionado quando o sistema entende que a TG informada no campo TG Portador possui o 'Tipo' diferente de "Portador". Utilize uma TG com tipo Portador.


5. Email não enviado.

A mensagem indicará as empresas para as quais não foi encontrado nenhum contato cadastrado com e-mail para o recebimento da Carta de Cobrança.

Nesses casos, é necessário revisar o cadastro da empresa informada, verificando se existe um contato com e-mail registrado e se ele está devidamente marcado para receber a carta de cobrança.

As demais empresas, que não apresentarem divergência de e-mail, terão suas cartas enviadas normalmente.

Documentos Relacionados

[editar]

Versões

[editar]

Versão 231002

[editar]

Patch 'c'

[editar]
  1. Liberado a partir da OS 759090/4.

Versão 251103

[editar]
  1. Liberado a partir da OS 947480/1.