CONTEÚDO

01. OBJETIVO

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


  • Este documento, assim como esta funcionalidade, somente terá utilidade para cliente que utilizam a Plataforma Carol, caso contrário não será possível a realização destas configurações.



02. VISÃO GERAL

A configuração da integração entre o produto Datasul e Carol se baseia na parametrização do FP0540 e na execução do programa PE9696 que aciona as API's para importação das batidas.

Posteriormente, é necessária a execução do programa PE7100 para realizar as importações das batidas no sistema Datasul, que poderão ser visualizadas junto das funções PE3700 (Batidas Ponto) ou PE3500 (Erros Importação Batidas).


  • Para o perfeito funcionamento do aplicativo 2C é necessário que o broker SQL esteja habilitado para a comunicação entre as Plataformas. Se ainda não estiver é necessário solicitar ao seu Administrador de Banco de Dados para conceder essa permissão. Isso se faz necessário porque na configuração do aplicativo 2C (via Web) a informação da porta que está configurado o banco DTHRPYC (banco que está definida a tabela utilizada no 2C) deverá ser inserida na parametrização do aplicativo. Se o broker não estiver habilitado o 2C não poderá ser configurado.


  • O campo PIS CODE e REP CODE na Plataforma Carol é obrigatório para a integração correta com o Datasul pois se trata de uma informação chave para o sistema.





03. PRÉ-REQUISITOS


04. PARAMETRIZAÇÃO DATASUL

a. Descentralização RH

A página de parâmetros da função FP0540 - Descentralização RH, permite a configuração das informações de integração com o Clock In/Carol.

Essas informações são necessárias para permitir a comunicação entre Datasul e Carol, sendo fornecidas na contratação e criação do ambiente na Carol.

Após o preenchimento dos dados é possível testar a comunicação com a Carol Clock In clicando no botão .


Para mais informações sobre os campos Nome Organização e Nome Ambiente verifique o documento https://docs.carol.ai/docs

Para mais informações sobre os campos Connector Id e Connector Token verifique o documento https://centraldeatendimento.totvs.com/hc/pt-br/articles/4408796105495-RH-Clock-In-by-Carol-Connector-Token



(informação) A partir desta configuração, é ativada a função FP9696 permitindo que seja possível selecionar e definir quais funcionários tem perfil de coordenador.


b. Coordenadores Clock In/Carol

A função FP9696 - Coordenadores Clock In/Carol permite a identificação dos funcionários com papel de coordenador que utilizarão o aplicativo Clock In para realizar as marcações de seus funcionários.

Basta relacionar os funcionários (coordenadores) para que os dados destes sejam enviados para o ambiente da Carol.

Através do botão "Formar" será possível relacionar os coordenadores.

Será apresentada a seguinte tela:

Na coluna/browser da esquerda serão apresentados os funcionários da empresa corrente, e na coluna/browser da direita os coordenadores que já foram relacionados.

Caso o usuário queira relacionar funcionários de outras empresas, será necessário clicar no botão "Filtrar". Através desta tela é possível filtrar, além da empresa, por estabelecimento e matrícula. Caso contrário basta deixar os campos com o valor "0"(zero) para que sejam apresentados todos os estabelecimentos e matrículas da empresa informada:


Outra funcionalidade disponível nesta tela é a busca de funcionários pelo nome.

Basta informar no campo "Nome" e clicar no botão check verde.

Para os coordenadores que já estão relacionados, também é possível filtrar os funcionários que estão ativos, desligados ou ambos. 

Para salvar os registros, utilizar o botão central para movimentar da coluna esquerda para direita, em seguida clicar no botão "OK".



(informação) A inclusão/exclusão de coordenadores nesta função efetua o envio dos dados destes para atualização do ambiente na Carol.


c. Manutenção Relógio Ponto

Para implementação do cadastro de relógio ponto, deve-se definir um código e sua respectiva descrição, informando o local onde o mesmo está relacionado e o tipo de batida que o mesmo aceita. Para maiores esclarecimentos acessar Manutenção do Relógio Ponto - PE0620.




