SAP Knowledge Base Article - Public

2087186 - Localizing using Message Keys - msgKey - Performance Management

Symptom

What is msgKey and how is it used in a localized template?

"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 Performance Management
  • SAP SuccessFactors 360 Multi-Rater

Resolution

A msgKey (Message Key) allows you to define localized labels at the field level on Performance forms and 360 Review templates. Before proceeding, please note the following:

  • Use a unique msgKey value for each chunk of text.
  • Images cannot be implemented in message keys.
  • msgKey configuration in XML is case sensitive
  • When using multiple languages, it is recommended to "localize" your templates by including labels for each field in each language.
  • If you change the msgKey label translation (i.e. "Employee Instructions" to "Employee Directions") but do not change the msgKey in the form template, the translations will update in already-launched in-progress forms but WILL NOT affect completed forms.
  • Only updates made to existing msgkey will take effect for in-progress forms. Newly created msgkey and translations will not reflect on the live forms. New forms need to be launched in order to see the the newly defined content.
  • It is very important to perform thorough testing before launching forms to end users. If there are errors in your configuration, live forms cannot be fixed due to SAP's data protection security policies. You will need to delete and relaunch new forms, or use the forms with the misconfiguration.

360 Reviews:

Performance Management:

To generate the unique message key, follow the steps in Implementing and Managing Performance Management - Localizing Labels.
message key.JPG
 

Updating Importing and Exporting Your Labels

Once the msgKey is in place, the translations are managed from Admin Center, under Manage Form Label Translations. Please refer to Implementing and Managing Performance Management - Managing Form Label Translations.

msgKey for mapto-desc value

We don’t support msgKey attribute with mapto-desc element. To achieve localization, following kind of configuration is needed –

<scale-map-value>
   <score-min>1.0</score-min>
   <score-max>1.49</score-max>
   <mapto-score>1.0</mapto-score>
   <mapto-desc><![CDATA[Insufficient performance]]></mapto-desc>
   <mapto-desc lang="de_DE"><![CDATA[Unzureichende Leistung]]></mapto-desc>
   <mapto-desc lang="en_GB"><![CDATA[Insufficient performance]]></mapto-desc>
   <mapto-desc lang="en_US"><![CDATA[Insufficient performance]]></mapto-desc>
   <mapto-desc lang="es_ES"><![CDATA[Desempeño Insuficiente]]></mapto-desc>
   <mapto-desc lang="fr_FR"><![CDATA[Performance insuffisante]]></mapto-desc>
   <mapto-desc lang="pt_BR"><![CDATA[Desempenho insuficiente]]></mapto-desc>
</scale-map-value>

See Also

Keywords

message keys, form label translation, Manage Form Label Translations, pm, performance, form, template, xml, msgkey, 360, review, multi-rater, customize, support, localize, translate, language, element , KBA , sf languages , LOD-SF-PM-FRM , Forms & Templates , LOD-SF-MTR-FRM , Forms and Templates , How To

Product

SAP SuccessFactors Performance & Goals all versions