Histórico da Página

Este documento tem como objetivo descrever todos os passos necessários para implantação do produto Gestão de Receita Recorrente integrado ao Protheus 12.

Para integrações externas ou projetos customizados, disponibilizamos a documentação dos serviços disponíveis para consumo na plataforma: https://api-recorrencia.totvs.app/.

Para que a implantação do sistema GRR - Gestão de Receita Financeira ocorra corretamente, sugerimos verificar alguns itens antes de iniciar este processo. Estes itens estão divididos em processos com objetivo de fornecer uma ordem lógica, e não cronológica, por exemplo, é possível definir as soluções antes de determinar a alocação.

Image Removed

Como está dividido o documento?

O Guia de Implantação está dividido na Configuração do GRR, Execução do Wizard Protheus, Cadastros e parâmetros Protheus, Serviços (JobScheduler) e Intermediador de pagamento, Configuração do JobScheduler e Parametrização dos adquirentes. . 

É importante seguir estas etapas de forma sequencial, para garantir que todas as dependências entre os processos sejam executadas da maneira correta.

Procedimento abaixo é destinado a realização do cadastro do adquirente Adyen com cartão de crédito.

Primeiramente, crie uma conta Adyen e forneça as informações necessárias, como nome da empresa, informações de contato e informações bancárias.

Image Removed

Configure a plataforma: Depois de criar uma conta, configure a plataforma Adyen. Isto envolve a configuração de opções de pagamento, configuração de processamento de pagamentos, configuração de notificações e integração com o seu site ou aplicativo.

Abaixo seguem primeiros passos, entretanto demais configurações acessar a documentação do adquirente.

Procedimento para criação do Webhooks da Adyen

Image Removed

Clique em Settings.

Image Removed

Image Removed

Image Removed

Realize o preenchimento dos campos do merchant account.

Image Removed

Após realizado as demais parametrizações, acesse a plataforma GRR, clique em Configurações e realize o preenchimento dos campos para a empresa selecionada.

Image Removed

Image Removed

