Histórico da Página

...

Apresentar ao usuário final, que faça uso da plataforma Carol para marcações de ponto dos colaboradores, como configurar o Protheus para habilitar a integração automática de marcações.

...

• https://domínioCliente.carol.ai/api/v2/oauth2/token  (API de Autenticação e geradora de Token, onde será realizado os demais acessos\requisições)
• https://domínioCliente.carol.ai/api/v2/queries/named/deviceList (API de Requisição de listagem de dispositivos de ponto cadastrados na Carol)
• https://domínioCliente.carol.ai/api/v2/queries/named/clockinrecordsList (Api de requisição de listagem de marcações por dispositivos na Carol)

...

O Protheus será o responsável por acionar a plataforma Carol, buscar as informações contidas em cada dispositivo e armazenar os registros dentro do módulo SIGAPON, nos . Nos próximos tópicos detalharemos melhor , os passos a seguir.serão detalhados:

a. Parametrização

Para que haja a devida integração entre os dois sistemas, se faz necessário preencher os parâmetros abaixo:

b. Cadastro do Relógio Carol

...

A rotina desenvolvida para a realização de todo o fluxo de requisição para a Carol foi nomeada de PONAPI01, esta rotina não estará disponibilizada em Menu ou pré-carregada no Schedule.

O Processo de Cadastramento será o mesmo utilizado por outras rotinas:

Preenchimento do Schedule

...

:

1. Acessar o módulo SIGACFG - Configurador;
2. Acessar o caminho do menu AMBIENTE/SCHEDULE/SCHEDULE;
3. Clicar na opção Cadastro no calendário de agendamentos, conforme imagem1 da tela no Tópico 04.;
4. O preenchimento é simples e intuitivo para o preenchimento correto do schedule (leia o item 5 abaixo, antes de confirmar o cadastro);
5. Clique o ícone cinza ao lado do botão de confirmar, pois lá se encontra as informações de periodicidade de acionamento da rotina cadastrada (Imagem 2 do Tópico 04).;
6. Após a confirmação do cadastramento, será necessário habilitar os agents (Imagem 3 do Tópico 04 ), onde você pode cadastrar manualmente ou pressionar o ícone de radar verde no canto superior direito e os agents serão incluídos automaticamente.;
7. Com os agents devidamente cadastrados, o usuário deve pressionar o ícone de pasta do lado esquerdo e ligar Task Manager e Queue Manager (São os gerenciadores da fila de acionamento dos agents) (Imagem 4 do Tópico 04 ).

...

1. Acessar o módulo SIGACFG - Configurador.;
2. Acessar o caminho do menu AMBIENTE/CADASTROS/MENU.;
3. Selecione o módulo\Menu que deseja realizar a inclusão da rotina, conforme imagem 1 do Tópico 05.;
4. Quando clicar em "OK" será aberta uma tela semelhante a imagem 2 do Tópico 05 e você deverá pressionar o primeiro botão central "Adicionar>>" e o menu inteiro será transferido para o lado direito da tela.;
5. Clique na pasta azul que desejar incluir o item da rotina e pressione o botão Novo Item conforme imagem 3 do Tópico 05, desta forma será exibida uma nova tela para inclusão da rotina conforme imagem 4.;
6. Preencha o nome que deseja que apareça no menu e digite o nome da rotina citada no inicio início deste documento PONAPI01, conforme imagem 4.;
7. Confirme o cadastro e clique no botão central de Gerar.;
8. O Sistema exibirá uma mensagem solicitando o nome do xnu que será gerado, sugerimos manter o mesmo nome do xnu padrão ex: .

d. Detalhes do PONAPI01 

Para eventual manutenção na rotina de leitura dos marcações da Carol, é possível utilizar os parâmetros abaixo afim de realizar alguns filtros específicos. Estes parâmetros não são obrigatórios. Caso não sejam informados, a rotina utilizará a sequencia sequência de marcações para realização da importação dos dados. Os parâmetros opcionais são:

...

Obs.: O parâmetro nCodNSR somente deverá ser utilizado quando for necessário realizar buscar uma marcação especificaespecífica, pois o Protheus já busca todas as marcações atuais.

...

Tela de listagem de menus.

Tela de configuração do menu escolhido.

06. Mensagens de Integração 

