Essa documentação tem como objetivo demonstrar o processo de integração de Informações de Funcionário e Imagem e Marcações com a SAP. Atualmente a integração segue o seguinte Fluxo:
Image Added
Premissas da Integração:
- SAP deve fornecer API para integrar funcionários e imagens. Cliente deverá entrar em contato com SAP para verificar pois não tem uma integração padrão com a SAP.
- Web Service da SAP deve estar acessível remotamente na infraestrutura do cliente. Normalmente a porta HTTP (80, 8080, etc) deverá estar aberta para ser acessível pela plataforma Carol.
- Assinatura do Web Service deve seguir especificação da API REST integrada pelo Clockin (request/parâmetros e response/formato JSON - no item mais abaixo JSON modelo para integração de funcionário e imagem do SAP).
- Para integração de marcações com a SAP é possível através de três processos:
- Importação Manual de AFD para o SAP: consiste na geração de AFD (Arquivo de Fonte de Dados) do layout padrão conforme legislação portaria 1510, pelo processo de geração agendando do Clockin e importação através do processo de ponto do SAP.
- O conjunto de arquivos AFD é gerado no Storage do Google e para ter acesso ao arquivo é necessário que seja realizado a download do mesmo. Não existe processo automático no produto padrão para download em diretório especificado pelo cliente. Após a ação do usuário para o download do arquivo, este pode ser importado pelo Processo de Importação do SAP.
- Automatização por meio de download dos arquivos AFD: o cliente poderá adquirir o customizado para permitir efetuar o download dos arquivos AFD do Storage do Google, gerados para cada dispositivo, mais rapidamente. O objetivo é fazer com que os arquivos sejam descarregados em um diretório de rede, informado conforme parâmetro. Em seguida é necessário configurar a rotina do SAP para a leitura/importação periódica dos arquivos. Para maiores informações entrar em contato através de ticket com a Fábrica TOTVS.
- Integração via API do Clockin: consiste na integração automática de marcações via consumo da API REST Clockin que encontra-se disponível conforme documentação aqui. O cliente deverá solicitar a SAP o fornecimento do serviço para o consumo da API REST Clockin.
Connector:
Tem por objetivo buscar
Data Pipeline
Image Removed
Conector
Busca os dados de funcionários e fotos do SAP (API Success Factors - HR). Para isso é necessário que o Connector esteja atualizado no ambiente juntamente com o mapeamento padrão. Na implantação será disponibilizado o conector e os mapeamentos padrões para a integração.
Image Added
Data Pipeline:
Demonstra como a informação chega no Conector SAP e mergeada (processo onde ocorre junção de informações recebidas do SAP para que seja possível atualizar nos Data Models do Clockin) através do processo SAPINTEGRATIONAPP do TOTVS RH Clock-in.até chegar no Data Model Employee e Image. Essa informação é possível visualizar através do Data Journey (primeira opção do Menu da Carol, no canto superior esquerdo).
Image AddedData Pipeline:
- FOTOS: Recebidas pela Staging area (tabela que recebe informações fidedigno da origem) SAP_PHOTO com mapeamento para o Data Model IMAGE.
- FUNCIONÁRIOS: Recebidos pela Staging area (tabela que recebe informações fidedigno da origem) SAP_EMPLOYEE passando pelo ETL (tipo de data integracion usado para combinar dados - extrair, transformar, carregar) de duplicação com as seguintes Stagings areas de saídas:
- EMPLOYEE_LK: disponível Disponível para mapear com o Data Model USER, se necessário.
- EMPLOYEE: mapeamento Mapeamento com o Data Model EMPLOYEE
Parâmetros
photoapi (API Fotos)
URL da API para obter as fotos dos funcionários.
Settings:
Permite realizar a configuração da integração SAP através do Settings da Carol. Para que a integração das informações com a Carol aconteça é necessário informar os seguintes campos:
Image Added
País/Empresas → countrycompanies
Informar o país e empresas que devem ser sincronizadas. A propriedade especifica o país, o array especifica a lista de empresas. Exemplo: {"GTM":["GT01", "GT02"],"NIC":["NI01", "NI02"],"MEX":["MX01", "MX02"]}
API Funcionários → employeeapi
...
URL da API para obter os dados dos funcionários.
Valor default para os parametros:
pagesize (top) = 10.000
offset (skip) = 0
...
Sync Funcionários → employeesync
Filtro para buscar funcionários que devem ser sincronizados para a Carol (Sim/Não)
API Fotos → photoapi
...
URL da API para
...
obter as fotos dos funcionários.
...
Data / Hora Última Alteração
...
Parâmetro que indicará qual o valor da última sincronização.
Quando em branco inicia uma sincronização completa.
Carol App vai atualizar a última sincronização efetuada nesta configuração.
Exemplo de formatação: 2007-04-05T12:30-02:00
...
dos Funcionários → lastdatemodified
Parâmetro que indicará qual o valor da última sincronização por pais.
Quando em branco inicia uma sincronização completa.
Carol App vai atualizar a última sincronização efetuada por pais nesta configuração, conforme estrutura a seguir.
Exemplo de formatação: {"MEX":"2020-11-27T01:01:13.730042","NIC":"2020-11-27T01:01:23.571120","GTM":"2020-11-27T01:10:17.284987
...
pagesize (Page Size)
Param TOP para a API Funcionários.
countrycompanies (País / Empresas)
Parametrização de países e empresas que devem ser sincronizadas.
A propriedade especifica o país, o array especifica a lista de empresas.
...
"
...
}
...
Senha para a API de autenticação.
...
Sync Fotos → photosync
Sync Fotos para a Carol
...
employeesync (Sync Funcionários)
Sync Funcionários para a Carol.
(SIm/Não)
Sysclock → sysclock
...
Filtro para buscar funcionários que devem ser sincronizados para a Carol. Valor 1 = Sim.
Page Size → pagesize
Param TOP para a API Funcionários.
...
tokenapiuser (Usuário)
API Token → tokenapi
URL da API para geração do token de autenticação (OAuth 2.0 - Basic Authentication).
Usuário → tokenapiuser
Usuário para a API de autenticação.
Senha → tokenapipassword
Senha para a API de autenticação.
Processo:
Image Added
SapIntegrationApp SAPINTEGRATIONAPP - Processo batch do TOTVS RH Clock-in com os seguintes comportamentos conforme os dados recebidos:
- FOTOS: Fotos: tem como objetivo realizar a busca de fotos realizando a integração com SAP na URL do campo API Fotos informada no Settings A partir de uma data de corte é recebido 100 registros por request (página) até alcançar a última página (sem registro).
- FUNCIONÁRIOS: Conforme Funcionários: tem como objetivo a busca de funcionários realizando a integração com SAP na URL do campo API Funcionários. Conforme a estrutura passada no parâmetro countrycompanies parâmetro País/Empresas é efetuado um request uma requisição por país e sem paginação, ou seja, todos os registros conforme filtro passado.
Web Service SAP
Mapeamento dos Campos
Para que a integração de funcionários e imagens dos funcionários possa ocorrer entre SAP e Carol é necessário que o SAP disponibilize APIs de integração de funcionários e imagens. Abaixo é demonstrado como o Connector do SAP está configurado para receber informações do SAP através dos mapeamentos de dados,
Mapeamento de Dados
O Mapeamento de dados tem como objetivo permitir o de-para de informações para que as mesmas sejam transferidas do SAP para o Clockin. O mapeamento já é atualizado no momento da implantação. Desta forma essas informações irão servir para a saber quais informações devem ser consideradas na api de integração que deverá ser disponibilizada pela SAP para a integração com o Clockin. Abaixo segue mapeamento padrão do Conector Employee para o DM Employee para a integração com o Clockin:
Image Added
Image Added
Image Added
Image Added
Image Added
Image Added
Image Added
Segue também o mapeamento do Conector sap_photo para o DM Image para a integração com o Clockin:
Image Added
Image Added
JSON modelo para integração de funcionário e imagem do SAP:
Para realizar a integração de informações com o Clockin é necessário seguir o modelo do JSON informado abaixo:
View file |
---|
name | TOTVS Clock-in x SAP.postman_collection.json |
---|
height | 250 |
---|
|
Image Removed