PingID Administration Guide

Customizing the enrollment page text by language locale

When the end user’s machine’s locale is set to one of PingID’s supported languages, the user receives enrollment messages in that locale’s language. PingID provides default text for each of the supported languages. You can customize the enrollment message text per language.

About this task

Customize the text using one of the following methods:

Use the same method every time you edit the language text. There are no text validation checks to verify that the text is in the selected language.

If the user’s locale is not a language supported by PingID, or no text is defined for a supported language, the enrollment page uses the English language text.

To customize the enrollment message text using the Admin portal:

Steps

  1. Go to Setup → PingID → BRANDING → ENROLLMENT.

  2. For each language that you want to edit:

    1. From the language selector list (A screen capture of the language selector list icon.), select the language you want to edit.

      A screen capture of the language selector list and options.

    2. Enter the customized text:

      CONTENT

      Customize the text you want to display in the main area of the Registration page Enrollment page.

      NON-APP ENROLLMENT TEXT

      Customize the text to display on the link presented to users who want to enroll to PingID using an authentication method other than the mobile app for an iOS or Android device. The text is updated in the preview page for the selected language.

  3. Repeat step 2 for each language that you want to customize.

  4. To see a preview of the text for each language, from the language selector list (erx1575987237039), select the language you want to preview.

    The text updates automatically.

  5. To restore the default text for a specific locale, select the locale and then next to the Content or Non-App Enrollment Text field, click Reset.

  6. Click Save.

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.

Restoring localization file message defaults

If you have customized the language for one or more locale by editing the localization file, you can restore the defaults by deleting the existing localization file for that language. Deleting the localization file restores the system defaults for all languages.

About this task

You can also restore defaults per language from the Enrollment page. Select a specific language and click Reset next to the text you want to restore. Use only one method consistently, either through the localization file or using the Admin portal. The system does not maintain a history of changes.

Steps

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

  2. From the language selector list, select Edit Localization File.

    A screen capture of language selector list and options.
    Result:

    The Localization window opens.

    A screen capture of the Localization window with a file chosen to remove.

  3. To restore messages text:

    Choose from:

    • To restore message text to the original for all locales, next to Localization.zip, click Remove.

    • To restore message text for one or more languages:

      1. Click Download Current File and extract the current localization template .zip file. A separate Localization_<locale>.properties file is included for each locale.

      2. Delete the files for the locales that you want to reset to default and then compress the remaining files.

      3. In the Localization window, next to Localization.zip, click Remove.

      4. Click Choose file and upload the new localization .zip file.

        The languages to be removed display in the Languages Removed section.

        A screen capture of the Localization window with a populated list of languages to be removed.

  4. Click Save.

  5. Click Confirm.

    Result:

    The following warning message displays.

    A screen capture of the Important message dialog that asks to confirm your choice to remove the selected localization files.

    Result

    Your changes are applied and can be viewed in the relevant language selections in the Enrollment window.