String resources

String resources are sections of text used throughout Janison Insights. Much of this text can be customised, which allows the system to be updated with terms and language relevant to your business or organisation. This might include:

• Changing text to match the terms used in your organisation. For example, renaming test ‘question’ to test ‘item’.
• Customising tooltips, instructions, warnings and messages to make the system more intuitive for your users.
• Translating all text to a different language.

String resources can be accessed from Settings > String Resources in the Menu. This screen displays a list of all available string resources in the system.

• The Default Value column shows the system default value for a string resource
• The Value column shows any customised version of the string resource

On this screen you can:

• Browse the list of string resources
• Search for a string resource
• Select an individual string resource to edit in full on a new screen
• Perform a quick edit on an individual string resource
• Delete a customised string resource and revert it back to the system default value
• View recent activities involving changes to string resources

For more information on searching for and editing individual string resources, see the View and edit an individual string resource section.

On the String Resources screen, you can also select tasks to perform from the Actions drop-down. See the Complete actions on multiple string resources and Export/import string resources section for more information on these tasks.

String resources can be accessed by navigating to Settings > String Resources in the Menu. Individual string resources can be found and updated on the String Resources screen. Customised string resources can be also be deleted, which reverts the string resource back to the system default value.

Search for a string resource

The search feature allows you to quickly find a string resource in the list.

1. Select the Search for String Resource expandable section to drop-down the search function.
2. Enter the string resource you wish to search for in the Search for String Resource field. This will search in all columns of the list of string resources, including:
   • The Default Value column, which contains the default version of the string resource used in the system.
   • The Value column, which contains any customised version of a string resource.
   • The Type and Key columns, which contain system identifiers for each string resource.
3. Select a plugin from the Search for Plugin drop-down field (optional).
   • This can be used to limit the search results to only a particular plugin.
   • It is not always easy to identify the required plugin, but the URL of the page the required string resource is located may help guide you.
   • For example, in the URL below, ‘design’ and ‘test’ are components of the URL where the plugin is Janison.Test.Designer.
     
     
4. Select a language from the language drop-down field (optional).
   • If you are using more than one language and translation have been made, select the required language here to view the relevant translations.
   
5. Select Search.
   
   
6. The search results display in the string resources list.
   
   

   On this list you can:

   • See the number of results found and pages of results at the bottom of the list.
   • Select a column header to sort the results by the contents of the column. For example, select Value to sort the list by string resources that do or don’t have a customised value.
   • Perform edits as shown in the following sections.

Perform a full edit on a string resource

String resources can be edited in full on a new screen, which shows more details.

1. Select the Edit icon next to the required string resource in the list.
   
   
2. The screen that displays depends on whether the string resource already has a customised value or not.
   • If the string resource does not already have a customised value assigned, the New String Resource screen displays. To add a new customised value for the string resource:
     
     1. Enter the new value in the Value field.
        
        
     2. Select Save String Resource.
        
        
     3. The new value added displays in the Value column in the string resource list.
        
        
   • If the string resource already has a customised value, the Edit String Resource screen displays. This screen shows the current customised value of the string resource and any translations next to the This String Resource is also configured as: label. To edit the customised string resource value:
     
     1. Edit the string resource value in the Value field.
        
        
     2. Select Save String Resource.
        
        

        Tip

        Selecting the Reset to Default option cancels out without making the change and resets the string resource back to its default value. This deletes any customised value that was assigned to the string resource.

     3. The new value added displays in the Value column in the string resource list.
        
        

Perform a quick edit on a string resource

String resources can be edited in a popup on the String Resources screen. This shows less details than the screen used to perform a full edit on a string resource.

1. Select the Quick Edit icon next to the required string resource in the list.
   
   
2. The Edit String Resource popup displays, containing the following details for the selected string resource:
   • Culture – the language.
   • Default – the system default value.
   • Translation – the customised value. This will be blank for string resources that do not already have a customised value.
   
