Skip to content

String resources

A string resource is a piece of the text that Insights shows on its screens, such as a menu name, a field label, a hint or a message. You can replace any string resource with wording of your own. For example, you can:

  • rename a term to the one your organisation uses, such as 'question' to 'item'
  • reword hints, instructions, warnings and messages
  • translate the site into another language.

This page explains how to find and change string resources, replace a term everywhere at once, offer the site in more than one language, and copy your wording to another site.

To manage string resources, select Settings > String Resources.

The string resources page

The String Resources page lists every string resource, with its default wording and any wording of your own.

  1. Actions has Export String Resource, Find & Replace, Import String Resource and Delete all.
  2. Resource values shows how many values you've changed in each language. For example, en (15) means 15 changed values in English.
  3. Search for String Resource opens the search panel, which is open here.
  4. Key identifies each string resource. It starts with the name of its plugin, the part of Insights that uses the text. Some string resources also have a Type, such as hints.
  5. Value is your wording. It's empty until you change the string resource.
  6. Default Value is the wording Insights comes with.
  7. The icons under Actions change a string resource or reset it. See Change a string resource.

The String Resources page with labels A to G. A is on the Actions button and B on Resource values, which reads en (15), af (4). C is on the Search for String Resource panel, which is open: quick add is typed in its first field, above Search for Plugin, English [en] and Value, then the Search button and Reset Search. In the list below, D is on the Key column, E on Value, F on Default Value and G on Actions. The first of its 3 rows is a hint with no Value.

The page's recent activities record the changes, resets, exports, imports and deletes made on this page.

Search for a string resource

  1. Select Search for String Resource to open the search panel.
  2. Enter a word or phrase from the text you want to find. The search looks in Value, Default Value and Key.
  3. To search one part of Insights only, choose its plugin from Search for Plugin.
  4. To see another language's values, choose the language in the field below. It starts as your current language, such as English [en].
  5. Select Search.

To clear the search, select Reset Search.

A key starts with its plugin's name, so a string resource you've already found tells you which plugin to choose. The address of the page where the text appears is another clue. For example, a page whose address contains /design/test/ belongs to Janison.Test.Designer.

To sort the list, select a column heading. For example, select Value to bring the string resources you've changed together.

Change a string resource

Each row has up to 3 icons under Actions.

  1. The lightning icon, Quick edit, opens a popup where you change the wording without leaving the list.
  2. The pencil icon opens the string resource on a page of its own, which shows more detail.
  3. The cross icon resets the string resource to its default. It shows only on a string resource you've changed.

The String Resources list with 5 rows and labels A to C. The first row, a hint with no Value, has 2 icons: A is on its lightning icon and B on its pencil icon. The other 4 rows are ui elements with a Value, such as QuickAdd Venue beside the Default Value Quick Add Venue, and have 3 icons. C is on the second row's cross icon.

Quick edit

Select the lightning icon beside the string resource. In the Edit String Resource popup, enter your wording in Translation, then select Save.

The Edit String Resource popup. Culture is en and Default is Quick Add Venue. The Translation field, which holds QuickAdd Venue, is highlighted, above Cancel and Save.

Culture is the code of the language you're changing, and Default is the default wording. Your wording then shows under Value in the list.

Edit in full

Select the pencil icon beside the string resource. A page opens, titled New String Resource if the string resource has no wording of yours yet, and Edit String Resource if it has. Then:

  1. Enter your wording in Value.
  2. Select Save.

The Edit String Resource page for JService/UiElements.QuickAddVenue. Culture Code, Resource Type, Key and Default Value are greyed out. Step 1 is on the Value field, which holds QuickAdd Venue. Below it, This String Resource is also configured as shows (en) QuickAdd Venue. Step 2 is on the Save button, which is followed by Cancel and Reset To Default.

The fields above Value identify the string resource, and you can't change them. This String Resource is also configured as lists the wording you've saved for it in each language. On a site with more than one subdomain, the page also shows the Subdomain the wording is for.

