Présentation de SAP SuccessFactors Compound Employee API
Exploration des modes Compound Employee API
Sélection de paramètres pour l'API de salarié combiné
Extension de l'extensibilité de l'API d'employé composite
Postes de journalisation dans l'API d'employé combiné
Analyse de l'annexe

Compréhension de l'annexe

Objective

After completing this lesson, you will be able to recherchez Ressources et documentation Compound Employee API.

Extensions

Améliorations : annonce du visualiseur des nouveautés

Retrouvez toutes les nouvelles fonctionnalités et extensions de la version dans le visualiseur des nouveautés sur le SAP Help Portal.

Pour plus de détails sur un sujet, procédez comme suit :

  1. Accédez au SAP Help Portal et, dans la liste déroulante Rechercher tout, saisissez Informations sur la version de SAP SuccessFactors.
  2. Dans la liste déroulante à droite du titre Informations sur la version SAP SuccessFactors, sélectionnez la version appropriée.
  3. Sélectionnez Visualiseur des nouveautés.
  4. Sélectionnez les filtres requis pour afficher la rubrique.
  5. Si la rubrique contient plus d'informations, sélectionnez Voir plus.
  6. Sous la section Informations associées, recherchez des détails supplémentaires sur la rubrique.
Document Nouveautés de SAP SuccessFactors : synthèse des nouvelles fonctionnalités, statut du cycle de vie et numéros de référence.

Extensions pour les modèles d'importation d'employés

Qu'est-ce que c'est ?

Des améliorations ont été apportées lors du téléchargement des modèles sur la page « Importer les données des employés ». Cela inclut la possibilité d'afficher les intitulés des champs qui, à la place des ID de champ, l'ordre alphabétique et la possibilité de télécharger le modèle d'un pays spécifique.

Pourquoi est-ce important ?

Ces améliorations améliorent considérablement l'utilisabilité. Étant donné que vous pouvez afficher les descripteurs de zone qui ont été configurés dans le modèle de données, au lieu des ID de zone, cela vous aide à rechercher facilement une zone de données particulière. Ceux-ci sont également triés par ordre alphabétique pour améliorer la facilité d'utilisation. En outre, vous pouvez désormais télécharger un modèle spécifique à un pays à partir de la nouvelle liste déroulante « Sélectionner un pays ».

Conditions préalables

Néant

Extension - Prise en charge de l’identifiant de pièce jointe pour l’entité EmpEmploymentTermination

Qu'est-ce que c'est ?

Cette amélioration prend en charge l’ID de pièce jointe dans l’importation de Résiliation du vide. Lors de l’importation de terminationInfo pour les utilisateurs, l’importation accepte des identifiants de pièce jointe valides.

Pourquoi est-ce important ?

Dans cette version, les administrateurs peuvent désormais charger des pièces jointes lors de l’importation de l’entité Détails de la fin de contrat. Pour ce faire, vous pouvez spécifier l'ID de pièce jointe du document dans le fichier d'importation CSV.

Conditions préalables

Néant

Extension - Indiquez tous les événements combinés valides un jour spécifique.

Qu'est-ce que c'est ?

L'API Compound Employee fournit un nouveau paramètre, "segmentsForEnhancedEffectiveEndDateFilter". Utilisez ce paramètre si vous incluez le paramètre "effective_end_date" dans la demande de requête et que vous souhaitez que l'API retourne plusieurs événements exécutés pour les segments "Données emploi" et "Informations sur la rémunération" le même jour.

Pourquoi est-ce important ?

Auparavant, si plusieurs événements étaient exécutés dans Employee Central le même jour et que la date de fin de validité était postérieure à ce jour, seul le dernier événement était renvoyé par l’API car seul cet événement a un intervalle de temps qui chevauche "effective_end_date". En activant le paramètre "segmentsForEnhancedEffectiveEndDateFilter", vous pouvez vous assurer que le système en aval stocke tous les événements et peut y réagir en conséquence. Le paramètre est pris en charge dans les modes de transmission complète et d'instantané de l'API. Pour l'utiliser, vous devez spécifier "allJobChangesPerDay" ou "allCompensationChangesPerDay" pour le paramètre "resultOptions".

Conditions préalables

Utiliser le paramètre "segmentsForEnhancedEffectiveEndDateFilter" dans la requête de l'API d'employé composite

Extension - Nouveau filtre pour hiringNotCompleted

Qu'est-ce que c'est ?

L'API Compound Employee fournit un nouveau paramètre, hiringNotCompleted. Ce paramètre évalue la propriété de code hiringNotCompleted dans l'entité EmpEmployment dans Employee Central, ce qui permet de différencier les enregistrements de données des personnes à intégrer qui n'ont pas encore terminé le processus Gérer les embauches en attente. Si hiringNotCompleted est False, l'API renvoie uniquement les données des salariés embauchés.

Pourquoi est-ce important ?

Cela est utile si vous voulez que vos systèmes en aval reçoivent uniquement les données qui ont été validées par rapport au modèle de données des employés. hiringNotCompleted est pris en charge dans tous les modes API.

Conditions préalables

Utilisez le filtre hiringNotCompleted dans votre requête Compound Employee API.

Amélioration - Nouveau paramètre de filtre pour les informations globales dans les informations personnelles en fonction du pays/de la région

Qu'est-ce que c'est ?

L'API CompoundEmployee fournit le nouveau paramètre de requête suppressUnwantedGlobalInfo pour filtrer les informations globales en fonction du pays/de la région.

Le filtrage s'applique aux segments suivants :

  • personal_information
  • dependent_information(dependent_personal_information)
  • carte_id_nationale

Pourquoi est-ce important ?

Utilisez le paramètre suppressUnwantedGlobalInfo pour filtrer les informations globales dans les informations personnelles de SAP SuccessFactors Employee Central en fonction du pays/de la région indiqué(e) dans la clause WHERE de la requête. Le pays/La région est indiqué(e) avec le paramètre employment_information_country ou employment_information_company dans la clause WHERE.

Conditions préalables

Le filtrage des informations globales est uniquement pris en charge dans le mode de requête standard de l'API CompoundEmployee.

Attention

Respectez les réglementations sur la confidentialité et la protection des données en incluant le paramètre suppressUnwantedGlobalInfo afin que seules les parties requises des Informations globales soient transférées vers le système en aval.

Extension - Structure de salarié associée dans l'API de salarié composite

Qu'est-ce que c'est ?

L’API Compound Employee affiche désormais tous les emplois d’un responsable (nom de segment associated_employee_employment_information) sous un segment pour chaque responsable (nom de segment associated_employee_information).

La modification aligne le comportement en mode standard sur une correction déjà appliquée en mode delta pour éviter les erreurs de clé en double. Cela est pertinent uniquement pour les cas où un salarié a plusieurs relations avec différentes activités avec le même responsable.

Dans la version précédente, chaque segment associated_employee_employment_information était généré dans son propre segment associated_employee_information dupliqué.

Exemple de code
Code Snippet
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
<queryResponse xmlns="urn:sfobject.sfapi.successfactors.com" xmlns:ns2="urn:fault.sfapi.successfactors.com"> <result> <sfobject> <id>53</id> <type>CompoundEmployee</type> <person> <created_by>v4admin</created_by> <created_on_timestamp>2011-04-25T15:01:48.000Z</created_on_timestamp> ... <person_id>53</person_id> <employment_information> <assignment_class>ST</assignment_class> ... <job_information> ... <start_date>2009-10-01</start_date> ... </job_information> <associated_employee_information> ... <person_id>91</person_id> <person_id_external>cgrant1</person_id_external> ... <associated_employee_employment_information> <assignment_class>GA</assignment_class> <assignment_type>ShortTermASS</assignment_type> <assignmentIdExternal>186</assignmentIdExternal> <user_id>186</user_id> ... <associated_employee_job_information> ... <start_date>2013-04-01</start_date> ... </associated_employee_job_information> </associated_employee_employment_information> <associated_employee_employment_information> <assignment_class>ST</assignment_class> <assignmentIdExternal>cgrant1</assignmentIdExternal> <user_id>cgrant1</user_id> ... <associated_employee_job_information> ... <start_date>2010-09-06</start_date> ... </associated_employee_job_information> </associated_employee_employment_information> </associated_employee_information> </employment_information> </person> <execution_timestamp>2021-01-15T09:58:13.000Z</execution_timestamp> <version_id>2105P0</version_id> </sfobject> <numResults>1</numResults> <hasMore>false</hasMore> <querySessionId>ce7c67ac-ab0a-446d-a97b-2539af8886d1</querySessionId> </result> </queryResponse>

Extension - Restrictions sur les zones d'API pour la date de dernière modification et la date de l'instantané

Qu'est-ce que c'est ?

Les requêtes qui extraient des données des zones last_modified_on ou snapshot_date de Employee Central CompoundEmployee API sont désormais limitées à un maximum de 3 mois dans le passé dans les instances d'aperçu ET de production.

Notez que cette restriction a désormais un impact sur votre environnement de production à partir de la version 2H 2021.

Remarque

Cette limitation s'applique à tous les modes Employee Central CompoundEmployee API : transmission complète, delta et instantané.

Cette amélioration augmente les performances et permet une synchronisation plus rapide entre Employee Central et les systèmes cibles.

Conditions préalables

Vous devez ajuster les zones en fonction de votre configuration existante.

Amélioration - Nouvel accès au segment Employee Central Compound Employee API

Qu'est-ce que c'est ?

Cette nouvelle autorisation autorise l’accès uniquement à des segments individuels en fonction de la configuration définie. Auparavant, il n’était pas possible de restreindre l’accès des utilisateurs à des segments spécifiques des autorisations de l’API d’employé composite. Désormais, les utilisateurs peuvent restreindre l’accès à des segments particuliers via les autorisations basées sur les rôles.

Conditions préalables aux autorisations basées sur les rôles

Vous disposez de l'autorisation AdministrateurGérer les autorisations des rôles.

Paramètres d’autorisation pour Employee Central API, affichant les options d’accès API sélectionnables et les autorisations associées.

Amélioration - Nouveau segment Informations sur l’identité pour Employee Central Compound Employee API

Qu'est-ce que c'est ?

Employee Central Compound Employee API prend désormais en charge un nouveau segment appelé Informations sur l’identité.

Les clients peuvent désormais utiliser ce segment pour répliquer certaines zones à partir des informations de compte utilisateur d'un salarié. Le segment est pris en charge dans le mode de requête standard.

Ce nouveau segment a été introduit pour fournir un moyen plus compréhensible d'utiliser les informations d'identité. Les valeurs renvoyées maintenant sont toujours extraites du compte utilisateur, indépendamment du nombre d'emplois. En outre, les modifications apportées au compte utilisateur peuvent déclencher une réplication, ce qui n'était pas possible dans les versions précédentes.

Dans la version actuelle, vous pouvez obtenir le segment Informations sur l'identité dans la requête Compound Employee API.

Exemple de code

Code Snippet
1234567891011121314151617181920212223
<queryResponse> <result> <sfobject> <id>1234</id> <type>CompoundEmployee</type> <person> <created_by>HRAdmin</created_by> <created_on_timestamp>2016-01-01T00:00:00.000Z</created_on_timestamp> <last_modified_by>HRAdmin</last_modified_by> <last_modified_on>2016-01-01T00:00:00.000Z</last_modified_on> <per_person_uuid>E38E63CC36D744A7998753E25B32DDCA</per_person_uuid> <person_id>1234</person_id> <person_id_external>Employee1234</person_id_external> <identity_information> <account_uuid>8d83105f-b27c-b620-e105-00000a746454</account_uuid> <created_on_timestamp>2016-01-01T00:00:00.000Z</created_on_timestamp> <last_modified_on>2016-01-01T00:00:00.000Z</last_modified_on> <user_is_active>true</user_is_active> <user_name>Employee1234</user_name> </identity_information> </person> </sfobject> </queryResponse>

Extension - Nouvelle clé sémantique pour le permis de travail dans Employee Central Compound Employee API

Qu'est-ce que c'est ?

Nous avons ajouté une nouvelle clé sémantique issue_date pour le permis de travail dans Employee Central Compound Employee API. Cette nouvelle clé de gestion vous permet de gérer votre permis de travail avec une date d'émission différente, mais vous pouvez conserver d'autres clés de gestion.

Par exemple, vous pouvez charger un nouveau permis de travail avec le même numéro de document que votre permis de travail expiré, mais avec une date d'émission différente après le renouvellement. Pour le moment, Employee Central Compound Employee API prend en charge le renvoi des derniers résultats des clés de gestion suivantes pour le permis de travail :

  • pays
  • type_document
  • numéro_document
  • user_id
  • émettre_date

Nous avons ajouté cette nouvelle clé sémantique pour fournir un moyen plus compréhensible d'utiliser les informations de permis de travail.

Modifications apportées

Dans la version actuelle, la mise à jour de issue_date d'un enregistrement personal_document_information existant n'est pas affichée en tant qu'action CHANGE mais en tant qu'actions INSERT et DELETE dans les modes de requête Delta et Delta de période. Vous trouverez l'exemple de code ci-dessous.

Code Snippet
123456789101112131415161718192021222324
<personal_documents_information> <action>DELETE</action> <country>USA</country> <created_by>admin</created_by> <created_on_timestamp>2010-06-22T13:14:01.000Z </created_on_timestamp> <document_number>1234567890</document_number> <document_type>PP</document_type> <is_validated>false</is_validated> <issue_date>2010-06-03</issue_date> <last_modified_by>admin</last_modified_by> <last_modified_on>2022-06-23T06:44:59.000Z</last_modified_on> </personal_documents_information> <personal_documents_information> <action>INSERT</action> <country>USA</country> <created_by>admin</created_by> <created_on_timestamp>2010-06-22T13:14:01.000Z </created_on_timestamp> <document_number>1234567890</document_number> <document_type>PP</document_type> <is_validated>false</is_validated> <issue_date>2020-05-23</issue_date> <last_modified_by>admin</last_modified_by> <last_modified_on>2022-06-23T06:44:59.000Z</last_modified_on> </personal_documents_information>

Extension - Nouvelle sélection pour les zones et les segments

Qu'est-ce que c'est ?

Il est désormais possible d'extraire des zones et des segments spécifiques d'une requête d'API employé composite. Nous avons introduit cette fonctionnalité pour permettre aux consommateurs de la requête de l'API Compound Employee d'être conformes aux directives générales du règlement sur la protection des données et de réduire la quantité de données transférées entre les systèmes.

Exemple de code

Code Snippet
123456789101112131415161718192021
<person> <person_id>920</person_id> <address_information> <address_type>home</address_type> <country>DEU</country> <created_by>root</created_by> <created_on_timestamp>2013-07-22T07:20:13.000Z</created_on_timestamp> <end_date>9999-12-31</end_date> <is_global_model_address>false</is_global_model_address> <last_modified_by>root</last_modified_by> <last_modified_on>2022-01-22T07:20:13.000Z</last_modified_on> <start_date>2022-01-01</start_date> </address_information> </person>

Extension - Filtre permanent ajouté au type de document Admissibilité au travail

Qu'est-ce que c'est ?

Le segment d’informations sur les documents personnels prend uniquement en charge l’admissibilité au travail dans Employee Central Compound Employee API. En raison de l’obsolescence des anciennes entités (citoyenneté et visa), ces types d’entité devaient être filtrés pour afficher uniquement l’admissibilité au travail de l’entité et ses détails. Pour en savoir plus, voir Suppression des types d'importation de l'importation des données employés dans le visualiseur des nouveautés de SAP SuccessFactors.

Exemple de code

Code Snippet
1234567891011121314151617
<personal_documents_information> <attachment_id>863</attachment_id> <created_by>admin</created_by> <created_on_timestamp>2022-09-03T08:33:02.000Z</created_on_timestamp> <document_number>123-abc-456</document_number> <document_title>Work Eligibility document</document_title> <is_validated>false</is_validated> <issue_date>2022-09-03</issue_date> <last_modified_by>admin</last_modified_by> <last_modified_on>2022-09-03T08:33:46.000Z</last_modified_on> </personal_documents_information>

Amélioration - Nouvelle condition de clause Where Date de début/fin pour Employee Central Compound Employee API

Qu'est-ce que c'est ?

Nous avons introduit la condition de clause WHERE fromDate/toDate dans l'API Compound Employee dans le mode de requête standard.

Nous avons ajouté cette condition pour faciliter la sélection des salariés dont les modifications entrent en vigueur au cours de la période donnée dans le mode de requête standard.

Exemple de code

Code Snippet
123
FROM CompoundEmployee WHERE fromDate = to_date(FromDate,'YYYY-MM-DD') AND toDate = to_date(ToDate,'YYYY-MM-DD')

Extension - Nouveau segment de comptes sociaux dans l'API de salarié composite

Qu'est-ce que c'est ?

Nous avons introduit le segment social_accounts_information dans Employee Central Compound Employee API.

Le segment des comptes sociaux est spécifique à la personne.

