Overview

You have identified specific UI element display names within Service Gateway that appear incorrectly or that you would like to alter. You require guidance on how these display names are mapped to the Token Names.

Solution

The mapping of the UI Display Name to the Token Names within Service Gateway is handled within the ServiceGatewayUI.properties file packaged within your Service Gateway EAR file.

When encountering issues with the display names, it is generally recommended to redeploy the most recent release of Service Gateway to resolve the behavior. However, if this is not an option, you can use the steps below to adjust the Token Name mappings. 

1. Unpack the EAR and collect the ServiceGatewayUI.properties file.
   1. Locate the Service Gateway EAR file on your server.
      1. Default Path: /usr/local/sprt/<server_name>/servicegateway/
   2. Unpack the EAR using your preferred archive management software, such as 7Zip or gZip.
   3. Extract the ServiceGatewayUI.properties file.
      1. Default Path: /servicegateway.war/WEB-INF/classes/
2. Edit the properties file in your preferred text editor.
3. Locate the Token Name or display string you want to edit.
4. Using the following syntax, add your new display string: 
   • Token_name=display_string
   • Example:  (1)admin_(2)realm_(3)field_name=(4)Name

     • Token names typically have a format similar to the above:

       1. This first part identifies the module. 

       2. This second part identifies the component within the module. 

       3. This final part determines what the token represents.

       4. The portion after the equal sign is the text displayed in the UI. 

     • So for the above example token, it is part of the Administration module, it is for the Realm screen, it is an input field, and the input field is for the realm’s name. When looking at the UI, the text ‘Name’ would be displayed for that input field.

   • The default behavior in the UI is to display the token name wrapped in square brackets if the token is not included in the properties file.

     • So using the above example, if the admin_realm_field_name token were not present in the properties file, you would see the following displayed in the UI: [admin_realm_field_name].

5. Add your edited properties file back to the EAR, replacing the existing copy.

6. After repacking with your archive management software of choice, redeploy the EAR to your server.

Testing

After redeploying the modified EAR and restarting your Service Gateway servers, review the UI elements that you adjusted, and you will see the new Display Name appearing.