3. Make the required changes to the Translation field.
   
   
4. Select Save.
   
   
5. The updated value displays in the Value column in the string resources list.

Delete a customised string resource value

Customised string resource values can be deleted. This reverts the string resource back to the system default value.

1. Select the Delete icon next to the required string resource.
   
   

   Tip

   The Delete icon is only available for string resources with a customised value.

2. The system removes the customised Value and reverts the string resource back to the system Default Value.
   
   

Bulk edits of string resources

Bulk edits of string resources can be performed in Janison Insights. This allows more than one instance of a string resource to be found and updated at the same time.

To access the string resource bulk edit features:

1. Navigate to Settings > String Resources in the Menu.
2. On the String Resources screen, select the Actions drop-down and then select Find & Replace.
   
   
3. The String Resources screen that displays can be used to search for specific names, phrases or terminology and replace these across some or all instances in Janison Insights.
   
   

   The following edits can be made in the expandable sections on this screen.

Multilingual support

Language support can be activated on your Janison Insights site. If language support is active:

• The system checks the language set in the end user’s browser to determine which language to use for string resources to deliver to that user.
• A language selector displays in the footer of the Janison Insights site. This selector drop-down allows:
  • The selection of a language by an Administrator, so the string resources of that language to be customised.
  • End users to select their preferred language. Janison Insights uses this selection to determine the language of the string resources to use.

Tip

Different versions of English can be set as a language in Janison Insights. For example English (Australian) and English (Canada).

If your users are potentially from different English speaking cultures and you want your string resource changes to target all of these cultures, you must set the system to the parent category English before making changes to string resources. If you select English (Australian) for example, the changes will only apply to the Australian English string resource version.

Activate multilingual support and select languages

To activate language support:

1. Navigate to Settings > Languages.
2. The Languages screen displays. Select the Multilingual Support checkbox.
   
   
3. Browse for the required language in the list of languages. You can also enter the required language in the Search for Language field to filter the list.
   
   
4. Select the checkbox in the Active column next to each required language.
   
   
5. Select Save Settings.
   
   
6. The activated language(s) will now be shown in the language selector in the footer of your Janison Insights site. For example:
   
   

Edit string resource values for a language

Once you have activated language support and activated the languages for your site, you will be able to select a language from the drop-down in the footer of the site. This sets the current culture and language, allowing you to edit the string resources for the language.

To edit a string resource for a language:

1. Navigate to Settings > String Resources in the Menu.
2. Select the required language from the language selector in the footer at the bottom of your Janison Insights site. For example:
   
   
3. Select the Edit icon or the Quick Edit icon next to the required string resource in the list.
4. The language you selected in the language selector will be shown in the Culture Code field on the New String Resource screen / Edit String Resource screen / Edit String Resource popup. For example:
   
   
   
5. Update the string resource value as needed and then save your changes. This will now be the string resource value shown to end users using the selected language.

Export/import string resources

String resources can be copied between Janison Insights tenants by using an export and import process. For example, string resources can be customised and tested on a UAT or staging site before being exported and then imported into a production site.

Export string resources

To export string resources from the source tenant:

1. Navigate to Settings > String Resources.
2. On the String Resources screen, select the Actions drop-down and then select Export String Resource.
   
   
3. The Export String Resource popup displays. Select the required culture/language for the string resources to export from the Culture drop-down field.
   
   
4. Select Export.
   
   
5. An XML file downloads to your device. You will need to import this to the destination tenant in the next step.

Import string resources

To import string resources into the source tenant:

1. Navigate to Settings > String Resources.
2. On the String Resources screen, select the Actions drop-down and then select Export String Resource.
   
   
3. The Import String Resource popup displays. Select Select files and choose the XML file to import.
   

   Important

   This import will start as soon as the file is selected, so ensure you select the correct file.

   
4. The import process will start.
   
   
5. Once the import is complete, an Import completed successfully message displays.