SAP Knowledge Base Article - Public

3018802 - Using API Option Profile ID in Integration Center to Insert / Update / Upsert User data

Symptom

Background

Last 2H2020 SFSF Integration Center was updated with new option, API option Profile ID is available to be used for inbound integrations.


API Option Profile Id is a custom option supported by the API for the User Entity. It helps creates a profile with various options that can be enabled such as “Send welcome email to new users”, “Process inactive employees”. and so on. This option can now be used while performing an insert/upsert into SFSF from Integration Center.

Permissions Required :

  • Access to Integration Center permission must be granted.
  • Access to API Option Profile permission must be granted.

Prerequisite Configuration :

  • API Option Profile ID with appropriate options enabled must be created using Manage API Option Profile.

"Image/data in this KBA is from SAP internal systems, sample data, or demo systems. Any resemblance to real data is purely coincidental."

Environment

  • SAP Successfactors HXM Suite
    • Integration Center

Resolution

Use Case : Send Welcome Message




  1. Create CSV file for Import
  2. Create API Option Profile in ‘Manage API Option Profile’ and tick on’Send welcome email to new users’
  3. Creating the Integration Center
    1. Select ‘Scheduled CSV Input Integration’ and In Configure Fields after Mapping the required Input fields. Put your ‘API Option Profile ID’ created in step 2, in ‘Destination fields’ > ‘API Option Profile ID’. See below
    2. You can test by going to Configure fields and selecting 'Run Preview Records'. It should show as ‘check’ in the result status column to confirm the Upsert Test was successful.
      • To test fully (E2E), store your test csv in an SFTP, afterwards 'Schedule and Save' then 'Run' the Integration Center Job.
  4. Check the recipient email and see Welcome email of the Newly created User.


See Also

Keywords

apiOptionProfileID, Manage API Option Profile, Profile Id, Send welcome email to new users, User Entity Odata API Custom Option Parameter. Process Inactive Employee, ProcessInactiveEmployee , KBA , LOD-SF-INT-INC , Integration Center , LOD-SF-INT , Integrations , How To

Product

SAP SuccessFactors HXM Suite all versions

Attachments

Pasted image.png
Pasted image.png
Pasted image.png
Pasted image.png
Pasted image.png
Pasted image.png
Pasted image.png
Pasted image.png
Pasted image.png
Pasted image.png
Pasted image.png
Pasted image.png
Pasted image.png
Pasted image.png
Pasted image.png