Tip

Some default values contain placeholders such as {0}, which Insights replaces with a name or a number when it shows the text. Keep them in your wording. You can't save wording that has a placeholder the default doesn't have.

Reset a string resource to its default

To go back to the default wording, select the cross icon beside the string resource. Insights removes your wording straight away, without asking you to confirm.

On the edit page, Reset To Default does the same.

Find and replace

Find and replace changes a word or phrase in every string resource that contains it. For example, you can replace 'Org Unit' with 'School' throughout Insights.

On the String Resources page, select Actions > Find & Replace. Then:

  1. In Find, enter the word or phrase to look for, at least 3 characters long. After a moment, the page lists each string resource that contains it, in its default wording or in yours, with the matches highlighted.
  2. In Replace, enter the new word or phrase. New value shows how each string resource will read, and the page ticks the ones that will change.
  3. Tick the options you need:
    • Match case finds only text with the same capital letters as Find.
    • Adaptive case gives each replacement the case of the text it replaces: lower case, upper case or title case.
    • Match whole word leaves out longer words that contain the text.
  4. Untick any string resource you want to leave as it is. To write a string resource's new wording yourself, select its pencil icon, Manual Edit.
  5. Select Save. Insights changes the ticked string resources and clears the page. To save and then search again for the same words, select and continue.

The find and replace page with steps 1 to 5. Step 1 is on Find, which holds Org Unit, and step 2 on Replace, which holds School. Step 3 is beside the options Match case, Adaptive case and Match whole word. In the list below, 3 ticked string resources show Current value beside New value, with each Org Unit highlighted and School highlighted in its place. Step 4 is on the first tick box, and step 5 on the Save button, which is followed by and continue and Cancel.

The page lists up to 500 string resources at a time. If there are more, save your changes and the page lists the next ones.

On a site with multilingual support, Culture, above Find, sets the language whose string resources you're changing.

Naming conventions

A naming convention records a term you've renamed. You can then apply the same change again later, for example after an update adds string resources that use the original term.

On the find and replace page, expand Naming Conventions. Then:

  1. In the empty row, enter the term Insights uses in Original name, such as 'Org Unit'.
  2. Enter your term in Current name, such as 'School'.
  3. Select Save in the Naming Conventions section.

The Naming Conventions section with steps 1 to 3. Under the buttons Add conventions for another culture and Audit conventions, a set of conventions for English [en] lists Question as Item, student as test-taker and candidate as test-taker, each with 2 icons under Actions. Step 1 is on Original name in the empty row below them and step 2 on Current name. Step 3 is on the Save button.

Once you have conventions, you can use them in these ways.

  • Audit conventions adds an Audit column, which counts the string resources that contain each original name.
  • The circular arrows icon beside a convention, Apply convention, fills in Find and Replace with its 2 names. Check the matches, then save.
  • The cross icon beside a convention, Remove convention, deletes it once you select Save.

On a site with multilingual support, each set of conventions is for one language, shown in Culture. Add conventions for another culture starts a new set. Remove culture deletes a set once you select Save.

Multilingual support

Insights can show its screens in more than one language. You turn on multilingual support, choose the languages, then give each language its wording as string resources.

Turn on multilingual support and choose languages

Select Settings > Languages. Then:

  1. Tick Multilingual Support. A list of languages appears.
  2. Find each language you want. To shorten the list, type part of its name in Search for Language.
  3. Tick Active beside each language. Currently active languages shows your choices.
  4. Select Save.

The Languages page with steps 1 to 4. Step 1 is on the Multilingual Support tick box, which is ticked, below Reset To Default Culture On Page Reload. Currently active languages reads Afrikaans, English. Step 2 is on Search for Language, which holds afrikaans, so the list below shows 2 languages: af, Afrikaans, and af-ZA, Afrikaans (South Africa). Step 3 is on the ticked Active box for Afrikaans, and step 4 on the Save button.

