2142982 - BULLETIN: Custom Column Localization enhancement and potential impact - Learning

SAP Knowledge Base Article - Public

2142982 - BULLETIN: Custom Column Localization enhancement and potential impact - Learning

Symptom

How to Tell if This Bulletin Applies to You

This bulletin applies to you if you use custom columns in any of the following features:

  • Custom Reports
  • Custom Connectors / extensions to Standard Connectors  
  • Data Services Extracts


If you use custom columns with any of the above, and if you take no action, then after you update to the February 2014 release, your custom column values will appear as label IDs to users.

 

Overview of Custom Column Localization

SuccessFactors Learning recognizes that your organization is global but your users learn best in their own language, so we created a framework for translating learning records. Administrators are familiar with the localization button. For example, if they click the localization button for a Learning Item (course) title, they can translate the title in multiple languages. Users who speak Japanese see the course title in Japanese, English speakers see it in English, and Russian speakers see it in Russian. In the February 2015 update we plan to add that same capability to custom columns.

Environment

  • SuccessFactors Learning Management System (LMS) - All Supported Versions

Resolution

Upgrade Impacts

SuccessFactors Learning recognizes that your organization is global but your users learn best in their own language, so we created a framework for translating learning records. Administrators are familiar with the localization button ( ). For example, if they click the localization button for a Learning Item (course) title, they can translate the title in multiple languages. Users who speak Japanese see the course title in Japanese, English speakers see it in English, and Russian speakers see it in Russian. In February 2015, we plan to add that same capability to custom columns.

 

For example, consider a SuccessFactors Learning customer that uses the default locale of English (EN). This customer has a referenced custom column called "Shirt Size". In November 2014 and earlier, the only possible values for the Shirt Size custom column are Small, Medium, and Large. Starting in February 2015, an administrator can click the localization button ( ) and add (for example) the Spanish text: pequeno, mediano and grande. Like other areas of the localization framework, if a users' language is not yet translated, the system falls back to the system default locale. In this case, the system falls back to English.

 

During the February 2015 upgrade process, the system creates label IDs for each value. In our example the label ID could be something like custom.shirt_size.val1 (this is not representative of the actual syntax). If you do not adjust your custom columns, connectors, data export, and data services, then when your users look at the custom column, they will see custom.shirt_size.val1 and not "Medium" (for example).

 

The following areas of the application are automatically upgraded to use the translated values and will not require customers to make any modifications to their systems:

  • Application user interface
  • System reports
  • Online Report Designer
  • Workforce Analytics metrics pack

 

The following areas of the application are automatically upgraded for the custom column localization, but may require updating outside of the standard upgrade in order to continue to function properly:

  • Custom Connectors / extensions to Standard Connectors
  • Data services extracts

 

Customizations and extensions may also require modifications to upgrade those capabilities.

The next section provides details on how to determine if your system is impacted and how to upgrade your Learning application.

Actions to Take

You need to take action on the impacted areas. Impacted areas are any of the following that use custom columns: custom reports, custom connectors / extensions to standard connectors, and data services extracts.

Custom Reports

For every custom report that displays custom columns you must modify, import, and verify the report.  Otherwise users who run the report will see the label ID instead of the label value.

You can modify the custom report with the Report Designer (recommended), or a text editor.  

Modifying Reports with Report Designer - Recommended

1.  Export the report and open the report in report designer (PRD).

2.  Save a copy as a backup.

3.  Open the original report and double-click on the labels that display custom column label and descriptions.
In this example, LABEL and USER_DESC are the fields that need to be modified. LABEL is a custom column label and USER_DESC is a referenced value.

4.   Replace the expression field with the following for LABEL:
reportContext.getMessage(dataSetRow["LABEL"], reportContext.getLocale())

5.    Repeat the above steps for the field USER_DESC:
reportContext.getMessage(dataSetRow["USER_DESC"], reportContext.getLocale())

picbull.jpg


Modifying the Report with a Text Editor

1.  Open the report in a text editor such as Notepad.

2.  Find and replace text that is used to display the custom column (in this example LABEL and USER_DESC are the fields that need to be modified).

3.  Find: 
dataSetRow["LABEL"]

4.  Replace with: 
reportContext.getMessage(dataSetRow["LABEL"], reportContext.getLocale())

5.  Find: 
dataSetRow["USER_DESC"]

6.  Replace with : 
reportContext.getMessage(dataSetRow["USER_DESC"], reportContext.getLocale())

7.  Verify that the change made looks like following (left side depicts the report before making changes and right side after making changes):

 

 

picbull2.jpg

 

Importing  and Verifying the Report

After modifying the report:

1.  Package each report in a separate .zip file and import it. 

2.  Run the imported report and verify that the report shows the value instead of label ID.

Custom Connectors / Extensions to Standard Connectors

Standard connectors will continue to create referenced custom columns but starting in February 2015, due to localization support, there will be some backend changes made. If you are using our standard connectors that are included with the product out-of-the-box, you do not need to take any action; they will continue to function without any impact.
 

If you have any custom connectors / extensions to Standard Connectors developed for you by our Professional Services organization or partners, you will need to consult with them to evaluate if any changes need to be made in order for the connectors to function properly.

Data services

Starting in February 2015 data services provide a custom column label ID instead of a label for User custom columns. If the service is loading into a data warehouse which is used for reporting, a custom column in a report will display an ID such as label.customcolumn.0123456 instead of the translated value.

 

You need to update the mapping from data services into a data warehouse, or reports extracted from the data warehouse will display the label ID instead of the translated label value.

Product Extensions and Customizations

If you have any of the following features, please contact Professional Services to find out if an update is necessary.

  • Consumer Connector
  • Producer Connector
  • SF-182 customizations
  • Self Enrollment Customizations

Keywords

KBA , LOD-SF-LMS , SuccessFactors Learning , How To

Product

SAP SuccessFactors HCM Core all versions ; SAP SuccessFactors Learning all versions