Study guide

11.3 Localizing the SailPoint UI

SailPoint Certified IdentityIQ Engineer Exam

Track your progress as you read

Finished sections get a check mark.

1 Chapter 1: The IdentityIQ Engineer Exam

1.1 Exam Format, Official Blueprint, and Study Strategy

2 Chapter 2: Infrastructure, Installation, and Extended Attributes

2.1 IdentityIQ Infrastructure Components 2.2 Installation Steps and Procedures 2.3 Creating Extended Attributes and the Objects That Support Them

3 Chapter 3: Build, Deployment, Patching, Access, and Email

3.1 Ongoing Build and Deployment 3.2 Installing Patches and Performing Upgrades 3.3 Configuring End-User Access 3.4 Email Server Settings and Email Redirection

4 Chapter 4: Lifecycle Manager Configuration, Provisioning Policies, and Workflows

4.1 Configuring Lifecycle Manager 4.2 Identity Provisioning Policies 4.3 Configuring LCM Workflows

5 Chapter 5: Lifecycle Events, QuickLinks, Batch Requests, and Rapid Setup

5.1 Lifecycle Events and Their Workflows 5.2 QuickLinks and QuickLink Populations 5.3 Configuring and Using Batch Requests 5.4 Rapid Setup in Lifecycle Events and Identity Operations

6 Chapter 6: Certification Campaigns and Certification Rules

6.1 Configuring and Scheduling Certification Campaigns 6.2 The Purpose of Common Certification Rules

7 Chapter 7: Policies and Policy Violations

7.1 Configuring and Leveraging Policies 7.2 Responding to Policy Violations

8 Chapter 8: Reporting, Advanced Analytics, and Auditing

8.1 Executing and Leveraging Reports 8.2 Leveraging Advanced Analytics 8.3 Configuring and Using Auditing

9 Chapter 9: Rules, Rule Libraries, and the SailPoint API

9.1 The Purpose and Use of Rule Libraries 9.2 Rule Input and Output Arguments 9.3 Common SailPoint API Objects and Methods

10 Chapter 10: Workflow Development

10.1 Workflow Variables, Transitions, and Step Conditions 10.2 Workflow Steps That Generate Work Items 10.3 The Different Workflow Step Usages 10.4 Leveraging Sub-Workflows

11 Chapter 11: Email Templates, Branding, and Localization

11.1 Customizing and Using Email Templates 11.2 Branding the SailPoint User Interface 11.3 Localizing the SailPoint UI

12 Chapter 12: Application Definitions, Connector Settings, and Rapid Setup Aggregation

12.1 Configuring Application Definitions 12.2 Configuring Common Connector Settings 12.3 Configuring Rapid Setup Aggregation Settings

13 Chapter 13: Data-Loading Tasks and Application and Connector Rules

13.1 Scheduling Tasks for Data Loading and Processing 13.2 Common Application Rule Types 13.3 Common Connector Rule Types

14 Chapter 14: Debugging with log4j, Syslog, and the IdentityIQ Console

14.1 Configuring and Leveraging log4j 14.2 Configuring and Leveraging Syslog 14.3 Leveraging the IdentityIQ Console for Debugging

15 Chapter 15: Debug Pages and the Administrator Console

15.1 Leveraging the Debug Pages for Debugging 15.2 Leveraging the Administrator Console for Debugging

16 Chapter 16: Role Model and Identity Attribute Mappings

16.1 Default Role Models and Role Types 16.2 Configuring Roles and Role Options 16.3 Configuring Identity Attribute Mappings

17 Chapter 17: Data Objects, Relationships, and Group Types

17.1 Common IdentityIQ Data Objects 17.2 Relationships Between Common Data Object Models 17.3 The Difference Between Group Types

11.3 Localizing the SailPoint UI

Key Takeaways Explain This Topic AI

Product messages are Java properties catalogs (iiqMessages and its language variants inside identityiq.jar); customers override them in WEB-INF/classes/sailpoint/web/messages/iiqCustom.properties.

Language-specific overrides go in files such as iiqCustom_fr.properties, and the user's browser language decides which one is shown.

Multi-language descriptions for applications, roles, policies, and entitlements are enabled on the Miscellaneous tab with a default and supported languages, which must also be in faces-config.xml.

Forms, report columns, and email templates can use message keys, and spTools.getMessage(key) localizes text in email.

The importManagedAttributes console command can load localized entitlement descriptions from a CSV whose columns are named after locales.

Last updated: September 2026

Localizing the SailPoint UI

