Localization Framework Hub and Spoke architecture

  • Release version: Xanadu
  • Updated August 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 Localization Framework Hub and Spoke architecture

    The Localization Framework Hub and Spoke architecture in the Xanadu release enables a centralized approach for managing translation requests across multiple ServiceNow instances. Instead of handling translation requests individually on each instance, this model designates one instance as thehubthat fulfills translation requests submitted by other instances calledspokes. This architecture streamlines translation workflows, centralizes management, and limits translation fulfillers’ access to a single hub instance.

    Show full answer Show less

    Key Features

    • Centralized Translation Fulfillment: Spoke instances submit translation requests to the hub, which manages fulfillment including integration with a Translation Management System (TMS), then returns translated content to the spoke.
    • Plugin-based Configuration: The architecture requires installation of two optional plugins: Localization Framework Hub on the hub instance and Localization Framework Spoke on spoke instances.
    • Hub Configuration: Administrators configure spoke connections, translation preferences (such as TMS integration), workflow settings, and optional project preferences on the hub instance.
    • Spoke Configuration: On spoke instances, administrators enable TMS, specify the hub as the TMS, and configure connection credentials to communicate with the hub.
    • Multi-language Task Management: If no project is specified on the hub, translation requests for multiple languages are split into separate tasks per language.
    • Machine Translation Option: Available if the Dynamic Translation plugin is installed, offering machine translation capabilities.

    Key Outcomes

    • Simplified Translation Management: By centralizing translation fulfillment in a single hub instance, organizations reduce complexity and secure translation workflows by limiting fulfiller access.
    • Consistent Translation Integration: The hub processes all translation requests and integrates with chosen TMS platforms, ensuring uniform handling and reporting.
    • Scalable Model: Enables multiple spoke instances to efficiently leverage centralized translation services without duplicating fulfillment logic or access.
    • Improved Control and Security: Restricts translation fulfillment activities to the hub, providing clearer governance and reducing exposure on spoke instances.

    Enable one central instance to fulfill translation requests submitted from other instances using the Localization Framework Hub and Spoke architecture. Install optional Localization Framework plugins to configure one of your instances as a hub and other instances as spokes.

    By default, translations are requested and fulfilled on the same instance. However, in the Xanadu release, there is an available hub-spoke model for translation requests and fulfillment. With this architecture, translation requests are a two-step process:
    1. The spoke instance submits a translation request to the hub instance.
    2. The hub instance manages the fulfillment of the request, such as by sending the content to a translation management system (TMS). The hub returns the translated contents to the spoke instance.
    Consider the Localization Framework Hub and Spoke architecture when you want to limit fulfillers' access to one instance only.
    To set up this architecture, use the admin role to install the following plugins:
    • Localization Framework Hub [com.sn.localization_framework.hub]. Install this plugin on the instance you designate as a hub.
    • Localization Framework Spoke [com.sn.localization_framework.spoke]. Install this plugin on the instances you designate as spokes.

    For more information on installation, see Activate Localization Framework.

    When both plugins are installed, use the admin or localization_admin role to configure the connection between hub and spoke instances. On the hub instance:
    1. Navigate to Localization Framework > Hub > Spoke Settings.
    2. In the Name field, enter a unique name for each entry.
    3. In the tab for Translation Preferences, find the Translation Management System (TMS) section. Enter the TMS service your organization uses.
    4. In the tab Workflow Preferences, configure according to your requirements. Depending on the workflow you choose, different subfields are populated.
    5. The tab Project Preferences is optional. If no project is entered, any request for translations into more than one target language is broken into separate tasks, one for each language.
    Note:
    If Dynamic Translation is not installed, the option for machine translation is not available.
    On a spoke instance:
    1. Navigate to the Settings All Artifacts table [sn_lf_setting].
    2. In the tab Translation Preferences, find the Translation Management System (TMS) section.
      • Enable TMS: select.
      • TMS: Set to Localization Framework Hub.
      • TMS Additional Info: for spokeSettingsName, enter the name of the connection setting that has been configured on the hub.
    3. Navigate to the Connection & Credential Aliases table. Find and open the record named Localization Framework Hub TMS.
    4. Add the connection to the hub in the Connections tab. You can enter the URL to your hub in the Connection URL field. Set authentication and other attributes appropriate to your environment.
    From the perspective of the spoke instance, the hub acts as a TMS.