Overview
If you wish to rename certain names or phrases in the Jive user interface, you may do so using Phrase Substitution. Phrase Substitution requires the use of a theme and individual translations for each locale (language) within that theme. The translations are drawn from the regular expressions (regex) keys within the internationalization (i18n) properties file.
This article provides step-by-step instructions on how to configure a Simple Phrase Substitution and Advanced Phrase Substitution.
Prerequisites
A user account with at least Manage System permissions in your Jive on-premise instance.
Information
Configuring a Simple Phrase Substitution
Using Simple Phrase Substitution, you can quickly and easily change the names for spaces, documents, discussions, and blogs as seen by your users. E.g., the name for the content type_z blogs.
To add a Simple Phrase Substitution:
- Go to the Admin console > System > Settings > Phrase Substitutions and select the appropriate locale and theme.
- Add a singular and plural name for 'Blog' and then click the 'Save' button.
- Upon refreshing the page and while the theme is applied, you should now see the new name diary where the blog had been previously mentioned.
- Repeat this for each locale needed.
Configuring an Advanced Phrase Substitution
To modify additional phrase strings, you can use Advanced Phrase Substitution. E.g., you may wish to modify the welcome message on the login page.
There are two ways to configure the Advanced Phrase Substitution:
- Either with substitution by i18n phase key
- or substitution by phase string
In the example above, the phase key and string will be:
[PHRASE_KEY] = [PHRASE_STRING]
login.intro.header = Welcome to the new way to business.
login.intro.text = Jive gives you everything you need and love about social in
your personal life, at work. Connect and share instantly, ask questions, find
and follow experts, and keep track of team progress. With Jive, you can change
the way work gets done.
- The i18n phase keys are located in the
jive_i18n_en.properties
file that may be found insrc/java/
in the code and is packaged in the core .jar file (/usr/local/jive/application/sbs/application/WEB-INF/lib/jive-sbs-[employee/public]-[version].jar
) on the web application nodes.
-
To extract the file, use the Java Archive Tool (JAR) and the following command:
jar xf [archive_file] jive_i18n_en.properties
-
An example command syntax would be:
jar xf jive-core-9.0.0.0.jar jive_i18n_en.properties
Refer to the article: Using JAR Files: The Basics article for more information.
Note that since Phrase Substitutions are tied to the theme, changes made to your theme through upgrades or deliberate theme changes may affect the availability of Phrase Substitutions and they may need to be reconfigured.
-
- For phase strings, in almost all cases, you will already know the string that you want to replace. For an instance, you may want to replace the login intro string message from the example above.
Once either the i18n phrase keys or phrase strings have been identified, follow the steps below:
- Go to the Admin Console > System > Settings > Phrase Substitutions, noting that the correct locale and theme have been selected, and then click the 'View Rules' button.
- Click on the 'Add Rule' button.
- If you know the phrase key (for example,
login.intro.header
), enter the following values:- Target:
Key
- Operator:
Equals
- Pattern:
login.intro.header
- Replace With:
[YOUR CUSTOM WELCOME MESSAGE]
- Click 'Save' when you are done and repeat for any remaining phrase keys.
- Target:
- If you do not know the phrase key, but know the entire phrase string, enter the following values:
- Target:
Value
- Operator:
Equals
- Pattern:
Welcome to the new way to business.
- Replace With:
[YOUR CUSTOM WELCOME MESSAGE]
- Click 'Save' when you are done and repeat for any remaining phrase strings.
- Target:
- If you know the phrase key (for example,
- Click 'Add Rule' to add any additional rules needed as per how many additional phrase keys are to be employed.
- Repeat steps 1-3 for each locale needed.
- Ensure that the desired theme is enabled, then navigate to your Jive instance to view the intended page. You should now see the changes.
- If you do not see the change, refresh your browser and/or clear the browser cache. If the issue persists, check to see if you have internet caching or CDN caching at the network level and either manually clear the network cache, or allow some time to pass for it to automatically clear on its own.
Comments
0 comments
Article is closed for comments.