Tip

Many languages are listed on their own and again for each region, such as English and English (Australia). Wording saved for English applies to every regional form of English, unless that region has wording of its own.

Which language a user sees

With multilingual support on, Insights shows each user the first of these that is one of your active languages:

  1. the language they chose in the language selector
  2. the language set on their user account
  3. the languages set in their browser, in order.

If none of these is active, Insights uses the Default Culture chosen on the Languages page.

The language selector is in the footer of each page, once 2 or more languages are active. It lists each language by its own name. Choosing a language reloads the page in that language.

The language selector at the bottom right of a page, open. Its menu lists Afrikaans and English, above a button that shows the current language, Afrikaans.

While Reset To Default Culture On Page Reload is ticked on the Languages page, every page loads in the Default Culture, and the language selector is hidden.

Change the wording for a language

  1. Choose the language in the language selector. The page reloads in that language.
  2. Select Settings > String Resources. The list shows that language's values. For a regional language, such as English (Australia), it shows the values of the parent language, English.
  3. Change each string resource with quick edit or on the edit page. Culture in the popup, and Culture Code on the edit page, show the language's code, such as af for Afrikaans.

Everyone who uses Insights in that language then sees your wording.

Export and import string resources

To copy your wording from one Insights site to another, export it from the first site and import it into the second. For example, you can set up and test your wording on a test site, then copy it to your live site.

Each export holds one language, so repeat these steps for each language you've changed.

Export string resources

On the String Resources page of the site you're copying from, select Actions > Export String Resource. Then:

  1. Choose the language in Culture. The list holds each language that has wording of yours.
  2. Select Export.

The Export String Resource popup. Under the line Please select the culture you would like to export against, step 1 is on the Culture list, set to en, and step 2 is on the Export button, beside Cancel.

Insights downloads an XML file. Its name starts with StringResources_ and the language's code.

Import string resources

On the String Resources page of the site you're copying to, select Actions > Import String Resource. In the Import String Resources window, select Select files... and choose the XML file.

Important

The import starts as soon as you choose the file, so check that it's the right one.

The Import String Resources window after an import. Under a note that imports for sub tenants must be done at the Default level, the Select files button is highlighted. Beside it is Done, and below it the imported file, StringResources_en, at 100%. Under the file is the message Import completed successfully.

When the import ends, the window shows Import completed successfully.

The import adds each wording in the file to the site. It replaces any wording the site already has for the same string resource and language. String resources that the file has no wording for stay as they are.

Delete all your wording

Delete all removes your wording from every string resource, in every language, so that all text returns to its default.

Warning

You can't undo Delete all. Export your string resources first, so that you can import them again if you need to.

On the String Resources page, select Actions > Delete all. The Authorisation dialog gives 2 counts of the string resources it will delete: one with its tick box clear and one with it ticked. The larger count includes those whose key contains an ID, such as your descriptions of workflow transitions.

Tick or clear the box, type the word 'confirm' in the field, then select Ok.

The Authorisation dialog. Under a warning that the function cannot be undone, 2 lines are highlighted: 17 string resources will be deleted when the below checkbox is not checked, and 19 when it is checked. Below them are a tick box about string resources with a GUID in the key, the line Please type the word confirm to unlock this action, an empty field, and the buttons Cancel and Ok.

Settings

These settings affect string resources and languages.

Languages (Settings > Languages) — Multilingual Support turns on the list of languages and the language selector. Default Culture is the language Insights uses when none of a user's languages is active. Reset To Default Culture On Page Reload loads every page in the default culture.

Roles (Settings > Roles) — sets which roles can open String Resources and Languages, and use each action on them.

Test Designer Settings (Settings > Test Designer Settings) — Enable Test Player UI Language Selection lets each test set the language of its test player, where multilingual support is on. See Create a test.