Exclusion Framework in Dynamic Translation

  • Release version: Yokohama
  • Updated January 30, 2025
  • 3 minutes to read
  • Preserve text such as product names or technical terms during machine translation. With Exclusion Framework in Dynamic Translation, you can specify words and patterns that should not be translated.

    Exclusion Framework is a set of rules ensuring that your designated text bypasses the machine translation process and appears unchanged in the resulting output. Dynamic Translation applies Exclusion Framework rules to your text before submitting the request to your machine translation provider. Two types of rules are supported: Exact Match (specific terms) and Pattern Match (regex).

    Examples of text to consider for exclusion from machine translation

    In response to your organization's business requirements, you can create Exclusion Framework rules for text strings such as the following.
    Table 1. Exclusion rule examples
    Rule type Examples
    Exact match
    • Product or company names
    • Acronyms, stock ticker symbols
    • Technical terms or identifiers
    • Terminology that has unique meaning in your organization
    Pattern match
    • Case numbers, incident numbers
    • KB article numbers
    • Sys IDs
    Review your organization's glossaries and taxonomies to identify candidates for exclusion.

    Activating Exclusion Framework

    An upgrade to Xanadu Patch 3 or higher, when Dynamic Translation is active, includes activation of Exclusion Framework by default.
    Note:
    Dynamic Translation requires a Professional or above subscription. For information see Activate Dynamic Translation.

    An upgrade to Xanadu Patch 3 or higher also converts the Dynamic Translation flows from v3 to v4. The v4 flows contain subflows for working with Exclusion Framework. Translator configurations available by default are automatically upgraded to v4. For more information, see Migrate customized Translator Configurations to v4 flows.

    A system property in All > Dynamic Translation > Properties enables you to activate or deactivate Exclusion Framework: sn_dt.dynamic_framework.enable_exclusion_framework.

    Exclusion Framework appears as a module under Dynamic Translation.
    Figure 1. The Exclusion Framework module
    In the navigation pane, the module for Exclusion Framework in Dynamic Translation is displayed.

    By default Exclusion Framework provides several exclusion rules, and you can add your own rules during configuration. The Dynamic Translation table of Exclusion rules

    Configuring Exclusion Framework

    Because Exclusion Framework is activated by default you can complete its configuration as follows.
    1. Ensure that your third-party machine translation service has an active record in the Exclusion Provider Pattern [sn_dt_provider_exclusion_pattern] table. If you have chosen a custom translator service you must input their exclusion tags. For information see Add an Exclusion Provider Pattern.
    2. Review any existing records in the Exclusion Rules [sn_dt_exclusion_rules] table to check whether they are appropriate for your needs. Rules that are provided by default can be deactivated by clearing the Active check box, but they can't be edited.
    3. Add more exclusion rules according to your organizational requirements. For information see Add new rules to Exclusion Framework.

    Exclusion Framework's operational process

    After configuration, Exclusion Framework's subflows operate within Dynamic Translation. The Exclusion Framework process is outlined as follows.
    1. Exclusion Framework searches the original text (before translation) to find any matches to terms and patterns that are active in the Exclusion Rules table.
    2. Any matches are wrapped in exclusion tags. These tags are pulled from the relevant record in the Exclusion Provider Pattern table.
    3. The tagged text is submitted to your machine translation provider.
    Text that is wrapped in the exclusion tags is shielded from translation. It is written into the translation results in its original language, so the output contains unmodified text embedded in translated text.

    Domain separation support in Exclusion Framework

    Exclusion Framework supports domain separation. Each domain on an instance can have its own set of Exclusion Framework rules, so the rules apply at the domain level. Within a domain, each rule must be unique. Create rules in the domain where you want them to operate.

    When multiple domains exist on one instance, Exclusion Framework is activated on all domains. Deactivating Exclusion Framework on a per-domain basis isn't supported. As an alternative, deactivate every rule in a domain where you want Exclusion Framework to be inactive.