Embedded Help internationalization

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Embedded Help Internationalization

    Embedded help internationalization allows you to localize your embedded help content in various languages, catering to global user needs. You can translate existing English content or create new help content in your preferred language. By default, all embedded help content records are in English.

    Show full answer Show less

    Key Features

    • Localization Capability: Write and display embedded help content in the desired language by configuring your session to that language.
    • Language Configuration: Use the Language field in the Embedded Help Queue [sysembeddedhelpqueue] table to select the language for displaying embedded help content.
    • Content Availability: Users will see embedded help in their session language if available; otherwise, English content is shown unless configured otherwise.
    • Content Prioritization: The system prioritizes content based on the user's session language, user-created content, and version-related content.

    Key Outcomes

    By effectively using embedded help internationalization, you can provide a tailored user experience that meets the language preferences of your global audience. This ensures users have access to relevant help content in their native language, improving usability and satisfaction with the embedded help features.

    Embedded help internationalization provides the ability for you to localize your embedded help content to a variety of languages to meet global user needs. You can write your embedded help content in a language of your choice and decide what languages to display.

    Existing embedded help content records are written in English by default. You can translate the English embedded help content provided with the base system into other languages to meet your needs. You can also create custom embedded help content in the language of your choice.

    Understanding localized embedded help content

    To translate English embedded help content into another language or to create embedded help content in a language other than English, your working session must be configured to the language in which you want to write. For example, you must be working in a French session if you want to write embedded help content in French. Refer to Localization settings for more information.

    Configure embedded help content to display in the language of your choice by accessing the Language field on the Embedded Help Queue [sys_embedded_help_queue] table. Depending on the foreign language translations activated on your instance, you can choose which language to display your embedded help content.

    If embedded help content is available in a particular language and users are working in an instance with that language, they will see available embedded help in the desired language.

    Working with localized embedded help content

    When a user requests an embedded help content record, the associated embedded help queue record populates accordingly and the language specified in the embedded help queue record is set to the current session language.

    When embedded help content is available in a user's session language, content will be shown in that same language. If embedded help content is not available in the user's session language, than English content is shown. However, if you do not want to see English content in a non-English session, you can configure the sys_property to False (default is True).

    Embedded help content prioritization

    Displaying embedded help content in the user's session language takes priority over all other mechanisms, such as role, whether content is user-created, and the latest content version.

    When a user is in a non-English working session, the priority for embedded help content display is as follows:
    1. Working-session language (other than English) content displays, if available.
    2. User-created content displays when working-session language content is not available.
    3. Version-related content displays when working-session language and user-created content are not available.
    For example, if an admin user is in a French working session and requests embedded help content, but French content is not available for the admin role, the same-language content for a lower role is displayed if available.

    If there is no embedded help content for the French admin role, but there is content for the French itil role and English admin role, the French itil role takes priority over the English admin role. The French-language content will display at the itil-role level.