Objective 4.10 asks you to perform localization in the SailPoint UI for common customer use cases . The usual cases are changing product wording, translating labels for non-English users, showing application, role, and entitlement descriptions in several languages, and localizing custom forms, reports, and emails.

How IdentityIQ Chooses Text

IdentityIQ UI text comes from message catalogs : Java .properties files of key=value pairs. The user's browser language decides which language catalog is used. For multi-language descriptions, the description shown depends on the browser language, falling back to the configured default.

Product catalogs ship inside WEB-INF/lib/identityiq.jar , in sailpoint/web/messages/iiqMessages.properties and language variants such as iiqMessages_it.properties .

The customer override catalog is WEB-INF/classes/sailpoint/web/messages/iiqCustom.properties . It is empty by default. A key placed here overrides the product value , and you never edit the jar.

Common Use Case 1: Change or Translate a Label

Find the message key. Search the product catalogs extracted from identityiq.jar , or inspect the page.

Add the key with your text to iiqCustom.properties for the default language.

For another language, create a language-suffixed file such as iiqCustom_fr.properties or iiqCustom_de.properties , or a locale-specific one such as _fr_CA .

Deploy with the build and restart, then test in a browser set to that language. # iiqCustom.properties (this key is the alt text of the header logo)

  • ui_sailpoint_logo=ACME Access Portal
  • # iiqCustom_fr.properties
  • ui_sailpoint_logo=Portail d'accès ACME

Keep these files in the build (SSB web or config layout), because upgrades replace the installation directory.

Common Use Case 2: Multi-Language Object Descriptions

Business users see application, role, policy, and entitlement descriptions throughout LCM and certifications. To localize them:

On Global Settings > IdentityIQ Configuration > Miscellaneous , under Localized Object Attributes , enable multi-language descriptions for applications , roles , policies , and/or entitlements .

Under Multi-Languages Descriptions , choose the Default Language and list the Supported Languages .

Add every supported language to the <locale-configure> section of faces-config.xml . The documentation says the application will not recognize the languages otherwise.

Enter descriptions per language with the language selector on each object's page. Save each language before switching to the next.

Policy descriptions can be localized, but policy rule descriptions cannot.

Bulk-Loading Entitlement Descriptions

The console command importManagedAttributes loads a CSV. The first line is a comment naming the columns, which can include locale columns such as en_US or fr_FR holding the description for that language. Later comment lines can set defaults such as application=AD . Required values are type (default Entitlement), application, attribute, and value. # value, displayName, en_US, fr_FR

  • # application=AD
  • # attribute=memberOf
  • CN=Finance,OU=Groups,DC=acme,DC=com, Finance, Finance department share, Partage du service Finance

Watch the HTML rules for descriptions. Certain escaped characters must be written correctly, such as &lt; and &quot; , or they will not display.

Common Use Case 3: Custom Forms, Reports, and Emails

Forms: field labels ( displayName ) and help text ( helpKey ) can be message keys , so the same form renders in each user's language.

Reports: report form labels and ReportColumnConfig headers are evaluated first as message keys (for example, rept_uncorrelated_ids_grid_username ). If no key matches, the literal text is used. Render scripts can call Message.localize(key) .

Email templates: call $spTools.getMessage("key") for catalog text, and $spTools.formatDate(...) for locale-formatted dates.

Server-side code: use the Message object's localize method with a catalog key.

Security questions on the User Reset tab can be message keys from the properties file, which is how the questions are internationalized.

Common Use Case 4: Plugins

A plugin carries its own catalogs in its messages folder, one per language, for example TrainingPlugin_fr_ca.properties . Prefix plugin keys with the plugin name to avoid collisions with product keys or other plugins. Full-page plugins translate with the msgs function, and widgets use the spTranslate filter from the SailPoint Angular bundle.

Planning a Multilingual Rollout

Localization is easiest when planned before content is written:

Decide the language list early , and configure it both in the Miscellaneous tab and in faces-config.xml .

Use message keys in custom artifacts (forms, reports, and plugin pages) from the start, rather than hard-coded English, so later translation is a properties-file task.

Translate the business data too. A French user who sees French buttons but English entitlement descriptions still cannot make a good certification decision. Load descriptions with importManagedAttributes or the per-object language selector.

Remember email. Notification text comes from templates. Use spTools.getMessage keys or separate templates per audience where needed.

Checklist and Traps

Symptom Likely cause

French users still see English labels No iiqCustom_fr.properties override, the browser is not set to French, or the server was not restarted after deployment

The language selector for descriptions is missing Multi-language descriptions are not enabled for that object type

  • A supported language is ignored It was not added to <locale-configure> in faces-config.xml
  • Custom translations vanished after an upgrade The files were not kept in the build