Pular para o conteúdo principal

Integração com o sistema Portal do Gestor

A integração entre o sistema Tributos e o Portal do Gestor tem como finalidade facilitar o compartilhamento de informações entre os sistemas, promovendo mais eficiência e segurança nos processos de gestão municipal.

Com o intuito de padronizar o uso e apoiar os usuários na configuração e operação dessa integração, elaboramos essa documentação, que reúne as principais orientações sobre a integração entre esses dois sistemas.

Primeiramente, é necessário realizar a configuração das chaves de integração, configuradas diretamente no Gerenciador de acessos, em substituição às antigas chaves de migração inseridas diretamente nos scripts.

Como configurar uma nova chave de integração?​

  1. Acesse o Gerenciador de Acessos:
    • Vá em Utilitários > Configurações > Gerenciador de Acessos.

executando

  • Clique em Integrações > +Integração.

executando

  1. Preencha o formulário com as seguintes informações:
  • Natureza da Integração: Integração através da ferramenta de scripts.
  • Sistema de Origem: Tributos.
  • Entidade de Origem: Sua entidade.
  1. Após o preenchimento, será gerado um Identificador, que deverá ser utilizado nos próximos passos.

Como configurar o Identificador no Gerenciador de Scripts?

  1. Acesse o Gerenciador de Scripts:
    • Vá em Utilitários > Configurações > Gerenciador de scripts.

executando

  • Clique em Configurando > Variáveis de Ambiente;
  • Clique em +Adicionar.

  1. Preencha as variáveis de ambiente com os dados abaixo:

    • CHAVE: INTEGRACAO_PORTAL;
    • VALOR: O Identificador gerado na rotina de integrações.

  2. Salve as alterações.

Atenção: O valor da chave deve obrigatoriamente ser INTEGRACAO_PORTAL. Qualquer outro valor resultará em erro na integração.

executando

Após configurar as variáveis corretamente, os scripts padrões de integração que utilizam o Service Layer estarão funcionando normalmente.

Caso a entidade utilize artefatos específicos, o mesmo deve ser ajustado para se enquadrar nas especificações.

Script [Tributos] Envio Portal do Gestor​

Na rotina Utilitários > Gerenciador de scripts, localize o script [Tributos] Envio Portal do Gestor e realize a execução do mesmo.

executando

Para a sua execução, basta realizar o preenchimento dos campos Créditos de IPTU, Créditos de ISS e Créditos de Alvará.

Ao realizar a execução, todos os serviços seriam enviados ao sistema Portal do Gestor.

Recomendamos agendar a execução do script uma vez ao dia, preferencialmente no final do expediente.

Script [Tributos] Envio Portal do Gestor (C/ Envios Individuais)​

Ressaltamos que este script foi disponibilizado apenas para as entidades que o solicitaram.

Primeiramente, é necessário que a entidade certifique que os seguintes scripts estejam disponíveis na sua entidade:

  • [Tributos] Envio Portal do Gestor (C/ Envios Individuais);
  • [Tributos] Portal do Gestor - Processamento Lotes.

E também certifique-se que os seguintes componentes estejam disponíveis:

  • [Tributos] Portalgestor.controle;
  • [Tributos] Portalgestor.tabela.individuais;
  • [Tributos] acrescimos;
  • [Tributos] enum.

Deve ser enviado uma carga inicial na primeira utilização do script [Tributos] Envio Portal do Gestor (C/ Envios Individuais), enviando uma vez na ordem numérica pelo tipo de serviço:

executando

A partir do serviço 19, as cargas iniciais irão levar um tempo maior, pois a quantidade de registros é muito grande comparado aos serviços anteriores. Então será necessário verificar o LOG do script até ter certeza de que não está sendo enviado mais nenhum registro naquele serviço.

Ainda, a partir do serviço 19, eles devem ser enviados de forma individual.

Após fazer a carga inicial de todos os serviços, você deve executar o script [Tributos] Portal do Gestor - Processamento Lotes, pois ele processa todos os envios feitos, e salva os ID’s na tabela auxiliar (Configurando > Tabelas > Cadastros gerais > Integração com o Portal do Gestor).

Esse script também será necessário executar diversas vezes até que não tenha mais nenhum registro para ele processar. É necessário que seja verificado no log de execução do script para verificar se já foi enviado tudo.

Após processar todos os dados, você deverá agendar a execução de ambos os scripts (Apenas após enviar as cargas iniciais de todos os serviços até o fim).

Recomendações​

[Tributos] Envio Portal do Gestor (Com Envios Individuais)

  • Configure o agendamento do script sempre com Carga Inicial = NÃO.

  • Agende a execução diária do script para o envio dos serviços 1 a 18 (pode inserir todos os serviços).

executando

  • Agende os serviços 19 a 22 separadamente, com intervalos de 15 minutos, garantindo que todos sejam executados dentro do mesmo período. Para relembrar como é realizado um agendamento, clique aqui.

[Tributos] Portal do Gestor – Processamento de Lotes

  • Agende a execução deste script a cada 15 minutos.

  • Caso o primeiro agendamento do script anterior tenha início às 08:00, recomendamos configurar este para 08:05, de modo que o processamento ocorra logo após o envio dos dados.