01. VISÃO GERAL
Esta documentação tem como objetivo demonstrar quais são os campos do ERP DATASUL que são utilizados para a integração das informações com o Clockin.
Segue pré-requisitos de versão para o RM:
- Datasul 12.1.27.1
- Progress 11.7
02. CAMPOS INTEGRADOS COM CLOCKIN
Abaixo estão os Data Models do Clockin onde recebem informações que são demonstradas no Backoffice:
02.01 Data Model Employee (Funcionário)
As tabelas (stagings tables) que compõe o Data Model Employee (Funcionário) são, a rh_pessoa_fisic (pessoa física) e a funcionario (funcionário).
Seguem os campos que são utilizados e suas regras de validação:
Descrição | campo staging | campo Clock In | Regra | Justificativa da Coleta |
|---|---|---|---|---|
nom_mail_contat nom_e_mail | Email Address (String) | Necessário selecionar no campo "E-mail utilizado para o envio do comprovantes de marcação do funcionário" no Settings do Clock in, qual o e-mail que deseja enviar o comprovante de marcação:
Considera o e-mail do Contato da tabela Pessoa Física (rh_pessoa_fisic.nom_mail_contat) | Login no Aplicativo Mobile, Backoffice e Aplicativo Clockin Web Legislação - Portaria 671 (envio de comprovante) | |
| Código Pessoa | cod_id_estad_fisic | Person Code (String) | Considera o campo RG do cadastro de Pessoa Física (rh_pessoa_fisic.cod_id_estad_fisic) | Necessidade Técnica para encontrar os informações da tabela ppessoa |
| Motivo Demissão | NA | Terminate Reason (String) | Não integra | Cumprimento de Obrigação Legal - Portaria 671 |
| Está Demitido? | dat_desligto_func | isTerminated (Boolean) | Se a data de desligamento não estiver preenchida considera como Não. Se a data de desligamento for menor que a data atual considera como Não Se a data de desligamento for maior ou igual a data atual considera como Sim | Cumprimento de Obrigação Legal - Portaria 671 |
| Tipo de Demissão | NA | Termition Type (String) | Não integra | Cumprimento de Obrigação Legal - Portaria 671 |
| Data de Demissão | dat_desligto_func | Termination Date (Date) | Considera a data de desligamento do funcionário | Cumprimento de Obrigação Legal - Portaria 671 |
| Nome | nom_pessoa_fisic | Name (String) | Nome da Pessoa Física | Cumprimento de Obrigação Legal - Portaria 671 |
| PIS | cod_pis | PIS Code (String) | Código do Pis | Cumprimento de Obrigação Legal - Portaria 671 |
| Categoria do Funcionário | NA | Situation Code (String) | Não é integrado | Cumprimento de Obrigação Legal - Portaria 671 |
| Tipo do endereço | Type (String) | conteúdo do campo será "Default" | Funcionalidade Controle da Geofence - para indicar se o funcionário está dentro ou fora do perímetro do endereço do trabalho | |
| Rua | nom_ender_rh | Address 1 (String) | Endereço da Pessoa Física | Funcionalidade Controle da Geofence - para indicar se o funcionário está dentro ou fora do perímetro do endereço do trabalho |
| Bairro | nom_bairro_rh | Address 2 (String) | Bairro da Pessoa Física | Funcionalidade Controle da Geofence - para indicar se o funcionário está dentro ou fora do perímetro do endereço do trabalho |
| Complemento | SUBSTR(stg.cod_livre_1, 8, 58) | Address 3 (String) | Complemento da Pessoa Fìsica | Funcionalidade Controle da Geofence - para indicar se o funcionário está dentro ou fora do perímetro do endereço do trabalho |
| Cidade | nom_cidad_rh | City (String) | Cidade da Pessoa Fìsica | Funcionalidade Controle da Geofence - para indicar se o funcionário está dentro ou fora do perímetro do endereço do trabalho |
| Estado (UF) | cod_unid_federac_rh | State (String) | Unidade da Federação da Pessoal Física | Funcionalidade Controle da Geofence - para indicar se o funcionário está dentro ou fora do perímetro do endereço do trabalho |
| País | cod_pais | Country (String) | se p código do país da pessoal física for = "BRA" então o conteúdo do campo será "Brasil", senão o que veio no campo | Funcionalidade Controle da Geofence - para indicar se o funcionário está dentro ou fora do perímetro do endereço do trabalho |
| CEP | cod_cep_rh | Zip Code (String) | Cep da pessoa física | Funcionalidade Controle da Geofence - para indicar se o funcionário está dentro ou fora do perímetro do endereço do trabalho |
| CNPJ da Empresa do funcionário | cdn_empresa | Tax ID (String) | Cumprimento de Obrigação Legal - Portaria 671 | |
| Código da Imagem | CPF | Image Code (String) | Atualiza o código da imagem que foi utilizada para integração da imagem com o Clockin. Este campo é usado para o relacionamento com o DM Imagem. | Reconhecimento Facial e validação de fraude na marcação |
| Tipo de Telefone | Contém o conteúdo "Contato" | Realizar o login por SMS Envio de Comprovante de Marcação (Legislação - Portaria 671) | ||
| Número de Telefone | num_ddd_contat + num_telef_contat | Concatena os campos ddd e número telefone | Realizar o login por SMS Envio de Comprovante de Marcação (Legislação - Portaria 671) | |
| CPF | cod_id_feder | Person ID (String) | CPF da pessoa física | Cumprimento de Obrigação Legal - Portaria 671 |
Registro Geral | cdn_empresa + "-" + cdn_estab + "-" + cdn_funcionario | Employee Code (String) | Concatena os campos Empresa, Estabelecimento e Matricula separado por hífen | Efetuar Consulta do Funcionário |
| Data de Admissão | dat_admis_func | Data Admissão (Date) | Conteúdo da data de admissão do funcionário | Cumprimento de Obrigação Legal - Portaria 671 |
| Código da Função | cdn_cargo_basic + cdn_niv_cargo | Function Code (String) | Realizar segmentação de dados para apresentação - Segurança da Informação | |
| Descrição da Função | des_cargo | Function Description (String) | Atualiza a descrição relativa ao código da função da tabela cargo verificando o cargo_basic e o niv_cargo do funcionário | Realizar segmentação de dados para apresentação - Segurança da Informação |
| Classe do Funcionário | cdn_clas_func | Employee Class (String) | Contém o conteúdo do campo Código da Classe do Funcionário no Ponto | Realizar segmentação de dados para apresentação - Segurança da Informação |
Tipo de Evento | cdn_cargo_basic + cdn_niv_cargo | Clock In Event Type Group Name (String) | Realizar segmentação de dados para apresentação - Segurança da Informação | |
| Centro de Custo | funcionario.cdn_empresa + "-" + funcionario.cdn_rh_ccusto | Cost Center Code (String) | Cumprimento de Obrigação Legal - Portaria 671 | |
| Descrição do Centro de custo | rh_ccusto.des_rh_ccusto | Cost Center Description (String) | Atualiza a descrição relativa ao código do centro de custo da tabela rh_ccusto verificando o cdn_empresa do funcionário em relação a rh_ccusto do centro de custo | Realizar segmentação de dados para apresentação - Segurança da Informação |
| Código de Seção | funcionario.cdn_empresa + "-" + funcionario.cod_unid_lotac | Section Code (String) | Realizar segmentação de dados para apresentação - Segurança da Informação | |
| Grupo de Seção | funcionario.cdn_empresa + "-" + funcionario.cod_unid_lotac | Grouped Section Code (String) | Realizar segmentação de dados para apresentação - Segurança da Informação |
NO 2C deverá ser configurado um filtro para não trazer os funcionários desligados anteriores a implementação na inicialização da integração. Para maiores informações sobre esses processos relativos ao 2C clicar aqui e acessar o item 8, sub item Condition for initialization.
02.02 Data Model Image (Imagem)
A tabela (staging table) que compõe o Data Model Image (Imagem) é a fotos_clockin, ela possui as informações do diretório e nome do arquivo que são preenchidos pelo 2C - Carol Connect e utilizados para vincular a imagem ao empregado.
Seguem os campos que são utilizados e suas regras de validação:
Descrição | campo satging | campo Clock In | Regra | Justificativa da Coleta |
|---|---|---|---|---|
| Imagem do funcionário | Image (Base 64) | Busca a imagem do diretório de imagens informado do ambiente | Utilizado para o reconhecimento facial para marcação de ponto | |
| Código da Imagem do Funcionário | cod_id_feder | Image Code (String) | Atualiza o código da imagem com o CPF da pessoa física | Utilizado para o reconhecimento facial para marcação de ponto |
| Sequencia da Imagem | Image Sequence (Long) | A sequencia inicial é "0" | Utilizado para o reconhecimento facial para marcação de ponto | |
| Data de integração da imagem | Não integra | Utilizado para o reconhecimento facial para marcação de ponto |
No momento em que as imagens são geradas no Data Model Image, o Image Code (chave da imagem) é gravado com o CPF da pessoa que deve estar no nome do arquivo da imagem. Desta forma o nome do arquivo de imagens precisa ser gerado com o CPF do funcionário a quem pertence a foto para que seja atualizada da forma correta no Clockin
É possível subir diretório de fotos normalmente do Datasul, desde que o cliente utilize servidor local. O Cloud Totvs tem um impeditivo para subir imagens, pois precisa utilizar SFTP e na visão deles não é seguro e não realizam mais em ambientes Cloud. Então se o cliente é Cloud, não é feito a implantação por esse processo de subir as fotos pelo 2C.
É necessário avaliar a qualidade das imagens para essa importação, muitas vezes observado imagens antigas, de má qualidade então sugerir para o cliente ou cadastrar pelo BackOffice ou pelo dispositivo.
02.03 Data Model Company (Empresa)
As tabelas (stagings tables) que compõe o Data Model Company (Empresa) são, a rh_estab, sped_rh_estab e a rh_pessoa_jurid.
Seguem os campos que são utilizados e suas regras de validação:
Descrição | Nome da Staging/Tabela e Campo/Coluna da Staging | Campo do Data Model e Tipo | Regra | Justificativa da Coleta | |
|---|---|---|---|---|---|
| CNPJ | rh_estab.cod_id_feder | mdmtaxid | string |
| Cumprimento de Obrigação Legal - Portaria 671: Vinculado aos Dispositivos para apresentar os dados da Empresa no comprovante de marcação de ponto. |
| CEI/CNO/CAEPF | sped_rh_estab.cod_caepf ou sped_rh_estab.cod_cno | ceicode | string | ||
| Identificador de Chave Primária | rh_estab.cod_id_feder + | + sped_rh_estab.cod_caepf ou sped_rh_estab.cod_cno ( e.g. "12345678000101|12345678") | mdmpkid | string | ||
| Código de Empresa do ERP | rh_estab.cdn_estab | erpcompanycode | string | Considera o valor mais recente | Usado para os relacionamentos internos no produto, para o processo de criação automática de dispositivos e, futuramente, para o tratamento de múltiplos vínculos. |
| Código da Empresa | rh_estab.cdn_empresa | mdmcompanycode | string | ||
| Nome | rh_estab.nom_pessoa_jurid | mdmname | string | Considera o valor mais recente | Cumprimento de Obrigação Legal - Portaria 671: Vinculado aos Dispositivos para apresentar os dados da Empresa no comprovante de marcação de ponto. |
| Nome Fantasia | rh_estab.nom_abrev_pessoa_jurid | mdmdba | string | Considera o valor mais recente | Será utilizado, futuramente, para casos de múltiplos vínculos onde o empregado deverá selecionar a empresa/filial para qual o registro será destinado. |
| Ativo | - | mdmisactive | boolean | Sempre True quando vindo da integração com o ERP | Usado para os relacionamentos internos no produto. |
| Endereço | - | mdmaddress | nested | Estrutura que recebe os dados relacionados ao endereço da Empresa. | Cumprimento de Obrigação Legal - Portaria 671: Vinculado aos Dispositivos para apresentar os dados da Empresa no comprovante de marcação de ponto. Funcionalidade Controle da Geofence - para indicar se o funcionário está dentro ou fora do perímetro do endereço do trabalho. |
| Coordenadas | - | mdmcoordinates | geo_point | Gerado durante o processamento do registros, mas somente quando há cerca a nível de Empresa habilitado e o endereço for válido. Ou, alimentado manualmente quando utilizada a seleção no mapa através do cadastro do Backoffice. | |
| Pais | rh_pessoa_jurid.cod_pais | mdmcountry | string | Considera o valor mais recente | |
| CEP | rh_pessoa_jurid.cod_cep_rh | mdmzipcode | string | Considera o valor mais recente | |
| Endereço 3 | rh_pessoa_jurid.cod_compl_ender_rh | mdmaddress3 | string | Considera o valor mais recente | |
| Tipo | - | mdmaddresstype | string | Valor 'default' definido pelo Clock In para integrações originadas do ERP | |
| Cidade | rh_pessoa_jurid.nom_cidad_rh | mdmcity | string | Considera o valor mais recente | |
| Endereço 1 | rh_pessoa_jurid.nom_ender_rh | mdmaddress1 | string | Considera o valor mais recente | |
| Endereço 2 | rh_pessoa_jurid.nom_bairro_rh | mdmaddress2 | string | Considera o valor mais recente | |
| Estado | rh_pessoa_jurid.cod_unid_federac_rh | mdmstate | string | Considera o valor mais recente | |
| Inscrição Estadual | - | mdmstatetaxid | string | Legado | |
| Inscrição Municipal | - | mdmcitytaxid | string | Legado | |
| Link da Imagem | - | mdmimageurl | string | Legado | |
| Data da Situação | - | mdmsituationdate | date | Legado | |
| Telefone | - | mdmphone | nested | Legado | |
| Número de Telefone | - | mdmphonenumber | string | Legado | |
| Tipo | - | mdmphonetype | string | Legado | |
| Is Headquarters | - | mdmisheadquarters | boolean | Legado | |
| Data de Registro | - | mdmregisterdate | date | Legado | |
Para que o cadastro funcione corretamente é necessário habilitar a integração através do 2C - Carol Connect das tabelas mencionadas acima.
Para mais informações relacionadas ao 2C - Carol Connect, acesse:
03. CONSIDERAÇÕES ADICIONAIS
Toda a comunicação entre ERP, Carol Connect e Clock In utiliza protocolo de comunicação HTTPS (Hypertext Transfer Protocol Secure) com certificado SSL, garantindo assim que a comunicação seja protegida e os pacotes sejam entendidos apenas pelos determinados receptores. Para maiores informações do Carol Connect clique aqui.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas