Understanding Appendix

Find all new features and enhancements for the release in the What's New Viewer on the SAP Help portal.

If you want more details on a topic, proceed as follows:

1. Navigate to the SAP Help portal and in the Search all drop-down list, enter SAP SuccessFactors Release Information.
2. From the drop-down list to the right of the SAP SuccessFactors Release Information title, select the appropriate release.
3. Select What’s New Viewer.
4. Select the filters as required to view the topic.
5. If the topic contains more information, select See more.
6. Under the Related Information section, locate further details on the topic.

Enhancements have been made when you’re downloading templates on the "Import Employee Data" page. These includes ability to view field labels that instead of field IDs, alphabetical ordering and capability to download a specific Country’s template.

These enhancements greatly improve usability. Since you can view field labels that have been configured in the data model, instead of field IDs, it helps you to easily search for a particular data field. These are also sorted in alphabetical order to improve ease of use. Additionally, you can now download a template specific to a country from the newly introduced "Select a Country" dropdown.

None

This enhancement provides support for attachment-id in EmpTermination import. While importing terminationInfo for users, import will accept valid attachment-ids.

With this release, Admins can now upload attachments while importing the Termination Details entity. This can be achieved by specifying attachment-id of the document in the CSV import file.

None

The Compound Employee API provides a new parameter, "segmentsForEnhancedEffectiveEndDateFilter". Use this parameter if you include the "effective_end_date" parameter in the query request and want the API to return multiple events carried out for the "Job Information" and "Compensation Information" segments on the same day.

Previously, if multiple events were carried out in Employee Central on the same day and the effective end date was after that day, only the latest event was returned by the API because only this event has a time slice that overlaps with "effective_end_date". By setting the "segmentsForEnhancedEffectiveEndDateFilter" parameter you can ensure that the downstream system stores all events and can react to them accordingly. The parameter is supported in the full transmission and the snapshot modes of the API. Using it requires that you specify either "allJobChangesPerDay" or "allCompensationChangesPerDay" for the "resultOptions" parameter.

Use parameter "segmentsForEnhancedEffectiveEndDateFilter" in Compound Employee API query

The Compound Employee API provides a new parameter, hiringNotCompleted. This parameter evaluates the indicator property hiringNotCompleted in the EmpEmployment entity in Employee Central, which allows for differentiating data records of onboardees that did not yet complete the Manage Pending Hire process. If hiringNotCompleted is False, the API returns only data of hired employees

This is useful if you want your downstream systems to receive only data that has been validated against the employee data model. hiringNotCompleted is supported in all API modes.

Use the filter hiringNotCompleted in your Compound Employee API query.

The CompoundEmployee API provides the new query parameter suppressUnwantedGlobalInfo for filtering out Global Information based on country/region.

The filtering applies to the following segments:

• personal_information
• dependent_information(dependent_personal_information)
• national_id_card

Use the suppressUnwantedGlobalInfo parameter to filter out Global Information within Personal Information from SAP SuccessFactors Employee Central based on the country/region specified in the WHERE clause of the query. The country/region is specified with the employment_information_country or the employment_information_company parameter in the WHERE clause.

Filtering out global information is only supported in the standard query mode of the CompoundEmployee API.

The Compound Employee API now renders all employments for a manager (segment name associated_employee_employment_information) under one segment for each manager (segment name associated_employee_information).

The change aligns the behavior in standard mode with an already applied fix in delta mode to avoid duplicate key errors. This is only relevant for cases where an employee has multiple relationships to different employments with the same manager.

In the previous version, each associated_employee_employment_information segment was rendered in it’s own duplicated associated_employee_information segment.

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>

Queries that pull data from the last_modified_on or snapshot_date fields of the Employee Central CompoundEmployee API are now restricted to a maximum of 3 months in the past in preview AND productive instances.

NOTE that this restriction now impacts your productive environment as of the 2H 2021 release.

This improvement increases the performance and enables faster synchronization between Employee Central and target systems.

You need to adjust the fields according to your existing configuration.

This new permission allows access only to individual segments based on the configuration set up.Earlier, it was not possible to restrict users' access to specific segments of the Compound Employee API Permissions. Now, users can restrict access for particular segments through Role-Based Permissions.

