PingID Administration Guide

Customizing the registration language files

To localize the PingID registration messages in one or more languages, download the localization messaging template, customize the languages that you want to change, and then upload them through the Admin console enrollment configuration workflow.

About this task

When uploading a localization file:

  • Attempting to upload an invalid .zip file structure returns the error message File doesn’t contain any valid localizations.

  • If a localization file does not comply with the Localization_<locale>.properties naming convention, it is ignored.

  • You can include instruction and maintenance files, such as readme.txt, in the .zip file.

  • Localization files for unsupported locales are ignored.

Customizations that you have implemented using the Admin portal Enrollment page are reset to the default text when you customize the localization .zip file. Uploading a localization .zip file updates all languages included in the .zip file. Any languages that are not included in the.zip file are reset to the default text.

For example, if you have an online customization for English messages, and you upload a .zip file that contains only a localization file for Spanish, then only the Spanish messages will be updated according to the uploaded customization. The English messages will revert to the default message text.

Steps

  1. Go to Setup → PingID → Branding → Enrollment.

  2. From the language selector list (A screen capture of the language selector button), select Edit Localization File.

    A screen capture of the language selector list and available language options.

  3. Choose a localization file to download:

    Choose from:

    • Download Ping Defaults: Download a .zip file of the default text templates for each of the supported languages.

    • Download Current File: Download the current version of the localization .zip file for further editing.

      This Download Current Fileoption is not available if the default localization file has not been edited or the PingID localization message settings were restored to the default values.

      A screen capture of the Localization section and localization file download options.

  4. Extract the localization template .zip file that you downloaded.

    The .zip file includes a separate text file for each locale.

  5. For each language file that you want to edit, open the relevant properties file in a text editor and edit the following text content.

    • pingid.enrollment.content.description=<CONTENT message text>

    • pingid.non.app.enrollment.text=<NON-APP ENROLLMENT TEXT link text>

      Errors in the leading pingid.enrollment.content.description…​ and pingid.non.app.enrollment.text…​ strings, or the absence of these leading strings in the localization file, causes the affected message to revert to the default text of its locale.

  6. Create a .zip file including all of the custom localization properties files.

    By default, files are named Localization_<locale>.properties. The .zip file must be a flat structure containing only the desired files, without any folder structures.

    The.zip file must include files for all locales that do not contain the default text. If you do not include the file for a specific locale, the default text is used for that locale.

  7. Upload the custom localization properties file:

    1. In the Localization window, in the Upload Localization File section, click Choose File. Select the .zip file that contains the custom Localization_<locale>.properties files.

      Result:

      A summary of the language files that will be modified shows the following:

      Languages Updated

      Lists the language locales whose messages will be changed

      Languages Removed

      Lists the language locales whose messages will be restored to the default messagesA screen capture of a successful uploaded localization file and the automated populated list of language files that are modified.

  8. Click Save.