O conteúdo a seguir abrange uma visão geral dos modos de consulta da API de empregado composto do SAP SuccessFactors.
Compreensão da funcionalidade de modos de API
Objective
Introdução
API de empregado composto - síntese de modos
Selecione o botão de reprodução para ver uma síntese dos diferentes modos.
Compound Employee API - inclui modos
Para executar a API Compound Employee em diferentes modos, precisamos fornecer os parâmetros especificados. Ao usar o modo completo, não precisamos fornecer nenhum parâmetro porque é o modo padrão para a API Compound Employee e retorna os dados atuais dos funcionários, incluindo todos os períodos. Ao usar o modo de instantâneo, precisamos fornecer o parâmetro (queryMode é igual a instantâneo) aqui, ele retorna os dados dos empregados como estavam em uma determinada data no passado. Ao usar o modo delta, também precisamos fornecer o parâmetro (queryMode=delta) aqui, ele retorna as modificações que ocorreram desde um determinado momento.
| Modo | Parâmetro | Objetivo |
|---|---|---|
| Completo | Retorna os dados atuais dos empregados, incluindo todas as faixas de tempo. | |
| Instantâneo | <urn:param> <urn:name>queryMode</urn:name> <urn:value>snapshot</urn:value> </urn:param> | Retorna os dados dos colaboradores como estavam em uma determinada data no passado. |
| Delta | <urn:param> <urn:name>queryMode</urn:name> <urn:value>delta</urn:value> </urn:param> | Retorna as modificações que ocorreram desde um determinado momento. |
Compound Employee API – Transmissão completa
A transmissão completa extrai todos os dados relacionados aos dados do empregado no sistema. Isso inclui todas as faixas de tempo, dados históricos e registros com data futura, e o ponto mais importante é que o consumidor pode reagir com base nos dados fornecidos. Se os dados tiverem sido modificados ou eliminados, o consumidor precisa considerar o que aconteceu com os dados e reagir de modo correspondente.
- O conjunto completo de dados de um colaborador é retornado na resposta da API Compound Employee.
- Isso inclui todas as faixas de tempo, dados históricos e registros com data futura.
- O consumidor pode reagir com base nos dados fornecidos.
API de empregado composto - modo de instantâneo
- A ser utilizado se os dados do empregado "a partir da data" forem de interesse.
- Retorna exatamente o estado dos dados do empregado em um determinado momento.
- Suporta segmentos baseados em HRIS e MDF.
Compound Employee API – Transmissão delta
Ocorreram devoluções de dados modificados para empregados. Existem 2 modos diferentes para transmissão delta.
- Desde um determinado momento (transmissão delta com data efetiva).
- Isso é relevante para um determinado período (transmissão delta baseada no período).
Compound Employee API - Transmissão delta com data efetiva
O delta é baseado no cálculo delta baseado no campo
- Indicação de campos modificados, incluindo valores anteriores
- Transmissão delta requer dados de auditoria
A auditoria precisa ser ativada idealmente desde o início
API de empregado composto - Exportação delta

