E2F - Configuring SAFe Epic to Feature Translator

Owned by Iryna Ihnatiuk
Sept 06, 2021
4 min read

Contents

While the app automatically translates most of the places where "epic" is found across Jira, there are certain places like custom fields and issue types that are locked in Jira by default as this is very serious change and 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 do that.

Configuring Jira to show "Feature" nomenclature

  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.

    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, names for Epic Color/ Link / Name / 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
       

    Warning

    Do not click Edit, click Translate to change how the field names look.

    If you edit the fields, you will have the JQL updated as well, but most likely will face consequences during Jira update that will lead to broken data. You can only choose to do so if you never intend to upgrade Jira again or can be 100% sure to set the same field names and issue types before Jira update but we still strongly recommend against it.





    Note that the Translate dialog contains the locale. The translations are implemented for the English locale that is selected on this screen.

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

    Do not edit the Epic name to change it to Feature - only use the translate functionality.




  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 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 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. 


Note

After you configure the plugin, the word "Epic" will still be shown on the Admin pages of the custom fields and issue types. This is because Jira works in a different way for user and admin pages / screens. Thus, the translation that you apply will be shown on the user UI, but the epic related fields will still be shown with the word "epic" for the Admin pages / screens. This is a limitation of Jira, and at the moment we cannot work around this. But in case the way Jira works changes, we will be able to show "feature" on the Admin pages as well.

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 you are align 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 now can 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.



That's it. 

E2F - Frequently Asked Questions