Page tree
Skip to end of metadata
Go to start of metadata


ÍNDICE

  1. Objetivo
  2. Visão Geral
  3. Exemplo de Utilização
    1. Parametrização
    2. Schedule\Menu
    3. Detalhes do PONAPI01
  4. Tela de Cadastro de Schedule
  5. Tela de Cadastro de Menu
  6. Mensagens de Integração
  7. Tabelas utilizadas
  8. Rotinas envolvidas
  9. Anexos


01. OBJETIVO

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.


IMPORTANTE

ESTE DOCUMENTO SOMENTE TERÁ UTILIDADE PARA CLIENTES QUE JÁ UTILIZAM A PLATAFORMA CAROL, CASO CONTRÁRIO NÃO SERÁ POSSÍVEL A REALIZAÇÃO DESTA CONFIGURAÇÃO.


02. VISÃO GERAL

A configuração da integração entre a Carol e Protheus se baseia na configuração de um Schedule que será executado em intervalos previamente definidos, acionando as API's da Carol ou a rotina cadastrada em Menu:


Informação Importante

O CAMPO PISCODE NA PLATAFORMA CAROL É OBRIGATÓRIO PARA A INTEGRAÇÃO CORRETA COM O PROTHEUS, POIS SE TRATA DE UMA INFORMAÇÃO CHAVE PARA O SISTEMA.


03. EXEMPLO DE UTILIZAÇÃO

O cliente utiliza a Carol para as marcações de ponto dentro da empresa, esta empresa possui diversos dispositivos espalhados pela organização.

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 próximos tópicos detalharemos melhor os passos a seguir.


a. Parametrização

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

ParâmetroDescrição do ParâmetroTipoExemplo de utilização
MV_APICLO0Clock in da Carol - Utiliza integração com Carol Clock in?LógicoExemplo: .T.
MV_APICLO1CLockin da Carol - Endereço de Acesso ao EndPointCaractere

https://domínioCliente.carol.ai

MV_APICLO2Clockin da Carol - Patch de Acesso ao EndPoint.Caractereapi/v2/oauth2/token
MV_APICLO3Clockin da Carol - ID de Conexão de Acesso.Caractere0a0829171432c9bb26460c31b78f1
MV_APICLO4Clockin da Carol - Username de Acesso ao EndPoint.Caractereusername@totvs.com.br
MV_APICLO5Clockin da Carol - Password de Acesso ao EndPoint.Caracteresenha1
MV_APICLO6Clockin da Carol - Domain Name de Acesso EndPoint.CaracteredomínioCliente
MV_APICLO7Path do EndPoint DeviceList -ClockIn Carol.Caractereapi/v2/queries/named/deviceList
MV_APICLO8Path EndPoint clockinrecordsList - Clockin Carol.Caractereapi/v2/queries/named/clockinrecordsList

Informativo

A criação destes parâmetros estará disponível apenas na 12.1.27 e caso o cliente possua a plataforma Carol e versão inferior a citada e deseja integrar com o módulo SIGAPON no Protheus, deverá criar manualmente os parâmetros. 


Após preencher a parametrização correta nos parâmetros citados acima, se faz necessário realizar o cadastro de Schedule ou no cadastro de menus do Protheus dentro do módulo SIGACFG.

b. Schedule\Menu

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 ).
Preenchimento do Cadastro da Rotina MENU.
  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 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: 

c. Detalhes do PONAPI01 

Desenvolvido o processo conforme estudo realizado. Este processo buscará todas as marcações de todos os períodos de todos os dispositivos conforme os parâmetros existentes, sendo eles:

Parâmetro

Observação

Obrigatório

Tipo

Exemplo

lWorkInforma se a rotina está sendo executada via processo em segundo plano.NãoLógico.F.
dInicioData de inicio para buscar as marcações de pontoNãoDataSTOD("20000101")
dFinalData Final para buscar as marcações de pontoNãoDatadDatabase
cCoDispCódigo específico do dispositivo para buscar as marcações.NãoString

38b0dc89a20aaf49

nCodNSRCódigo do NSR a ser utilizado para buscar as marcações.NãoInteiro00

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

IMPORTANTE!

Devido ao tamanho da string trafegada entre os sistemas, pode haver estouro de string caso os parâmetros citados a seguir não estejam configurados no appserver.ini, pare o Server e coloque a propriedade TOPMemoMega=1 ("Veja Mais sobre TopMemoMega) e a propriedade MaxStringSize ( Veja Mais Sobre MaxStringSize e o valor que deve colocar no parâmetro)

04. TELA DE CADASTRO DE SCHEDULE  

Cadastro de Rotina

Imagem 1

Preenchimento da periodicidade dos acionamentos:

Imagem 2

Interface de Agents.

Gerenciamento da fila e execução dos agents.

Imagem 4


05. TELA DE CADASTRO DE MENU

Tela de listagem de menus.

Imagem 1

Tela de configuração do menu escolhido.

imagem 3

Imagem 4

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 da Carol.
  • Será apresentado 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 da Carol.
    • Verifique o parâmetro MV_APICLO2 pois ele é responsável pelo cadastro do path da api Token para a integração de Clockin da Carol.
    • Verifique o parâmetro MV_APICLO3 pois ele é responsável pelo cadastro do Id Conector para a integração de Clockin da Carol.
    • Verifique o parâmetro MV_APICLO4 pois ele é responsável pelo cadastro do User Name para a integração de Clockin da Carol.
    • Verifique o parâmetro MV_APICLO5 pois ele é responsável pelo cadastro do Password para a integração de Clockin da Carol.
    • Verifique o parâmetro MV_APICLO6 pois ele é responsável pelo cadastro do Domain Name para a integração de Clockin da Carol.
    • Verifique o parâmetro MV_APICLO7 pois ele é responsável pelo cadastro do path da api DeviceList para a integração de Clockin da Carol.
    • Verifique o parâmetro MV_APICLO8 pois ele é responsável pelo cadastro do path da api clockinrecordsList para a integração de Clockin da Carol.
    • Não foi possível acessar a API Clockin 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 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.

07. TABELAS UTILIZADAS 

  • SP0 -  Pré-Leitura\Relógio de Ponto  
  • RFE -  Relógio de Ponto  
  • SP8 - 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  e a partir deste momento será processado pelo sistema onde será gerado os registros na SP8.

08. Rotinas Envolvidas

  • GPEA010 : 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 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 de acesso ao DeviceList
    1. https://tdn.totvs.com/x/frC2Hg