Deck of Cards
id 999
Deck of Cards
id 2C
Card default true label Configuração do GRR Logo após a realização da adesão do produto e autorizado pelo time da TOTVS, o sistema processo de geração do contrato irá provisionar de forma automática um ambiente do GRR Gestão de Receita Recorrente Será enviado um e-mail com as instruções necessárias para acessar a plataforma com o usuário de administrador do Fluig e assim começar a utilizá-la. Caso você não receba o e-mail informando sobre a disponibilização do acesso ao Fluig após o provisionamento do ambiente da plataforma GRR da Totvs, é recomendável que você entre em contato com o suporte técnico da TotvsTOTVS. Você pode abrir um ticket de suporte para informar sobre o problema e solicitar a ativação do acesso ao Fluig. Modelos de e-mail (poderá ocorrer mudanças no layout) Reserve o número do campo TenantID, pois ele será utilizado no link do gestão do JobScheduler. Você receberá também um e-mail com as credenciais de integração. Essas credenciais são necessárias para configuração da integração com o ERP. Acesse a plataforma com o login do usuário administrador. Através do manager, é possível cadastrar novos usuário para acesso a plataforma. Lembre-se de sempre que criar um novo usuário, associá-lo ap App Recorrência. Card label Execução do Wizard Protheus Para que possa ocorrer a integração com o produto GRR - Gestão de Receita Recorrente é necessário a execução do Wizard Protheus. Aviso title Pré-requisitos Protheus release 12.1.2210 com expedição contínua atualizada: ArquivoImage Added ou Card label Execução do Wizard Protheus Aviso title Pré-requisitos Protheus na release 12.1.2210, com pacote de expedição contínua atualizado Image Removed. Protheus na release 12.1.2310 , com pacote de expedição contínua atualizado atualizada: ArquivoImage Modified.  Para que possa ocorrer a integração com o produto GRR - Gestão de Receita Recorrente é necessário a execução do Wizard Protheus. No caso de ambiente Cloud, a aplicação do pacote deve ser feita através do portal TCloud, conforme documentação abaixo:  https://centraldeatendimento.totvs.com/hc/pt-br/articles/360024948533-CLOUD-MP-Aplicar-pacote Verificar no servidor onde o ambiente está instalado se os endereços listados a seguir estão liberados *: o https://api-recorrencia.totvs.app/api/v1 o https://endpoint-registry.totvs.app/api/v1/services o https://totvs.rac.totvs.app o https://admin.rac.totvs.app o https://recorrencia.totvs.app o app https://app.fluigidentity.com * No caso do ambiente ser CLOUD, o mesmo Apenas para ambiente On-premisse, em ambiente CLOUD não possui restrições de acesso ás URL's. Caso não exista, é necessário a inclusão da chaves abaixo no bloco do environment no arquivo Appserver.ini. *Caso o cliente utilize broker, deverá ser incluído em todos os .ini abaixo deles. Clientes cloud validar essa configuração. Exemplo: Bloco de código language text title Appserver.ini fw-tf-[GENERAL] app_environment=environment [environment] fw-tf-registry-endpoint=https://endpoint-registry.totvs.app/api/v1/services Realize o acesso no ambiente Protheus, em seguida preencher no campo "Programa Inicial" igual a GRRWIZARD. Para o campo "Ambiente no Servidor",  selecione o ambiente deseja realizar a instalação. Clique em "OK" Selecione oambiente que deseja configurar. Dica title Produção e SandBox Para ambientes de testes e homologação, disponibilizamos o ambiente de SandBox, onde é possível gerar link de pagamento e transações fictícias junto ao provedor de pagamentos. Em seguida clique em Confirmar. Assistente de configuração está pronto para ser iniciado, clique em "Avançar". Entre com o usuário e senha do administrador Protheus e selecione as empresas que serão integradas ao GRR. Em seguida clique em "Avancar". Após a verificação dos dados de entrada, selecione o botão "Avançar". Nesta etapa, é necessário selecionar o provedor / intermediador de pagamento que será utilizado pela plataforma. Abaixo serão apresentados os códigos do cadastro, que estarão vinculados ás movimentações financeiras geradas pela plataforma no ERP. Insira o Client ID * e Client Secret *, em seguida clique em "Avançar".  * As informações de  Client ID e Client Secret são enviadas automaticamente no e-mail do administrador do ambiente, assim que o ambiente é provisionado. Após a finalização do Processo de Ativação da Integração, selecione o botão "Concluir". Quando concluído a integração o sistema irá finalizar o processo. Pronto! O Wizard foi executado com sucesso. Para que a plataforma possa notificar e disponibilizar o link de pagamento, é necessário que seja feita a configuração do provedor que irá intermediar esta transação. Segue abaixo o passo a passo da configuração para os provedores disponíveis: Card id 9 label Cadastros / Parâmetros Protheus Cadastro de Menu Gestão de Receita Recorrente Planos - GRRA010 Planos x Itens - GRRA020 Serviços de integração / sincronismo de dados Empresa (GRRI010) Produto (GRRI020) Planos e Itens (GRRI030) Cliente (GRRI040) Subscrição (GRRI050)  Faturas Pagas (GRRI060) Recorrência (GRRI080) Conciliação Bancária (GRRI070) Cadastro de condição de pagamento É necessário o cadastro da forma de pagamento RECORRENTE, que indicará que a fatura será direcionada para intermediação e cobrança através da plataforma. Para isso, é necessário marcar a opção "recorrente" no cadastro da condição de pagamento. Nela, você também pode definir como será o processo de geração de Nota Fiscal: 1 - Emite NF após o pagamento (B2C) Esta opção é utilizada quando a liberação do pedido de venda para faturamento depende da confirmação do pagamento do cliente. 2 - Emite NF no vencimento (B2B) Esta opção é utilizada quando a liberação do pedido de venda para faturamento não depende da confirmação de pagamento, podendo ocorrer paralelamente ou após a geração da Nota Fiscal. Image Removed Cadastro de produto É necessário indicar os produtos que farão partede um plano recorrente da plataforma GRR, através da rotina de atualização de produtos. Image Removed Parâmetros MV_GRRACTI = .T. - Valida se a integracao do GRR esta Ativa.  MV_GRRICST = .F. - Verifica se pode customizar os valores e quantidades dos itens dos Planos GRR (Alterar para .T. quando é necessário realizar medição) MV_GRRNFSE = UNI - Indica a serie para geracao das notas fiscais atreladas ao produto GRR. Por padrao utilizamos UNI.  MV_GRRTPRO = .T. - Gera titulos provisiorio a pagar / receber para a adquirente.  Card id 75 label Intermediador de pagamento Deck of Cards id Parametrização dos adquirentes Card label Maxi Pago Card default true label REDE (Maxi Pago) Procedimento abaixo é destinado a realização do cadastro do adquirente Maxi Pago Primeiramente, crie uma conta Maxi Pago e colete as informações necessárias, como nome da empresa, MerchantAccountName / Loja e Api-Key / Chave para a serem adicionados na tela de Configurações da Plataforma GRR. Tela com informações fictícias, meramente ilustrativa. Image Removed Acesse a plataforma do GRR, em seguida selecione a opção "Configurações". Selecione a organização que será associada a conta de credenciamento MaxiPago e clique em Configurar. Image Removed Realize o preenchimento dos campos informando os dados das credenciais do cadastro na MaxiPago. Image Removed Resultado final igual a "Ativo". Image Removed Informações title Documentação Maxi Pago https://www.userede.com.br/n/gateway-de-pagamento-rede Card id 45 label Protheus Procedimento abaixo é destinado a realização do cadastro da comunicação bancária do próprio ERP para intermediação do pagamento. Primeiramente, certifique-se que o ERP possui toda a configuração bancária cadastrada, para geração de borderô e documento de cobrança (boleto). Acesse a plataforma do GRR, em seguida selecione a opção "Configurações". Selecione a organização que será associada ao Protheus e clique em Configurar. Image Removed Resultado final igual a "Ativo".
Card
label Adyen
Card
label Adyen
Configurador / Agendamentos Configurar o agendamento e execução do serviço GRRJobCommand com a frequência desejada. Certifique-se de que todas as filiais de recorrência estão associadas no agendamento. Image Added Configurador / Cadastro / Menus Será apresentado a tela de "Menus" com algumas opções selecionadas. Image Added No canto inferior esquerdo selecione a caixa "Todos os Menus", em seguida marque somente o menu que deseja realizar a configuração, neste exemplo iremos utilizar o menu "Faturamento". Image Added No quadrante "Opções" selecione a pasta principal em seguida clique em "Adicionar >>". Image Added No quadrante "Novo Menu" selecione o menu que deseja criar a configuração do GRR, clique em "Atualizações". Na coluna, selecione a opção "Novo Grupo" Image Added Adicione a Descrição "Gestão de Receita Recorrente", clique em OK Image Added Pronto a criação do Menu foi finalizada, refaça o procedimento caso seja necessário. Agora vamos Cadastrar os Itens, localize e selecione o menu recem criado "Gestão de Receita Recorrente" em seguida clique na opção "Novo Item". Image Added Iremos preencher os campos: Desc. Português, Espanhol e Inglês. Programa conforme informado na tabela abaixo; Módulo: Faturamento (esse módulo foi para exemplo); Tipo: Função Protheus Em seguida salve o registro. Image Added Grupo: Gestão de Receita Recorrente Novo Item: Planos x Itens - GRRA020 Image Added * Não é uma etapa obrigatória, porém através desta interface, é possível visualizar os planos disponíveis, bem como sua composição. Clique em "Gerar" Image Added Coloque o mesmo nome da pasta principal, nesse exemplo será o SIGAFAT, adicione conforme o módulo que estiver cadastrando, me seguida clique me "Gerar". Image Added Confirme a gravação "Sim". Image Added Confirme a substituição "Sim". Image Added Aguarde a Geração do Menu. Image Added Pronto ! Configuração finalizada. E agora aonde vou acessar essa configuração ? Vá até o modulo onde foi realizado a configuração (Nesse exemplo usamos o "SIGAFAT") Localize o menu "Atualizações" Image Added Desça na barra de rolagem até localizar o Menu Gestão de Receita Recorrente. Image Added Cadastro de condição de pagamento É necessário o cadastro da forma de pagamento RECORRENTE (Tipo 1, Cond.Pagto 1) que indicará que a fatura será direcionada para intermediação e cobrança através da plataforma. Para isso, é necessário marcar a opção "recorrente" no cadastro da condição de pagamento. Nela, você também pode definir como será o processo de geração de Nota Fiscal: 1 - Emite NF após o pagamento (B2C) Esta opção é utilizada quando a liberação do pedido de venda para faturamento depende da confirmação do pagamento do cliente. 2 - Emite NF no vencimento (B2B) Esta opção é utilizada quando a liberação do pedido de venda para faturamento não depende da confirmação de pagamento, podendo ocorrer paralelamente ou após a geração da Nota Fiscal. Image Added Cadastro de produto / serviço É necessário indicar os produtos que farão partede um plano recorrente da plataforma GRR, através da rotina de atualização de produtos. Image Added Motivo de Baixa É necessário cadastrar o motivo de baixa do título que será utilizado para baixar o título originalmente gerado ao cliente. Image Added Parâmetros MV_GRRACTI = T - Valida se a integração do GRR está Ativa. MV_GRRBCOC = 1 - Indica a medida que controla o processo de conciliação das faturas da plataforma. Onde: 1=dias, 2=horas e 3=minutos. Trabalha junto com o MV_GRRBCOV.  MV_GRRBCOV = 1 - Indica o intervalo (tempo) entre as execuções do  processo de conciliação das faturas da plataforma.  MV_GRRBPAY = - Banco utilizado para gerar contas a pagar para o  parceiro comercial.  MV_GRRCPAY =   - Cliente utilizado para gerar o contas a pagar para o parceiro comercial.   MV_GRRDVEN = 28 - Número de dias para recebimento do título contra a administradora financeira tendo como base o vencimento do título original.  MV_GRRFPAY =   Fornecedor utilizado para gerar contas a pagar para o adquirente.    MV_GRRGNOC = 1 - Indica a medida que controla o processo de recorrência das faturas da plataforma. Onde: 1=dias, 2=horas e 3=minutos. Trabalha junto com o MV_GRRGNOV.  MV_GRRGNOV = 1 - Indica o intervalo (tempo) entre as execuções do  processo de recorrência das faturas da plataforma. Este parâmetro trabalha junto com o MV_GRRGNOC.    MV_GRRICST = .F. - Verifica se pode customizar os valores e quantidades dos itens dos Planos GRR  MV_GRRNFSE = UNI - Indica a série para geração das notas fiscais atreladas ao produto GRR. Por padrão utilizamos UNI.  MV_GRRPPAY =   Fornecedor utilizado para gerar contas a pagar para o parceiro comercial.      MV_GRRPTXA = 1.99 - Taxa de transação da administradora financeira.    MV_GRRSBPC = 3 Indica a medida que controla o processo das movimentações de títulos no Protheus. Onde: 1=dias, 2=horas e 3=minutos. Trabalha junto com o MV_GRRSBPV.  MV_GRRSBPV = 5 Indica o intervalo (tempo) entre as execuções de  sincronismo das movimentações de títulos no Protheus. Trabalha junto com o MV_GRRSBPC.   MV_GRRSNCC = D - Situação utilizada para gerar contas a pagar para o parceiro comercial.       MV_GRRSSOC = 3 - Indica a medida que controla o sincronismo de liberação de pedidos pagos. Onde: 1=dias, 2=horas e 3=minutos. Trabalha em conjunto com o MV_GRRSSOV.    MV_GRRSSOV = 5 - Indica o intervalo (tempo) entre as execuções de liberação dos pedidos pagos na plataforma. Este parâmetro trabalha junto com o MV_GRRSSOC.  MV_GRRSYNC = 7 - Indica o intervalo em dias em que a sincronização de cadastros entre o Protheus e a plataforma GRR  será executada.  MV_GRRTPRO = .T. - Gera titulos provisórios a pagar / receber para a adquirente.     MV_GRRTXPG = .T. - Define se gera um contas a pagar contra a administradora financeira com a taxa da transação. Por padrão taxa será debitada do valor original do título MV_GRRBPAY = RED|REDE |REDE - Banco utilizado para gerar contas a pagar MV_GRRCPAY = REDE  |01 - Cliente utilizado para gerar contas a pagar       MV_GRRFPAY = REDE  |01 - Fornecedor utilizado para gerar contas a pagar   MV_GRRBPAY = RED|REDE |REDE - Banco utilizado para gerar contas a pagar    MV_GRRCPAY = REDE  |01 - Cliente utilizado para gerar contas a pagar   MV_GRRFPAY = REDE  |01 - Fornecedor utilizado para gerar contas a pagar Serviços de sincronismo de dados (GRRJOBCOMMAND) Empresa (GRRI010) Produto (GRRI020) Planos e Itens (GRRI030) Cliente (GRRI040) Subscrição (GRRI050)  Faturas Pagas (GRRI060) Recorrência (GRRI080) Conciliação Bancária (GRRI070) Tabelas utilizadas Tabela Descrição HRD Planos de Recorrência do GRR   HRE Plano x Itens Recorrentes      HRF Controle de mensagens do GRR   HRG Produto Recorrente             HRH Assinatura GRR                 HRI Ordem de Pagamento GRR         Card label Rotinas de Protheus GRR Segue a lista de Rotinas que são utilizadas dentro do Protheus para a Integração com a Plataforma. Essas rotinas são executadas via Job, porém caso necessário poderam ser incluídas via Menu para sua execução. Rotina  Descrição GRRI020 Irá sincronizar os produtos com a plataforma.   GRRI030 Irá sincronizar com os planos e itens criados na plataforma. GRRI060 Irá processar os itens a que foram pagos na plataforma. GRRI070A Processará os registros de provisionamente e recebimento da plataforma ( Conciliação )             GRRI080 Função que controla a criação dos pedidos de venda de acordo com as faturas geradas  pela plataforma                 GRRI090 Função que cria as pastas e envia para plataforma os Boletos Protheus.      GRRI100 Envio dos titulos pagos no Protheus para a plataforma FwTotvsLinkJob Rotina do Frame que faz o processamente de mensagens vindas via SmartLink

