SAP Knowledge Base Article - Public

2477238 - How to add new Country Specific configuration to Payment Information Detail object

Symptom

This article explains how to configure a Country Specific set of fields for Country which does not have a pre-delivered configuration for the Payment Information feature.

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
  • SAP SuccessFactors Employee Central - Payment Information

Resolution

The configuration is made several steps. Our example scenario is for adding country specific fields for China (where there is no pre-delivered Country Specific object for Payment Information for China), but this could be for any country where a Country Specific configuration is not pre-delivered.

Please note that for adding fields to pre-delivered Country Specific objects for Payment Information, please follow this article instead - 2305691 - Configuration for Country Specific Field in Payment Information UI

 

Configuration Steps

  1. Create a new Country Specific Composite Child object
  2. Add an Association on the Payment Information Detail V3 object to the new Country Specific Child object created in step 1, as a Composite association
  3. Grant permissions to the new Child object
  4. Add the fields to the Payment Information Configuration UI
  5. Create UI rules to show/hide the fields based on Bank Country
  6. Assign the UI rules to triggers
  7. Test the configuration works

 

Create a new Country Specific Composite Child object

  1. Navigate to Admin Center > Configure Object Definitions
  2. Select "Create New" > Object Definition
  3. Configure the Object as such -:
    1. Code = define this as PaymentInformationDetailV3XYZ (XYZ = 3-letter ISO code for the Country) - in our example we used - PaymentInformationDetailV3CHN
    2. Effective Dating = From Parent
    3. API Visibility = Editable
    4. MDF Version History = Complete History
    5. ToDo Category = Generic Object Change Requests
  4. Set the field "externalCode" to be type "Auto Number"
  5. Add the custom fields you wish to have for the country
  6. Security > Set to "Secured" = Yes, and set "Permission Category" = Miscellaneous Permissions
  7. Save the object

CreateObject.jpg

CreateObject2.jpg

 

Add an Association on the Payment Information Detail V3 object

  1. Navigate to Admin Center > Configure Object Definitions
  2. Search for "Object Definition" > PaymentInformationDetailV3
  3. Take Action > Make Correction
  4. Scroll to the Associations section and add a new association with the name "toPaymentInformationDetailV3CHN"
    1. Note - to keep names the same we go with toPaymentInformationDetailV3CHN (for China) but you can give it any name, this part is not important but for simplicity we try to conform to the current naming structure
  5. Set the "Type" to Composite
  6. Save the object

Association1.jpg

 

Grant permissions to the new Child object

  1. Navigate to Admin Center > Manage Permission Roles
  2. Select the Role you wish to grant permissions
  3. Navigate to Miscellaneous Permissions > PaymentInformationDetailV3CHN
  4. Grant all permissions to View, Create, Correct, Insert, Delete (so you can test)
  5. Save the Role

Permissions.jpg

 

Add the fields to the Payment Information Configuration UI

  1. Navigate to Admin Center > Manage Configuration UI
  2. Locate the Payment Information UI you are currently using in your configuration
  3. Mouse-over the Payment Information Details section, and click "Add Field"
  4. Scroll down and find the field, and then move it to where you want it to display in the Payment Information Details section
  5. Then click the Pencil icon to the right of the new field (will appear when you mouse-over the field)
    1. Set "Value Type" to Resolver
    2. Set "
    3. Set "Label Override" to the fields Label
    4. Click OK
  6. Click Save

ConfigUI1.jpg

ConfigUI2.jpg

 

Create UI rules to show/hide the fields based on Bank Country

  1. Navigate to Admin Center > Manage Configuration UI
  2. Locate the Payment Information UI you are currently using in your configuration
  3. Mouse over the portlet label (which is in the top left of the portlet layout) - Payment Information
  4. Click "Manage UI Rules"
  5. Click "Add New Rule"
    1. Rule Name = use the Country name (China in this example)
    2. The rule should be configured with an IF, THEN and ELSE IF conditions.
      1. In the first IF/THEN we tell the rule to show the fields if the Bank Country is equal to China
      2. In the ELSE IF we tell the rule to hide the fields if the Bank Country is not equal to China
    3. Save the rule

UIRule1.jpg

UIRule2.jpg

 

 

Assign the UI rules to triggers

  1. Once the rules have been created in the Configuration UI, you need to add triggers so they will trigger.
  2. First, find the Bank Country field in the UI, and click the Pencil icon next to it. Then in the "onChange UI Rules" section, select the new rule you created > click OK
  3. Then mouse over the UI title (Payment Information" and click "Edit Properties" and add the rule to the following -:
    1. onInitUI Rules
    2. onInsertUI Rules
  4. Click OK
  5. Click "Save" to save the configuration

AssignUIRule0.jpg

 

 

Test the configuration works

  1. Navigate to My Employee Files > Personal Information > Payment Information and validate the new fields only display when the Bank Country is China:

TestSuccessful1.jpg

See Also

2305691 - Configuration for Country Specific Field in Payment Information UI

Keywords

CSF, country-specific, new object , KBA , LOD-SF-EC-PAY , Payment Information (Bank Information) , How To

Product

SAP SuccessFactors Employee Central all versions ; SAP SuccessFactors HCM suite all versions