PingID Administration Guide

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

  1. Follow steps 1-5 of Enabling language localization for SMS authentication.

    Result:

    The Local Language For SMS section expands.

    A screen capture of the Local Language For SMS section. The Enable option is selected. The SMS message content field shows sample text

  2. Click the Language icon, and then select a language from the list.

    A screen capture of the language list. The default is English, shown with a small dot next to it.

  3. To start the offline customization procedure, click Edit Localization File.

    Result:

    The Localization window opens.

    A screen capture of the Localization window. There is a button to Download Ping Defaults for messages that you might need to localize. In the Upload Localization File section, there are buttons to Choose File and Download Current File for language localization.

  4. 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.

      A screen capture of the file list.

      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.

  5. Extract the .zip file.

    As a concrete example, we will edit the English file and remove several languages.

    1. Open Localization_en.properties in a text editor.

    2. Locate the line commencing with pingid.sms.msg.authentication=.

    3. 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 example readme.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).

    4. Save the file.

    5. To remove several languages, in the directory of properties files, delete all of the files except the following:

      A screen capture of the .properties files that must be retained according to your needs.

    6. Pack the remaining properties into a new .zip file, and give it a new name, such as Localizations_<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 example readme.txt.

    • Localization files for unsupported locales are ignored.

  6. Upload your new Localizations_<ABC>.zip file.

  7. In the PingID admin portal, go to the Localization window, and then click Choose File.

  8. Select Localizations_<ABC>.zip.

    Result:

    You are shown confirmation.

    A screen capture of the Localization window, showing the languages updated and removed in the imported file.

  9. Click Save.

    Result:

    You are asked for final confirmation.

    A screen capture of the final confirmation message. The message starts with Important in all caps and the phrase to confirm

  10. 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.

  11. Go to Setup → PingID → Configuration and confirm your edit by checking your SMS message settings.