Para solicitar o acesso e configuração do JobScheduler, você pode seguir os seguintes passos:

1. Entre em contato com o suporte técnico da Totvs e solicite a ativação do JobScheduler no seu ambiente. Eles podem fornecer informações adicionais sobre como configurar e usar o JobScheduler.
2. Após a ativação do JobScheduler, você precisará criar e configurar as tarefas ou jobs que deseja executar. Para isso, é recomendável consultar a documentação do JobScheduler para obter orientação sobre como criar e configurar tarefas.
3. Certifique-se de que as configurações do JobScheduler estejam corretas antes de iniciar a execução dos jobs. Isso inclui verificar as configurações de agendamento, o tempo de execução estimado e as configurações de notificação.
4. Quando as tarefas estiverem configuradas corretamente, você pode iniciar a execução dos jobs por meio do JobScheduler. É importante monitorar os logs de execução para garantir que os jobs estejam sendo executados corretamente e solucionar quaisquer problemas que possam surgir.
5. Em resumo, para solicitar o acesso e configuração do JobScheduler na plataforma Totvs, você precisará entrar em contato com o suporte técnico da Totvs e seguir as orientações fornecidas para criar e configurar tarefas ou jobs. Certifique-se de verificar as configurações antes de iniciar a execução dos jobs e monitorar os logs de execução para garantir que tudo esteja funcionando corretamente

