Configure SAFe Epic to Feature Translator

Owned by Iryna Ihnatiuk
Last updated: Jul 08, 2024 by Karina Zoin
4 min read

While the app automatically translates most of the places where "epic" is found across Jira, certain places, like custom fields and issue types, are locked in Jira by default. This is a very serious change that could cause Jira to break if done by mistake. Therefore, the configuration for these few fields should be done manually. 

You must have Administrator permissions to unlock custom fields and issue types in Jira.

Configuring Jira to show "Feature" nomenclature

After completing the steps below, you may need to restart Jira so the user interface can display "Feature" or any other translation of "Epic" you have chosen.

  1. Log into your Jira as Admin.

  2. Go to Jira Administration > Manage apps.

  3. In the SAFE TRANSLATOR section, click Configuration.

  4. Unlock custom fields that are related to epics by turning the switch.

    epic-to-feature-translator.png

    With SAFe Epic to Feature 2.0.12 version, we've introduced Configurability by user locale. This enables you to set up different names for different languages.
    Please keep in mind that the names for the Epic Color, Epic Link, Epic Name, and Epic Status fields are translated within each field locale separately.

  5. Go to Administration > Issues > Custom fields.


     

  6. Click Translate for the following custom fields and input new values in the Field Name for each field:

    1. Epic Color

    2. Epic Link 

    3. Epic Name

    4. Epic Status



  7. Go to Administration > Issues > Issue types and translate the Epic issue type.  

  8. Go to the app configuration page and lock the fields again to prevent erroneous field modification.




  9. Clear cache.

    • If you use Jira server

      • For plugin version 2.0.0 and above - click the Clear button to trigger cache clearing.

      • For the previous plugin versions - no additional actions are necessary. After you lock the fields, Jira performs cache clearing, and you should be able to have the functionality ready. 

    • If you are using Jira Data Center 

      • For apps v2.0.0 and above, go to each Jira node and click the Clear button to clear the cached names of the custom fields and issue types.

      • For plugin versions below 2.0.0 - reboot your Jira instances. A Jira reboot is necessary for clearing the cached names of the custom fields and issue types. As you might notice, after translation, it still appears not translated in some places, and a reboot fixes it. 

"Epic" is still shown on admin pages and user interface

After you configure the app, the word "Epic" will still appear on the admin pages for custom fields and issue types because Jira handles user and admin screens differently. This is a current limitation we can't bypass.

If the word "Epic" is still shown on the user interface, it could mean the user’s cache was not refreshed, and a Jira restart is needed for the change to take effect in the system.

Reverting changes and going back to the "Epic" nomenclature

To revert changes and go back to the Jira configuration that contains epics:

  1. Log into your Jira as Admin.

  2. Rename the issue type.

    1. Go to Administration > Issues > Issue types. For the Feature (Epic) issue type, click Translate and set the translation to 'Epic'.

  3. Rename the necessary custom fields.

    1. Go to Administration >Add-ons, and in the SAFE FEATURE section, click Configuration.

    2. Unlock custom fields that are related to epics by turning the switch.

    3. Go to Administration > Issues > Custom fields. 

    4. Click Translate for the following custom fields and input the necessary values in the Field Name for each field.

      1. Epic Link

      2. Epic Name 

      3. Epic Status

      4. Epic Color

    5. Go to Administration >Add-ons, and in the SAFE FEATURE section, click Configuration, and lock the fields.

  4. Clear cache.

    1. If you use Jira server

      • for plugin version 2.0.0 and above - click the Clear button to trigger cache clearing.

      • for the previous plugin versions - no additional actions necessary. After you lock the fields, Jira performs cache clearing, and you should be able to have the functionality ready. 

    2. If you are using Jira Data Center

      • for plugin v2.0.0 and above - go to each Jira node and click the Clear button to clear the cached names of the custom fields and issue types.

      • for plugin versions below 2.0.0 - reboot your Jira instances. Jira reboot is necessary for clearing the cached names of the custom fields and issue types. As you might notice, after translation it still appears not translated at some places, and a reboot fixes it.

  5. Uninstall the plugin.

Configuring Special Translations

Starting with version 2.0.13 of SAFe Epic to Feature Translator, we've introduced the new Special Translation tab to ensure alignment with the SAFe doctrine.

  1. To access the new section, log into your Jira as Admin.

  2. Go to Jira Administration > Manage apps.

  3. In the SAFE TRANSLATOR section, click Special Translations.

  4. Enable special translation options by turning the switch.

  5. You can now translate the following terms:

    1. Project

    2. Fix Version

    3. Affects Version

  6. Click Apply and you're all set, the updated terminology is displayed.



    See next:

Frequently Asked Questions