05. IMPORTAÇÃO DAS MARCAÇÕES PONTO


Para realizar a importação das marcações é necessário utilizar o programa PE9696 -  Importação de Marcações Clock In/Carol que, através da conexão com o ambiente da Carol, fará a importação das marcações de ponto a partir do último NSR lido por dispositivo ativo.

Na aba Parâmetros é possível escolher entre duas opções de Baixa de Marcações:



a. Log de Execução

Ao finalizar a execução, o PE9696 gera um log de execução das etapas do processo de baixa das marcações da Carol Clock-in para o Totvs Datasul, reportando os status e erros, caso ocorram. 



O Log de execução é composto por 4 colunas:

Código: Organiza e identifica as mensagens.

Tipo: Identifica a informação como Erro ou Status do processo feito pelo programa.

Descrição:  Identifica de forma resumida à que se refere a mensagem.

Detalhe/Observação: Traz mais detalhes sobre a mensagem conforme o ponto do processamento.


A tabela abaixo mostra todas as mensagens, e sua correlação de uso, situações de erro ou reporte.


CódigoTipoDescriçãoDetalhe/ObservaçãoOrientações
0ErroErro ao conectar no endereço informadoErro no endereço informado, por favor, validar o endereço cadastrado no FP0540Valida se foi possível se comunicar com o Clock-in, este erro pode ser causado por digitação errada do endereço no FP0540, ou por problemas de rede/comunicação entre Totvs x Clock-in
1ErroFalha de ConexãoFavor verificar a parametrização de conexão com a Carol Clock-in no programa FP0540Valida se foi possível se comunicar com o Clock-In, este erro é apresentado quando um dos campo do FP0540 não estão preenchido como: Nome da Organização, Nome do Ambiente, Connector Id, Connector Token
2StatusConexão Carol Clock Inurl: mostraenderecoconexao.carol.aiMostra a Url de conexão apenas para informação
3ErroFalha na requisição dos dispositivosClock-in Erro requisitar dispositivo: ... Falha no momento em que o programa tenta acessar os dispositivos cadastrados na Carol Clock-in que contem as marcações. para baixar as informações
4ErroDispositivo não localizadoVerificar no programa PE0620 se existe relógio com Número REP informado no clockin: ..Falha no momento em que o programa tenta acessar o dispositivo cadastrados na Carol Clock-in conforme cadastros de relógios no PE0620 
5ErroFalha ao registrar marcaçõesFalha ao registrar marcações nas tabelas do Totvs:Falha ao tentar gravar as marcações baixadas na Carol Clock-in
6ErroDispositivo com validade vencidaVerificar no programa PE0620 a data de validade do relógio, pois não contempla a data da marcação  REP: ...Falha ao tentar gravar as marcações baixadas na Carol Clock-in por erro de dados do cadastro do Relógio no PE0620
7ErroFalha na requisição de marcaçõesVerifique na Carol Clock-in o conteúdo e o formato dos campos: nsrCode, eventdatestr e piscodeFalha ao tentar requisição para começar a baixar informações de marcações
8StatusTermino de ProcessoTotal de dispositivos lidos: 5 Términos de Processo, apenas informativo
8.1StatusTermino de ProcessoTermino processo requisição de marcaçõesTérminos de Processo requisição de marcações das tabelas do Clock-in, onde os dados são preparados para serem gravados no Totvs Datasul, apenas informativo
9StatusBuscando MarcaçõesInicio da Busca de Marcação Código REP 123132 X NSR 1313Início de Processo 
10ErroDispositivo com código REP duplicadoVerificar na Carol Clock-in o cadastro do dispositivo, DevicecodeErro reportado quando mais de um dispositivo estiver cadastrado com mesmo número de Rep na plataforma da Carol Clock-in
11ErroDispositivo sem código REP informadoVerificar na Carol Clock-in o cadastro do dispositivo: Devicecode: ... REP: ...Falha no cadastro de dispositivos na Carol Clock-in, pois o dispositivo está parametrizado para integrar com RH mas não possui o coderep informado
12StatusDispositivo validado com sucessoDevicecode: ... REP: ...Término do processo de validação do dispositivo
500StatusErro Interno do ServidorErro Interno do Servidor ao tentar conectar com dispositivosErro de comunicação com o servidor, o servidor foi encontrado mais a comunicação não é concluída


