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.
|
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).
|
A função FP0540 - Consulta Descentralização RH, através da pasta Carol/Con permite a configuração das informações de integração com a Carol/Clock in.
Essas informações são necessárias para realizar a comunicação entre Datasul e Carol, sendo fornecidas na contratação e criação do ambiente na Carol.
|
A partir desta configuração, é ativada a função FP9696 - Coordenadores Clockin/Carol permitindo que seja possível selecionar e definir quais funcionários tem perfil de coordenador.
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".
A inclusão/exclusão de coordenadores nesta função efetua o envio dos dados destes para atualização do ambiente na Carol.
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 mais esclarecimentos acessar Manutenção do Relógio Ponto - PE0620.
O número do REP cadastrado no programa PE0620 deve ser o mesmo informado no campo REP no cadastro de dispositivos no Clock-in.
Sobre o cadastro de dispositivos no Clock-in ressaltamos que:
|
igual a "99999999999999999' caso não haja convenção coletiva.
Este cadastro se faz necessário para que seja possível realizar:
|
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:
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ódigo | Tipo | Descrição | Detalhe/Observação | Orientações |
0 | Erro | Erro ao conectar no endereço informado | Erro no endereço informado, por favor, validar o endereço cadastrado no FP0540 | Valida 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 |
1 | Erro | Falha de Conexão | Favor verificar a parametrização de conexão com a Carol Clock-in no programa FP0540 | Valida 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 |
2 | Status | Conexão Carol Clock-In | url: mostraenderecoconexao.carol.ai | Mostra a Url de conexão apenas para informação |
3 | Erro | Falha na requisição dos dispositivos | Clock-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 |
4 | Erro | Dispositivo não localizado | Verificar 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 |
5 | Erro | Falha ao registrar marcações | Falha ao registrar marcações nas tabelas do Totvs: | Falha ao tentar gravar as marcações baixadas na Carol Clock-in |
6 | Erro | Dispositivo com validade vencida | Verificar 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 |
7 | Erro | Falha na requisição de marcações | Verifique na Carol Clock-in o conteúdo e o formato dos campos: nsrCode, eventdatestr e piscode | Falha ao tentar requisição para começar a baixar informações de marcações |
8 | Status | Término de Processo | Total de dispositivos lidos: ... ou Termino processo requisição de marcações | Informa que o processo de leitura dos dispositivos terminou. ou Informa que o processo de leitura das marcações do Clock-in terminou. |
9 | Status | Buscando Marcações | Inicio da Busca de Marcação Código REP ... X NSR ... | Indica o início do processo da busca das marcações para o REP indicado, a partir do NSR indicado. |
10 | Erro | Dispositivo com código REP duplicado | Verificar na Carol Clock-in o cadastro do dispositivo, Devicecode | Erro reportado quando mais de um dispositivo estiver cadastrado com mesmo número de Rep na plataforma da Carol Clock-in |
11 | Erro | Dispositivo sem código REP informado | Verificar 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 |
12 | Status | Dispositivo validado com sucesso | Devicecode: ... REP: ... | Término do processo de validação do dispositivo |
13 * | Status | Local de Marcação criado com sucesso | Empresa: ... Local Marcação: .. | Indica que foi criado um local de marcação do tipo função Ponto, para ser relacionado ao relógio que será criado para o dispositivo do Clock in. |
14 * | Erro | Local de Marcação não pode ser criado | Já existem 99 locais de marcação cadastrados para empresa: ... | Indica que não foi localizado um local de marcação do tipo função Ponto e não foi possível criar um novo registro automaticamente porque já existem 99 locais de marcação criados. |
15 * | Status | Relógio criado com sucesso | Programa PE0620 → Empresa: ... Relógio: ... Devicecode: ... Número REP: ... | Indica que foi criado um relógio para o dispositivo do Clock in. |
16 * | Erro | Relógio não pode ser criado | Já existem 99.999 relógios cadastrados para empresa: ... | Indica que não foi possível criar um relógio para o dispositivo do Clock in porque já existem 99.999 relógios cadastrados para a empresa. |
17 * | Erro | Relógio não pode ser criado | Não foi possível criar o local de marcação para empresa: ... | Indica que não foi possível criar um relógio para o dispositivo do Clock in porque não foi localizado um local de marcação do tipo função Ponto e não foi possível criar um automaticamente porque já existem 99 locais de marcação criados. |
18 * | Erro | Relógio não pode ser criado | Não foi localizada empresa para o CNPJ: .. | Indica que não foi possível criar um relógio para o dispositivo do Clock in porque não localizou um estabelecimento/empresa na base de dados com o CNPJ do dispositivo do Clock in. |
500 | Status | Erro Interno do Servidor | Erro Interno do Servidor ao tentar conectar com dispositivos | Erro de comunicação com o servidor, o servidor foi encontrado mais a comunicação não é concluída |
As mensagens identificadas com * ao lado do seu código só serão apresentadas quando o campo "Cadastro Automático do Relógio" na função Manutenção Descentralização HCM - FP0540 estiver marcado. |
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.
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:
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 Mensagem | Detalhamento |
log 9999 | Indica 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 9996 | Indica a data e a hora do início da validação dos dispositivos. |
log 9995 | Indica a data e a hora de término da validação dos dispositivos. |
log 9994 | Indica que o dispositivo não será considerado para a baixa das marcações por não ter código REP informado. |
log 9993 | Indica 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 9991 | Indica a quantidade de dispositivos recebidos da Carol/Clockin que estão com o código REP duplicado. |
log 9990 | Indica a quantidade de dispositivos recebidos da Carol/Clockin que não foram localizados no programa PE0620 através do seu código REP. |
log 9989 | Indica que o dispositivo será considerado para a baixa das marcações pois foi validado com sucesso. |
log 9988 | Indica que a validação dos dispositivos foi interrompida porque algum dispositivo recebido da Carol/Clockin possui alguma informação incorreta. |
log 9987 | Indica a data e a hora do início da execução do programa PE9696. |
log 9986 | Indica a data e a hora do término da execução do programa PE9696. |
log 9985 | Indica que não há dispositivos válidos para a baixa de marcações. |
log 9984 | Indica o status da requisição da baixa das marcações. |
log 9983 | Indica o número da requisição realizada para a baixa das marcações. |
log 9982 | Indica a quantidade de marcações que foram recebidas pela requisição realizada. |
log 9981 | Indica que a marcação já foi integrada anteriormente. |
log 9980 | Indica que a validade do REP informada no programa PE0620 não contempla a data da marcação. |
log 9979 | Indica que a marcação foi integrada com sucesso. |
log 9978 | Indica a data e a hora do término da baixa das marcações do dispositivo/REP. |
log 9977 | Indica 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: CPF, data, hora não informado). Somente quando a baixa de marcações parametrizada for “Um Dispositivo por Vez”. |
log 9975 | Indica 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 9973 | Indica a quantidade de marcações que já estavam integradas. |
log 9972 | Indica 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: CPF, data, hora não informado). Somente quando a baixa de marcações parametrizada for “Por Lote de Dispositivos”. |
log 9969 | Indica a data e a hora do início da baixa das marcações por lote de dispositivos. |
log 9968 | Indica a data e a hora do término da baixa das marcações por lote de dispositivos. |
log 9967 | Indica o lote em que os dispositivos serão incluídos para a requisição da baixa de marcações. |
log 9966 | Indica os dispositivos que foram incluídos no lote indicado na mensagem ‘log 9967’. |
Todas as mensagens apresentadas no arquivo do log de execução também são apresentadas no arquivo de log Detalhado. |
Na aba Parâmetros é possível indicar que se deseja gerar o arquivo de log técnico. Quando selecionado este campo, é obrigatório que seja informado o diretório para a geração deste arquivo.
Ex: PE9696_log_tecnico_280322_141253.txt
|
No arquivo gerado constarão informações detalhadas sobre as requisições/retornos dos dispositivos e marcações executados durante a baixa de marcações da Carol/Clockin para o Datasul, possibilitando a avaliação de possíveis problemas que possam ter ocorrido.
Ex:
Dependendo do editor de texto utilizado para visualizar o arquivo de log técnico, as informações do arquivo JSON são visualizadas sem formatação. Para correta visualização sugere-se utilizar os editores "Notepad++", "Word" ou "Excel". |
A tabela abaixo demonstra a relação das mensagens exibidas no arquivo de log técnico.
Código Mensagem | Detalhamento |
log 9987 | Indica a data e a hora do início da execução do programa PE9696. |
log 9986 | Indica a data e a hora do término da execução do programa PE9696. |
log 9978 | Indica a data e a hora do término da baixa das marcações do dispositivo/REP. |
log 9977 | Indica a data e a hora do início da baixa das marcações do dispositivo/REP. |
log 9972 | Indica 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 9969 | Indica a data e a hora do início da baixa das marcações por lote de dispositivos. |
log 9968 | Indica a data e a hora do término da baixa das marcações por lote de dispositivos. |
log 9899 | Indica a URL executada:
|
log 9898 | Indica os parâmetros enviados na requisição:
|
log 9897 | Detalhamento do arquivo JSON enviado na requisição dos dispositivos, quando parametrizado para realizar a baixa de marcações por lote de dispositivos. |
log 9896 | Indica o início do detalhamento do arquivo JSON recebido na requisição dos dispositivos. |
log 9895 | Detalhamento do arquivo JSON recebido na requisição dos dispositivos. |
log 9894 | Indica o término do detalhamento do arquivo JSON recebido na requisição dos dispositivos. |
log 9893 | Indica o início do detalhamento do arquivo JSON enviado na requisição das marcações, quando parametrizado para realizar a baixa de marcações de um dispositivo por vez. |
log 9892 | Indica o início do detalhamento do arquivo JSON recebido na requisição das marcações. |
log 9891 | Indica o início do detalhamento do arquivo JSON enviado na requisição das marcações, quando parametrizado para realizar a baixa de marcações por lote de dispositivos. |
log 9890 | Indica o término do detalhamento do arquivo JSON recebido na requisição das marcações. |
log 9889 | Detalhamento do arquivo JSON recebido na requisição das marcações. |
log 9888 | Detalhamento do arquivo JSON enviado na requisição das marcações, quando parametrizado para realizar a baixa de marcações de um dispositivo por vez. |
log 9887 | Indica o cabeçalho para o JSON de retorno da requisição de marcações. |
log 9886 | Indica o início do detalhamento do arquivo JSON enviado na requisição dos dispositivos, quando parametrizado para realizar a baixa de marcações por lote de dispositivos. |
log 9885 | Indica o término do detalhamento do arquivo JSON enviado na requisição dos dispositivos, quando parametrizado para realizar a baixa de marcações por lote de dispositivos. |
log 9884 | Indica o término do detalhamento do arquivo JSON enviado na requisição das marcações, quando parametrizado para realizar a baixa de marcações de um dispositivo por vez. |
log 9883 | Indica o término do detalhamento do arquivo JSON enviado na requisição das marcações, quando parametrizado para realizar a baixa de marcações por lote de dispositivos. |
log 9882 | Detalhamento do arquivo JSON enviado na requisição das marcações, quando parametrizado para realizar a baixa de marcações por lote de dispositivos. |
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_status | Descriçã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 -> devicecode | Nú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 -> repcode | Nú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-nsrCode | Nú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-deviceCode | Número do dispositivo que foi realizada a requisição das marcações. |
get_records_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_records_list > v_response_status | Descriçã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 mdmpersonid | 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-record | As 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 dispositivo | O 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 marcacoes | No 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: repcode | Erro reportado quando mais de um dispositivo estiver cadastrado com mesmo número de Rep na plataforma da Carol Clock-in |
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> |