Changing or translating portlet help

Prerequisites

What you have to do first:

1. Go to Provisioning.

2. Under Company Settings, make sure that Hide Employee Central V2 Help Link is unchecked. Only then are the help icons displayed on the portlets and pages.

Note

Make sure generic objects are enabled. For more information, see How do you configure and manage generic objects?

Context

The Employee Central portlets and pages contain end-user help you can call up by clicking the question mark icon, as in this example:

The help content delivered as standard is in US English only and hard-coded. You can configure the system so that the help content can be translated or changed by the customer, for example, to include customer-specific terminology. This is a three-step process:

1. Define for which languages the customer can add help content.

2. Enable text formatting in a rich-text editor by creating a configuration UI for the help content.

3. Define for which portlet or page help content can be added by creating instances for the ECHelp object, and add help content in one or more languages.

What you have to consider

If you create your own content help (even if you create it just for one portlet), the system does no longer show the help content delivered by SuccessFactors for any of the other portlets.

The system retrieves the locale-specific contents from the object definition you have configured based on the logged-in user’s locale and the portlet IDs. On the UI, this HTML content is displayed in a separate window. If there is no help content available for a locale for a portlet, the question mark icon (“?”) for calling up help content is not shown for that portlet. If the system cannot retrieve customer-defined help content for any portlet, the help content delivered as standard, with US English (en_US) as the default, is displayed.

Procedure

Here’s how you change or translate help content:

1. Define for which languages the customer can add help content by defining the locales:

a. Go to Administration Tools.

b. In the Company Processes & Cycles portlet, select Company Settings Configure Object Definitions . c. Select Create New: Picklist, and enter the code locale.

d. As Display Order, select Alphabetical.

e. Enter a name and select an effective start date.

f. Add the locales under Values, as in this example:

1. You have to create the locale for US English (en_US).

This is required as it is the default locale for help content.

2. To allow translation of help content into other languages, add the locales of those languages as in this example:

The external codes of the picklist values for the locales have to be in this format: en_US for US English, fr_FR for French, and so on. Locale picklist values are a subset of the locales supported by

Employee Central, which you can find in Provisioning (under Company Settings Language Packs :

g. Save your changes.

2. To create the configuration UI for the help content:

a. Go to Administration Tools.

b. In the Company Processes & Cycles portlet, select Employee Files Manage Configuration UI . c. Click Create New.

d. Enter an ID.

e. Under Select Base Object, select ECHelp.

f. In the locales section, mouse over the content field, and click the Edit Properties icon next to this field as shown here:

g. In the Display As field, select Large Input Field (Multi-Line).

A new field called RTE Field is displayed.

h. In the RTE Field, select Yes.

i. Save your changes.

3. To define for which portlet or page help content can be added, create instances for the ECHelp object, and add the help content in one or more languages:

a. Go to Administration Tools.

b. In the Company Processes & Cycles portlet, select Employee Files Manage Data .

The Manage Data page is loaded with this URL (the beginning of the URL might differ depending on the system you are using):

https://salesdemo4.successfactors.com/xi/ui/genericobject/pages/mdf/mdf.xhtml c. Add #v:1 to the end of the above URL so it reads this: https://

salesdemo4.successfactors.com/xi/ui/genericobject/pages/mdf/mdf.xhtml#v:1 An additional selection field is displayed.

d. If required, reload the above page.

e. In the Search field, you have to do the following:

1. In the first drop-down menu, select the base object ECHelp.

2. In the second drop-down menu, select the configuration UI object you created before.

f. To define for which portlets and pages you can add help content, select Create New: ECHelp.

g. As externalCode, enter the ID of the portlet or page for which you want to create help content.

Here’s a list of the portlets for which you can add portlet help:

Table 25:

Use this Portlet ID: ...for this portlet:

PERSON_INFORMATION Personal Information

CONTACT_INFORMATION Contact Information portlet, including Email, Phone and Social Accounts Information

EMPLOYMENT_ID_INFORMATION Employee Information portlet on the Add New Employee page

ASSIGNMENT_INFO Global Assignment Details

PENSION_PAYOUTS_INFO Pension Payout Details

PLAN_LOA Plan Leave of Absence

Use this Portlet ID: ...for this portlet:

TERMINATE Termination portlet on the Update Employee Records

page

IT_DECLARATION_INFO Income Tax Declaration

RECURRING_DEDUCTION Recurring Deductions

ONETIME_DEDUCTION One Time Deduction

ELIGIBLE_BENEFITS Benefit Eligibility

BENEFIT_ENROLLMENTS Benefit Enrollment

BENEFIT_CLAIMS Benefit Claims

Here’s a list of the pages for which you can create page-level help:

Table 26:

Use this Page ID: ...for this page:

newHirePage Add New Employee

mssPage Update Employee Records

essPage Personal Information

empInfoPage Employment Information

h. As externalName, enter a name for the portlet or page help.

i. In the locales section, you have to do the following:

1. Select the external code for the language in which you want to enter help content. For example:

en_US.

2. Enter an external name for the language, for example: US English.

3. In the content field, enter the help content that should be displayed to the end user in the rich-text editor.

Here’s an example:

4. Repeat these steps for all languages required.

j. Save your changes.

k. Repeat these steps for all portlets or pages for which you want to add help content.