b. Relatório Excel com as Marcações Importadas

Ao final da execução do PE9696 será gerado um arquivo com extensão '.csv' com todas as marcações baixadas e, que ainda não foram processadas pelo PE7100.

Ex:

c. Arquivo de Log Detalhado

Na aba Parâmetros é possível indicar que se deseja gerar o arquivo de log detalhado.  Quando selecionado este campo, é obrigatório que seja informado o diretório para a geração deste arquivo.



O nome do arquivo de log detalhado é composto pelas seguintes informações:

    • Texto Fixo: ‘PE9696_log_detalhado’ +
    • Data Geração +
    • Hora geração +
    • Extensão ‘.txt’


Ex: PE9696_log_detalhado_220322_094547.txt 


No arquivo gerado constarão informações detalhadas sobre os processos executados durante a baixa de marcações da Carol/Clockin para o Datasul, possibilitando a identificação e avaliação de possíveis problemas que possam ter ocorrido. 

Ex:



A tabela abaixo demonstra a relação das mensagens exibidas no arquivo de log detalhado.


Código MensagemDetalhamento
log 9999Indica a quantidade de dispositivos que foram recebidos pela requisição realizada.
log 9998

Indica o número da requisição realizada para a busca dos dispositivos.

log 9997

Indica o status da requisição da busca de dispositivos.
log 9996Indica a data e a hora do início da validação dos dispositivos.
log 9995Indica a data e a hora de término da validação dos dispositivos.
log 9994Indica que o dispositivo não será considerado para a baixa das marcações por não ter código REP informado.
log 9993Indica a quantidade de dispositivos recebidos da Carol/Clockin que serão considerados para a baixa das marcações.

log 9992

Indica a quantidade de dispositivos recebidos da Carol/Clockin que estão sem o código REP informado.
log 9991Indica a quantidade de dispositivos recebidos da Carol/Clockin que estão com o código REP duplicado.
log 9990Indica a quantidade de dispositivos recebidos da Carol/Clockin que não foram localizados no programa PE0620 através do seu código REP.
log 9989Indica que o dispositivo será considerado para a baixa das marcações pois foi validado com sucesso.
log 9988Indica que a validação dos dispositivos foi interrompida porque algum dispositivo recebido da Carol/Clockin possui alguma informação incorreta.
log 9987Indica a data e a hora do início da execução do programa PE9696.
log 9986Indica a data e a hora do término da execução do programa PE9696.
log 9985Indica que não há dispositivos válidos para a baixa de marcações.
log 9984Indica o status da requisição da baixa das marcações.
log 9983Indica o número da requisição realizada para a baixa das marcações.
log 9982Indica a quantidade de marcações que foram recebidas pela requisição realizada.
log 9981Indica que a marcação já foi integrada anteriormente.
log 9980Indica que a validade do REP informada no programa PE0620 não contempla a data da marcação.
log 9979Indica que a marcação foi integrada com sucesso.
log 9978Indica a data e a hora do término da baixa das marcações do dispositivo/REP.
log 9977Indica a data e a hora do início da baixa das marcações do dispositivo/REP.

log 9976

Indica que a baixa de marcações foi interrompida devido à alguma marcação estar com dados incorretos (ex: PIS, data, hora não informado).

Somente quando a baixa de marcações parametrizada for “Um Dispositivo por Vez”.
log 9975Indica a quantidade de marcações que foram integradas com sucesso.
log 9974

Indica a quantidade de marcações não processadas.

Ex: a requisição retornou 10 marcações, mas a quarta marcações está sem o PIS informado. Devido a isto, as marcações restantes não são processadas.  
log 9973Indica a quantidade de marcações que já estavam integradas.
log 9972Indica a data e a hora do início da busca dos dispositivos.

log 9971

Indica a data e a hora do término da busca dos dispositivos.
log 9970