You have the Administrator→Manage Permission Roles permission.

The Employee Central Compound Employee API now supports a new segment called Identity Information.

Customers can now use this segment to replicate certain fields from the user account information of an employee. The segment is supported in the standard query mode.

This new segment was introduced to provide a more comprehensible way to consume identity information. The values that are returned now are always retrieved from the user account independent of the number of employments. Additionally, changes in the user account can trigger a replication, which wasn't possible in previous versions.

In the current version, you can get the Identity Information segment in the Compound Employee API query.

Sample Code

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>

We added a new semantic key issue_date for work permit in Employee Central Compound Employee API.With this new business key added, you can manage your work permit with a different issue date, but keep other business keys the same.

For example, you can upload a new work permit with the identical document number as your expired work permit, but with a different issue date after renewed. For now, Employee Central Compound Employee API supports returning the latest results of the following business keys for work permit:

• country
• document_type
• document_number
• user_id
• issue_date

We added this new semantic key to provide a more comprehensible way to consume work permit information.

In the current version, updating the issue_date of an existing personal_document_information record is not rendered as a CHANGE action but as INSERT and DELETE actions in the query modes Delta and Period Delta. You can find the sample code as below.

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>

It is now possible to extract specific fields and segments from a Compound Employee API query. We introduced this feature to enable consumers of the Compound Employee API query to be compliant with General Data Protection Regulation guidelines and so that the data amount transferred between systems can be reduced.

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>

The personal documents information segment only supports work eligibility in the Employee Central Compound Employee API. Due to the deprecation of legacy entities - citizenship and visa, those entity types had to be filtered to only display the entity work eligibility and its details. For more information, please refer to Deletion of Import Types from Import Employee Data in the SAP SuccessFactors What's New Viewer.

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>

We introduced the fromDate/toDate WHERE clause condition to the Compound Employee API in the standard query mode.

We added this condition to increase the ease of selecting employees who have changes that become effective in the given time period in the standard query mode.

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

We introduced the social_accounts_information segment to the Employee Central Compound Employee API.

The social accounts segment is person-specific.

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>

Replication of employee data from Employee Central now uses the EMPLOYMENT_END_DATE filter in the WHERE clause of the Compound Employee API to prevent terminated employments from being replicated to SAP S/4HANA or SAP ERP HCM.

The employment end date is set to be on the full transmission start date (FTSD) that you've defined for employee data replication from Employee Central. This means, only employments that have been active for at least one day on or after the FTSD get replicated to SAP S/4HANA or SAP ERP HCM by default. If you want to replicate employments that were terminated before the FTSD, you have the option to turn off the EMPLOYMENT_END_DATE filter. But we recommend you only do this in special cases. For example, when problems occur in your SAP S/4HANA or SAP ERP HCM system because the system also needs employments that were terminated before the FTSD.

By introducing the filter, the payload transferred from Employee Central is reduced, which improves the performance of the replication.

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>

We now use the purge status overview information provided by the Compound Employee API as the default option when the SAP S/4HANA or SAP ERP HCM system queries employee data that has been purged in Employee Central.

If you need to use the validation against the effective end date filter provided by the Compound Employee API instead of the purge status overview, you can set a parameter in the SAP S/4HANA or SAP ERP HCM system to disable the use of the purge status overview.

Using the DRTMPurgeStatusOverview segment of the Compound Employee API enables the SAP S/4HANA or SAP ERP HCM system to validate detailed purge dates and react accordingly. You don't need to adjust the full transmission start date (FTSD) defined for the replication of employee master data to prevent errors.

Support package 38 of the SFSF EC INTEGRATION (PA_SE_IN) add-on must be installed in your SAP S/4HANA or SAP ERP system.

If you grant the Compound Employee API user access only to defined segments, you must add the permission for the DRTMPurgeStatusOverview segment.

How It Looks Now

In the current version, the SAP S/4HANA or SAP ERP system uses the purge status overview by default. If you need to, you can opt out of it. When defining the parameters for the employee master data and organizational assignment query, you can select the Do Not Use Purge Status Overview checkbox to enable the validation against the effective end date filter provided by the Compound Employee API.