Enabling and customizing language localization for SMS authentication in PingID
If SMS is selected as an alternate authentication method, enable localization and customization of the SMS message a user receives.
Language localization applies to both registration and authentication. The language is defined by the language settings of the web browser on the device from which the user initiated the authentication or registration request. For a list of supported languages, see PingOne for Enterprise language support.
|
When localizing or customizing the SMS messages:
-
You can enable localization only using predefined messages for all supported languages. For more information, see Enabling language localization for SMS authentication.
-
You can use the basic online SMS message editor. For more information, see Managing online customization of the SMS authentication message.
-
You can use offline editing for multiple-language SMS messages with language inclusion and exclusion. For more information, see Managing offline customization of the SMS authentication message.
Enabling language localization for SMS authentication
Enable localization to ensure that SMS messages on a user’s device will appear in the language set for the device browser.
About this task
If the language used in the browser is not one of the supported languages, the default language of English is used.
Steps
-
Sign on to the admin console.
-
In the PingID admin portal, go to Setup → PingID → Configuration.
-
In the Authentication section, go to Alternate Authentication Methods.
-
In the Enable column, ensure that SMS is selected.
Result:
The Local Language For SMS section is displayed.
-
To enable language localization, click Enable.
-
Click Save.
Managing online customization of the SMS authentication message
You can customize the SMS authentication message in the PingID admin portal.
Steps
-
Follow steps 1-5 of Enabling language localization for SMS authentication.
Result:
The Local Language For SMS section expands.
-
In the Content field, configure the SMS authentication message, or accept the default.
The editor will display an error message if the one-time passcode (OTP) system variable is missing. The variable must be surrounded curly braces and can be upper or lower case, such as
${OTP}
.To revert back to the default message, click Reset.
-
Click Save.
Next steps
To customize additional languages, click the Language icon, and then select a language from the list.
Edit the SMS message as described previously, and then click Save.
If your locale does not allow you to type in the language of choice, you must use the offline method described in Managing offline customization of the SMS authentication message. |
Managing offline customization of the SMS authentication message
Offline customization provides a central place to manage all of your PingID localizations and allows for the inclusion and exclusion of languages.
About this task
To edit language messages outside of your selected language, download the message .zip
file, extract the message files, edit them, rebuild the .zip file, and upload it to the PingID admin portal.
Steps
-
Follow steps 1-5 of Enabling language localization for SMS authentication.
Result:
The Local Language For SMS section expands.
-
Click the Language icon, and then select a language from the list.
-
To start the offline customization procedure, click Edit Localization File.
Result:
The Localization window opens.
-
For first-time customization, click Download Ping Defaults. If you are continuing from an earlier customization, click Download Current File.
Choose from:
-
Download Ping Defaults: You receive a file called
LocalizationsTemplate.zip
. -
Download Current File: You receive a file called
Localizations.zip
.The
LocalizationsTemplate.zip
file contain a properties text file for each supported language.Each of the properties files is a text file with the same layout.
pingid.sms.msg.authentication=Your Ping ID authentication code is: ${OTP} pingid.enrollment.content.description=Great news! Your company is giving you the simplicity of PingID, so you can sign on to all your applications with the added security of a swipe on your mobile device. Enter your email address, and we'll send you a link to download PingID. pingid.non.app.enrollment.text=I want to use a different authentication method.
-
-
Extract the
.zip
file.As a concrete example, we will edit the English file and remove several languages.
-
Open
Localization_en.properties
in a text editor. -
Locate the line commencing with
pingid.sms.msg.authentication=
. -
Change the line to your desired message, such as
pingid.sms.msg.authentication=Here is your Ping ID authentication code: ${OTP}
.There are several rules for editing language properties files and creation of the
.zip
file:-
The OTP variable is in curly braces \{..}
-
Do not edit the other lines because they are used in other parts of the system.
-
You can revert the SMS authentication message to the default for the language by setting
pingid.sms.msg.authentication=
(without a value) or simply deleting the line. -
The
.zip
file must be a flat structure containing only the desired language files, without any folder structures. Attempts to upload invalid.zip
structures returns the error message:File doesn’t contain any valid localizations
. -
Only files with filenames complying with the
Localization_<locale>.properties
naming convention are uploaded. -
Files whose filenames do not comply with the
Localization_<locale>.properties
naming convention are ignored. This permits inclusion of instruction and maintenance files in the.zip
, for examplereadme.txt
. -
Localization files for unsupported locales are ignored.
The localization properties files are shared across several customizations, currently SMS and Enrollment co-branding. For more information, see Customizing the PingID enrollment page (legacy).
-
-
Save the file.
-
To remove several languages, in the directory of properties files, delete all of the files except the following:
-
Pack the remaining properties into a new
.zip
file, and give it a new name, such asLocalizations_<ABC>.zip
The name is unimportant because it is not preserved in the system.
The
.zip
file must be a flat structure containing only localization properties files and without any folder structures.-
Attempts to upload invalid zip structures returns the error message:
File doesn’t contain any valid localizations
. -
Only files with filenames complying with the
Localization_<locale>.properties
naming convention are uploaded. -
Files whose filenames do not comply with the
Localization_<locale>.properties
naming convention are ignored. This permits inclusion of instruction and maintenance files in the.zip
, for examplereadme.txt
. -
Localization files for unsupported locales are ignored.
-
-
Upload your new
Localizations_<ABC>.zip
file. -
In the PingID admin portal, go to the Localization window, and then click Choose File.
-
Select
Localizations_<ABC>.zip
.Result:
You are shown confirmation.
-
Click Save.
Result:
You are asked for final confirmation.
-
To complete the procedure, click Confirm.
-
If there are no language removals, you must click Save to complete the upload.
-
You can return to edit your localizations. In step 2, click Download Current File. The downloaded file is always called
Localizations.zip
. Then proceed from step 3.
-
-
Go to Setup → PingID → Configuration and confirm your edit by checking your SMS message settings.
Offline customization: additional actions
For additional tasks for offline customization of the SMS authentication message, see the following sections.
Restoring a previously removed language
-
In the admin portal, go to the Localizations window.
-
Click Download Current File and extract it.
-
If you do not have the default
.zip
file, click Download Ping Defaults. -
Copy the relevant language properties file from the template to your extracted files directory.
-
Edit the language properties files as required.
-
Rebuild the
.zip
properties file. -
Upload the zipped file.
Reverting to default languages and SMS texts
The following steps use the example in Managing offline customization of the SMS authentication message. |
-
In the admin portal, go to the Localizations window.
-
Under Choose File, click Remove.
The proposed action is summarized.
-
Click Save.
A confirmation window opens.
-
Click Confirm.
All languages become available with their default SMS messages.