Indica que a baixa de marcações foi interrompida devido à alguma marcação estar com dados incorretos (ex: PIS, data, hora não informado).

Somente quando a baixa de marcações parametrizada for “Por Lote de Dispositivos”.
log 9969Indica a data e a hora do início da baixa das marcações por lote de dispositivos.
log 9968Indica a data e a hora do término da baixa das marcações por lote de dispositivos.
log 9967Indica o lote em que os dispositivos serão incluídos para a requisição da baixa de marcações.
log 9966Indica os dispositivos que foram incluídos no lote indicado na mensagem ‘log 9967’.




06. CLIENTLOG

Também foram implementados alguns logs para auxiliar o atendimento na identificação de algum eventual problema na integração. Para consultar os log da integração pode-se buscar por #clockin no clientlog.

Segue uma tabela com as mensagens que podem estar no clientlog e alguns motivos da origem destas mensagens.


Mensagem

Possível Origem

verify_fields: verifique parametro de conexao

Uma ou mais informações não estão preenchidas no FP0540.

get_device_list -> v_response_code

Código de retorno da requisição dos dispositivos, caso diferente de 200, está com algum erro de comunicação.

get_device_list -> v_response_statusDescrição detalhada do erro de comunicação.
get_device_list -> repcode: Este repcode: 99999 esta vindo com formato string.O dispositivo está com o formato errado, consultar a Totvs Labs para possível soluções.
get_device_list -> devicecodeNúmero do dispositivo reconhecido. Esta mensagem pode ser utilizada para verificar se realmente todos os dispositivos listados pelo cliente estão sendo importados.
get_device_list -> repcodeNúmero do repcode reconhecido. Esta mensagem pode ser utilizada para verificar se realmente todos os dispositivos listados pelo cliente estão sendo importados.
get_records_list > p-nsrCodeNúmero do nsrCode utilizado para consultar as marcações no Clockin, ou seja, o valor retornado nesta mensagem o sistema irá requisitar as marcações a partir dele.
get_records_list > p-deviceCodeNúmero do dispositivo que foi realizada a requisição das marcações.
get_records_list > v_response_codeCódigo de retorno da requisição dos dispositivos, caso diferente de 200, está com algum erro de comunicação.
get_records_list > v_response_statusDescrição detalhada do erro de comunicação.
get_records_list > Falha na requisição Servido Clockin - Verifique se informado e o formato campos: nsrCode, eventdatestr e piscode

Esta mensagem é originada quando o retorno das marcações do clockin possui alguma inconsistência de formato ou não existência dos campos, neste caso deve-se verificar com o Totvs Labs.

Caso aconteça alguma falha de comunicação com o servidor (falta de internet por exemplo) pode originar essa mensagem.

Neste caso é importante também verificar os certificados de importação.

pi_records_msa_control_marcac > before-recordAs marcações foram importadas corretamente e o próximo passo será a gravação na tabela msa_control_marcac.
pi_records_msa_control_marcac > validade dispositivoO período de validade do dispositivo está fora da marcação, deve-se verificar o programa PE0620.
pi_records_msa_control_marcac > falha ao registrar marcacoesNo processo de gravação das marcações na tabela msa_control_marcac ocorreu algum problema. Um dos motivos pode ser o formato dos campos retornados na requisição.
get_device_list > Verificar na Carol ClockIn o cadastro do dispositivo, Devicecode: devicecode Rep: repcodeErro reportado quando mais de um dispositivo estiver cadastrado com mesmo número de Rep na plataforma da Carol Clock-in



07. INTEGRANDO COM TOTVS CAROL

Para conhecer os principais serviços e saber como construir uma integração para envio e consumo de dados da Carol, acesse a página Integrando com TOTVS Carol.  

Os subtópicos podem ser acessados através da árvore da página conforme exemplo abaixo:



Essa funcionalidade foi criada pela TOTVS LABS.

Qualquer dúvida em relação a esta funcionalidade entre em contato com o atendimento da Carol [email protected].




<!-- esconder o menu --> 


<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
</style>