Tela de configuração do administrador do RAC

Será disponibilizado o link de acesso para o cadastro de usuário e parametrização dos jobs de trabalho. Nesse passo iremos utilizar o tenantid reservado na documentação Ambiente GRR

Formatação do tenantid: 

De: c63cf3fc969f4bc19c57cf4255f2fd6g

Para: c63cf3fc-969f-4bc1-9c57-cf4255f2fd6g (separando por "-")

Exemplo do link: https://tenant-"informar o TenantId".rac.staging.totvs.app/ 

Cadastro de Usuários: Realize o cadastro acionando o botão "+Incluir".

Image Removed

Cadastro de Perfis:  Nessa tela o administrador deverá selecionar o tipo de Scheduler e suas funcionalidades.

Image Removed

Tela de Agendamento/Monitoramento dos Jobs associados a plataforma GRR.

Nesse passo iremos utilizar o tenantid reservado na documentação Ambiente GRR

Formatação do tenantid: 

De: c63cf3fc969f4bc19c57cf4255f2fd6g

Para: c63cf3fc-969f-4bc1-9c57-cf4255f2fd6g (separando por "-")

Exemplo do link: https://tenant-"informar o TenantId".scheduler.staging.totvs.app/

Ao realizar a autenticação e validação do usuário no JobScheduler o sistema irá apresentar a pagina inicial contendo 02 (dois) Menus:

