SAP Knowledge Base Article - Public

2262228 - How to Add a Field or Data Key in the Onboarding Data Dictionary


  • Field or Key not available for Reporting or Notification
  • How to add a key in the Data Dictionary. 
  • Key needs to be added in the Onboarding side. 


SAP SuccessFactors Onboarding 1.0


Creating or Editing a New Field (Data Key)

When editing a field, you will run across the following possible configurations:

Property Description Example
Name Database key (unique ID); no spaces Custom_Key
Label What end-users see during the Onboarding process First Name

The type of field, see below for the available selection

  • String
  • DateTime
  • Date
  • Time
  • Number
  • Lookup
  • User
  • SAP SuccessFactors HCM Picklist
Required Whether or not this field is required for data entry Check/Uncheck
Repeating Field Field that repeats itself with different information such as Dependent or Emergency Contact info Check/Uncheck

Once you create a new field in the Data Dictionary, it is stored but not used. Some extra steps are involved when using a field in the Data Dictionary for the purposes of collecting or mapping data.

For example, you want to integrate a new Veteran Status field from Recruiting Management (ATS) to the same field on one of the Onboarding panels. You create the new Veteran Status field in the Data Dictionary; the next step would be to ensure that it is in the correct entity. In this case, Veteran Status information is most typically gathered in the application. You will have to ensure that Veteran Status is now in the Entities > ApplicationInfo tag for the mapping to work.

Steps to Add New Fields to Data Dictionary

  1. Navigate to SAP SuccessFactors Onboarding > Settings > Data Dictionary
  2. Click New Field to Add a Data Key
  3. Enter the property such as Name, Label, Description, and Type
  4. Click OK to complete action

SAPSUPPORT-00012 07-02-2019 7.22.07 PM.png

Known Behaviors

When Name is added, label is populated automatically with the same value


SF, ONB, Success Factors, OBD, on boarding
, KBA , LOD-SF-OBD-ADM , Admin Tools, Settings, Permissions , How To


SAP SuccessFactors Onboarding all versions