- Destinado à população de funcionários de pequeno porte para um país.
- É baseado nos modos de transmissão delta das APIs Compound Employee.
Compound Employee API – Recursos adicionais
- O segmento per_person da API Compound Employee foi ampliado pelo novo campo PERSON_GUID, que identifica exclusivamente uma pessoa. É filtrável e ordenável.
- Introduzimos o conceito de UUID de pessoa (identificador universal exclusivo) para todo o SAP SuccessFactors HCM Suite; quando uma nova contratação ou usuário é criado, o sistema gera esse identificador – chamado "perPersonUuid".
perPersonUuid permite que você exponha o UUID da pessoa para cenários de integração e importação para todos os colaboradores (colaboradores EC e não EC). O campo é visível e atualizável em PerPerson, mas não pode ser consultado por meio desta entidade.
Baixar o arquivo WSDL do serviço API do SAP SuccessFactors
Síntese do processo
Essa simulação demonstra o Knowledge of Compound Employee API básico. Ele ajudará você a consultar/extrair dados do SuccessFactors Employee Central em diferentes modos de consulta (Completo/Delta/Instantâneo). Além disso, ele lhe dará uma compreensão mais profunda do recorte de tempo.
Pré-requisitos
A configuração e personalização a seguir devem ter sido concluídas antes de implementar as configurações básicas no SAP SuccessFactors.
- Acesso à SFAPI SOAP
Resultado
Abordaremos o seguinte tópico:
Como obter o serviço Web SFAPI do SAP SuccessFactors.
Importar WSDL e criar uma suíte de testes
Síntese do processo
Essa simulação demonstra o Knowledge of Compound Employee API básico. Ele ajudará você a consultar/extrair dados do SuccessFactors Employee Central em diferentes modos de consulta (Completo/Delta/Instantâneo). Além disso, ele lhe dará uma compreensão mais profunda do recorte de tempo.
Pré-requisitos
A configuração e personalização a seguir devem ter sido concluídas antes de implementar as configurações básicas no SAP SuccessFactors.
- Acesso à SFAPI SOAP
Resultado
Abordaremos o seguinte tópico:
Criar e definir a suíte de testes no mandante SoapUI.
Criar e estruturar etapas de teste em SoapUI
Síntese do processo
Essa simulação demonstra o Knowledge of Compound Employee API básico. Ele ajudará você a consultar/extrair dados do SuccessFactors Employee Central em diferentes modos de consulta (Completo/Delta/Instantâneo). Além disso, ele lhe dará uma compreensão mais profunda do recorte de tempo.
Pré-requisitos
A configuração e personalização a seguir devem ter sido concluídas antes de implementar as configurações básicas no SAP SuccessFactors.
- Acesso à SFAPI SOAP
Criar etapas de teste para o processo de login do SAP SuccessFactors
Síntese do processo
Essa simulação demonstra o Knowledge of Compound Employee API básico. Ele ajudará você a consultar/extrair dados do SuccessFactors Employee Central em diferentes modos de consulta (Completo/Delta/Instantâneo). Além disso, ele lhe dará uma compreensão mais profunda do recorte de tempo.
Pré-requisitos
A configuração e personalização a seguir devem ter sido concluídas antes de implementar as configurações básicas no SAP SuccessFactors.
- Acesso à SFAPI SOAP
Criar novo empregado e consulta via IU SOAP
Síntese do processo
Essa simulação demonstra o Knowledge of Compound Employee API básico. Ele ajudará você a consultar/extrair dados do SuccessFactors Employee Central em diferentes modos de consulta (Completo/Delta/Instantâneo). Além disso, ele lhe dará uma compreensão mais profunda do recorte de tempo.
Pré-requisitos
A configuração e personalização a seguir devem ter sido concluídas antes de implementar as configurações básicas no SAP SuccessFactors.
- Acesso à SFAPI SOAP
Resultado
Abordaremos o seguinte tópico:
Criação no SAP SuccessFactors e a resposta correspondente para criação via SoapUI Client.
Configurar o SAP SuccessFactors e executar consultas no SoapUI
Síntese do processo
Essa simulação demonstra o Knowledge of Compound Employee API básico. Ele ajudará você a consultar/extrair dados do SuccessFactors Employee Central em diferentes modos de consulta (Completo/Delta/Instantâneo). Além disso, ele lhe dará uma compreensão mais profunda do recorte de tempo.
Pré-requisitos
A configuração e personalização a seguir devem ter sido concluídas antes de implementar as configurações básicas no SAP SuccessFactors.
- Acesso à SFAPI SOAP
Resultado
Abordaremos o seguinte tópico:
Modificar/atualizar no SAP SuccessFactors e a resposta correspondente para modificações via SoapUI Client.