Image Removed

Monitoramento:

A tela de monitoramento do JobScheduler é uma funcionalidade que permite aos administrador monitorar o status de tarefas ou jobs que foram programados usando o JobScheduler. Essa tela é geralmente integrada ao aplicativo em desenvolvimento e é acessada pelo desenvolvedor para visualizar informações importantes sobre as tarefas em execução.

A tela de monitoramento do JobScheduler exibe informações úteis sobre as tarefas em execução, como a hora de início e término, o status atual da tarefa, o tempo restante até a próxima execução agendada e outras informações relevantes. O administrador pode usar essas informações para monitorar o desempenho do aplicativo e detectar problemas que possam surgir durante a execução de tarefas em segundo plano.

Além disso, a tela de monitoramento do JobScheduler permite que o administrador visualize estatísticas importantes, como o número total de tarefas agendadas e executadas, a taxa de sucesso das tarefas e outras informações relevantes. Isso pode ajudar o desenvolvedor a identificar problemas com o desempenho do aplicativo e a ajustar o agendamento das tarefas para melhorar a eficiência do aplicativo.

Em resumo, a tela de monitoramento do JobScheduler é uma ferramenta essencial para os administrador que desejam monitorar e otimizar o desempenho do aplicativo ao usar o JobScheduler.

Image Removed

Agendamento: 

A tela de agendamento do JobScheduler é uma funcionalidade que permite aos administradores programar tarefas ou jobs para serem executados em momentos específicos ou em determinadas condições.

O JobScheduler é uma API disponível que gerencia a execução de tarefas em segundo plano, permitindo que aplicativos executem tarefas sem afetar a experiência do usuário ou drenar a bateria do dispositivo.

A tela de agendamento do JobScheduler permite que o administrador defina a hora e a frequência de execução de uma tarefa, bem como as condições para que ela seja executada, como a disponibilidade de rede ou a carga da bateria. 

A tela de agendamento do JobScheduler pode ser usada para uma variedade de finalidades, como enviar notificações, sincronizar dados, baixar atualizações e realizar outras tarefas em segundo plano. É uma ferramenta útil para garantir que as tarefas sejam executadas em momentos apropriados, otimizando a eficiência do aplicativo e melhorando a experiência do usuário

Image Removed