Code Snippet
12345678910111213141516171819202122232425262728293031
<queryResponse> <result> <sfobject> <id>123</id> <type>CompoundEmployee</type> <person> ... <social_accounts_information> <created_by>admin</created_by> <created_on_timestamp>2024-05-10T21:31:10.000Z</created_on_timestamp> <domain>instant_messenger</domain> <im_id>messengerUserId</im_id> <last_modified_by>admin</last_modified_by> <last_modified_on>2024-06-20T14:45:57.000Z</last_modified_on> <url>www.example_instant_messenger.com</url> </social_accounts_information> ... </person>

Extension - Filtrage des contrats de travail résiliés à partir de la réplication des données des employés

Qu'est-ce que c'est ?

La réplication des données d'employés depuis Employee Central utilise désormais le filtre EMPLOYMENT_END_DATE dans la clause WHERE de Compound Employee API pour empêcher la réplication des contrats de travail résiliés dans SAP S/4HANA ou SAP ERP HCM.

La date de fin d'activité est définie sur la date de début de transmission complète (FTSD) que vous avez définie pour la réplication des données d'employés depuis Employee Central. Cela signifie que seules les activités qui ont été actives depuis au moins un jour ou après la FTSD sont répliquées dans SAP S/4HANA ou SAP ERP HCM par défaut. Si vous voulez répliquer des activités qui ont été interrompues avant la FTSD, vous avez la possibilité de désactiver le filtre EMPLOYMENT_END_DATE. Cependant, nous vous recommandons de ne le faire que dans des cas particuliers. Par exemple, lorsque des problèmes surviennent dans votre système SAP S/4HANA ou SAP ERP HCM parce que le système a également besoin d'activités qui ont été interrompues avant la FTSD.

En introduisant le filtre, les données utiles transférées depuis Employee Central sont réduites, ce qui améliore les performances de la réplication.

Exemple de code

Code Snippet
12345678910111213141516171819202122232425
<queryCompoundEmployeeResponse> <CompoundEmployee> <id>278718</id> <person> ... <employment_information> <end_date>2013-08-31</end_date> <start_date>2012-01-01</start_date> </employment_information> <employment_information> <start_date>2015-01-01</start_date> </employment_information> ... </person> </CompoundEmployee> </queryCompoundEmployeeResponse>

Extension - Synthèse des statuts de nettoyage pour le nettoyage des données est désormais l'option par défaut dans l'add-on PA_SE_IN

Qu'est-ce que c'est ?

Nous utilisons désormais les informations de synthèse du statut de purge fournies par l’API d’employé composite comme option par défaut lorsque le système SAP S/4HANA ou SAP ERP HCM interroge les données de l’employé qui ont été purgées dans Employee Central.

Si vous devez utiliser la validation par rapport au filtre de date de fin de validité fourni par l'API d'employé composite au lieu de la synthèse des statuts de purge, vous pouvez définir un paramètre dans le système SAP S/4HANA ou SAP ERP HCM pour désactiver l'utilisation de la synthèse des statuts de nettoyage.

L'utilisation du segment DRTMPurgeStatusOverview de Compound Employee API permet au système SAP S/4HANA ou SAP ERP HCM de valider les dates de nettoyage détaillées et de réagir en conséquence. Vous n'avez pas besoin d'ajuster la date de début de transmission complète (FTSD) définie pour la réplication des données de base des employés afin d'éviter les erreurs.

Exigences de configuration

Le Support Package 38 de l'add-on SFSF EC INTEGRATION (PA_SE_IN) doit être installé dans votre système SAP S/4HANA ou SAP ERP.

Conditions préalables aux autorisations basées sur les rôles

Si vous accordez à l'utilisateur Compound Employee API un accès uniquement à des segments définis, vous devez ajouter l'autorisation pour le segment DRTMPurgeStatusOverview.

Modifications apportées

Interface d'options SAP pour données de base EE affichant l'option de paramètre de requête Aucune synthèse des statuts de nettoyage.

À quoi cela ressemble maintenant ?

Dans la version actuelle, le système SAP S/4HANA ou SAP ERP utilise la synthèse des statuts de nettoyage par défaut. Si nécessaire, vous pouvez vous désinscrire. Lors de la définition des paramètres pour la requête de données de base d’employés et d’affectation organisationnelle, vous pouvez cocher la case Ne pas utiliser la synthèse des statuts de suppression définitive pour activer la validation par rapport au filtre de date de fin de validité fourni par l’API d’employé composite.