Para possibilitar o acompanhamento  da integração do Protheus com a Carol, será apresentado algumas mensagens em tela caso o acionamento seja manual pelo menu ou no console.log, quando a rotina for acionada via Schedule.

• Caso o código NSR enviado por parâmetro e o mesmo seja abaixo de zero:
  • Verifique o Código NSR Informado, pois o mesmo somente aceita números positivos!
• Inconsistências nas datas:
  • Verifique as Datas informadas para acesso ao Clockin Clock In da Carol.
• Será apresentado apresentada a seguinte mensagem e a mensagem retornada da plataforma Carol.
  • Não foi possível acessar a API Clockin da Carol.
• Problemas com o preenchimento dos parâmetros:
  • Verifique o parâmetro MV_APICLO1 pois ele é responsável pelo cadastro da URL de EndPoint para a integração de Clockin Clock In da Carol.
  • Verifique o parâmetro MV_APICLO2 pois ele é responsável pelo cadastro do path da api API Token para a integração de Clockin Clock In da Carol.
  • Verifique o parâmetro MV_APICLO3 pois ele é responsável pelo cadastro do Id Conector para a integração de Clockin Clock In da Carol.
  • Verifique o parâmetro MV_APICLO4 pois ele é responsável pelo cadastro do User Name para a integração de Clockin Clock In da Carol.
  • Verifique o parâmetro MV_APICLO5 pois ele é responsável pelo cadastro do Password para a integração de Clockin Clock In da Carol.
  • Verifique o parâmetro MV_APICLO6 pois ele é responsável pelo cadastro do Domain Name para a integração de Clockin Clock In da Carol.
  • Verifique o parâmetro MV_APICLO7 pois ele é responsável pelo cadastro do path da api API DeviceList para a integração de Clockin Clock In da Carol.
  • Verifique o parâmetro MV_APICLO8 pois ele é responsável pelo cadastro do path da api API clockinrecordsList para a integração de Clockin Clock In da Carol.
  • Não foi possível acessar a API Clockin Clock In da Carol. Verifique os parametros MV_APICLO0, MV_APICLO1, MV_APICLO2, MV_APICLO3, MV_APICLO4, MV_APICLO5, MV_APICLO6,MV_APICLO7, MV_APICLO8 com as informações fornecidas.
  • Não foi possível acessar a API Clockin Clock In da Carol. Verifique os parametros MV_APICLO0, MV_APICLO1, MV_APICLO2, MV_APICLO3, MV_APICLO4, MV_APICLO5, MV_APICLO6,MV_APICLO7, MV_APICLO8, MV_APICLO9 com as informações fornecidas.
  • Não foi possível acessar a API Clockin Clock In da Carol. Verifique o parametro MV_APICLO8 pois ele é responsável pelo cadastro do path da api clockinrecordsList para a integração de Clockin da Carol.
  • O parâmetro MV_APICLO9 está vazio ou não foi criado e a Carol possui uma organização configurada. Por favor crie e preencha o MV_APICLO9 com o Nome da Organização.

07. TABELAS UTILIZADAS 

• SP0 -  Pré  Pré-Leitura\Relógio de Ponto  Ponto;  
• RFE -  Relógio   Relógio de Ponto  ;  
• SP8 - Movimento  Movimento de Marcações  ;  
• MSA_CONTROL_MARCAC - Tabela criada na primeira carga de dados com a Carol, esta tabela também é utilizada no modelo de integração com o TSA  TSA e, a partir deste momento, será processado pelo sistema onde será gerado os registros na SP8.

08. Rotinas Envolvidas

• GPEA010: Cadastro  Cadastro de Funcionários;
• PONA030: Cadastro de Relógios;
• PONM010: Leitura e Apontamento.

09. Anexos

1. DRHGCH-13658 Alterar rotina PONA030 - Relógio (Detalhes para funcionamento na rotina PONA030)
   1. https://tdn.totvs.com/x/kum2Hg
2. DRHGCH-13255 - Integração Ponto X Carol - Batidas - Api API de acesso ao Token ( Detalhes sobre o funcionamento na rotina PONAPI01)
   1. https://tdn.totvs.com/x/34W2Hg
3. DRHGCH-13652 Integração Ponto X Carol - Batidas - Api API de acesso ao DeviceList
   
   1. https://tdn.totvs.com/x/frC2Hg

...