Language customization
STA provides customizable language files for the user portal, self-provisioning, and user login pages, so that you can provide your users with a coherent user experience.
You can customize some or all of the text strings in the existing language files, so that they are consistent with your company style and vocabulary.
To customize a language file, do the following:
-
Download the language files from the STA Access Management console.
-
Edit only the strings that you want to customize and delete the other strings.
-
Upload the file with the customized strings, and then enable language customization.
Download the language files
The language files pack is a zip file that includes a file for each of the supported languages:
-
cs: Czech
-
da: Danish
-
de: German
-
en: English
-
es: Spanish
-
fi: Finnish
-
fr: French
-
it: Italian
-
ja: Japanese
-
ko: Korean
-
nb: Norwegian
-
nl: Dutch
-
pt-BR: Português Brasileiro
-
sv: Swedish
-
zh-CN: Chinese, Mainland China, simplified characters
-
zh-TW: Chinese, Taiwan, traditional characters
After you download the language files, you can customize them and then upload your customized files.
-
On the STA Access Management console, select Settings > Language Customization.
-
Next to Default language files pack, select Download.
The sample language file shows the key-value pairs in the default English language file.
Customize a language file
After you download the language files pack, you can customize any of the language files. Each language file contains the text strings that appear on the user portal and login pages for a particular language, which is identified by the file name.
The language files are JSON files that you can edit in any text editor. Each JSON file contains the same list of key-value pairs. The key-value pairs are in the following format:
"key": "value",
-
The keys are descriptors that help identify where the text is located on the user portal and login pages.
-
The values are the text strings that you can customize.
When you customize a language file, edit the text strings that you want to customize and delete the other strings. The default values are used for any text strings that are not included in the file that you upload. However, if a language file includes a key with an empty value, then the default value is not displayed.
The following are examples of key-value pairs from the en.json file:
In these examples, you can edit the following values or text strings:
-
Enter your Domain Password.
-
Add Authenticator
Each language file includes the text strings and default values that you can customize for the user portal and login pages:
When you edit a language file, remember that the contents of the file must be valid JSON.
After you edit a language file, save it with the same file name and the json extension, such as en.json or fr.json. The file names of the customized language files must match the names of the default language files that you downloaded.
Optional information strings in the language files
The language files include the following optional strings that you can customize to show contextual information on the login, self-provisioning, and user portal pages:
-
custom.infobox.authentication: These strings appear on the login pages.
-
custom.infobox.enrollment: These strings appear on the self-provisioning pages.
-
custom.infobox.userportal: These strings appear on the user portal. Uses can dismiss the information strings on the user portal. When a user dismisses one of these strings, the string is not visible when they refresh the page, log in again, or switch languages. Uses can click an info icon to display the information string again.
You can use HTML tags and attributes in all of these information strings.
The background of the custom text boxes is based on the primary color that you select for the virtual server.
Special characters in the language files
Escape special characters as follows:
Character | Escape sequence |
---|---|
& | & |
" | " |
< | &alt; |
> | > |
\ | \\ Backslashes must be escaped to be valid JSON. |
HTML tags and attributes in the language files
You can use HTML tags and attributes for the all of the optional information strings, and for text strings that appear on the self-provisioning and login pages.
HTML tags are supported in most text strings on the user portal pages. However, the following text strings do not support HTML tags:
-
applications.search
-
authenticators.pushEnabled
-
authenticators.pushDisabled
-
app.help
-
app.language
-
app.info
-
app.menu
-
applications.removeFavorite
-
applications.addFavorite
All of the HTML tags can have a class attribute.
The following HTML tags and attributes are allowed in the values (none are allowed in the keys) for the self-provisioning and login pages:
-
strong
-
b
-
h1
-
h2
-
h3
-
h4
-
h5
-
p
-
i
-
u
-
br
-
span
-
label
-
a
The anchor tag can have a target attribute and an href attribute with the value restricted to a dollar sign ($) followed by a single digit, such as <a href=\"$1\">this link</a>
.
Upload a language file and enable language customization
After you edit a language file, you can upload it. If you want to upload multiple language files, you need to upload them one at a time. You can upload only one copy of each language file.
The uploaded language files apply to only the current virtual server.
The language file that you upload should contain only the customized key-value pairs. It doesn't need to include the complete set of key-value pairs. The default values are used for any text strings that are not included.
The language files that you upload are not used until you enable language customization. You can disable language customization to revert to the defaults for all languages, and ignore any customized language files that are uploaded.
After you enable language customization, the updated text appears when a user selects a customized language on the user portal and user login pages.
-
On the STA Access Management console, select Settings > Language Customization.
-
Select Upload Language File.
-
Browse for or drag the language file that you want to upload, and then click Select. You cannot upload multiple files at the same time. You must upload the files one at a time.
-
Upload additional customized language files, as needed.
-
To enable language customization, select the toggle to indicate that Language customization is currently enabled.
Test the customized language
After you upload a language file and enable language customization, you can go to the user portal or user login pages to test that the language customization is working as expected.
-
On the STA Access Management console, select Applications > User Portal and copy the user portal link.
-
Open a new browser tab or window, and then paste and go to the link.
-
At the top-right of the user portal login page, select the language menu and then select the customized language that you want to test.
-
Navigate through the user portal screens to test the changes.
Update or delete a custom language file
Before you can update a customized language file, you must delete it from the STA Access Management console, because duplicates are not allowed.
-
On the STA Access Management console, select Settings > Language Customization.
The Custom Language Files section lists the uploaded files. Each uploaded language file has a menu with options to download or delete the file.
-
To download the language file, select Download. For example, you can download the current version so that you can edit it.
-
To remove the current version, select Delete. For example, before you can upload an updated version of a language file, you must delete the current version.
Page titles and copyright statements
You can customize the page titles that appear on the browser tabs:
Note
The user portal name and the application names are specified on the Applications tab.
You can also customize the copyright statement that appears in the bottom-right of the pages.
In the language files, you can customize the values for the following page titles:
Key | Default value | Location |
---|---|---|
app.product | SafeNet Trusted Access | User portal, login, and self-provisioning pages |
login-page-title | SafeNet Trusted Access | Login and self-provisioning pages |
login-page-title-sta | SafeNet Trusted Access | Login page browser tab |
copyRight | Copyright © 2017 - $1 Thales Group. All Rights Reserved. | Login and self-provisioning pages, and the user portal landing page |
app.copyright | Copyright © 2018 | User portal pages, except the landing page |
Alt text on the user portal and login pages
Images on the user portal and login pages include alternative (alt) text that screen readers can read aloud.
In the language files, you can customize the following values for the alt text on the user portal and login pages:
Key | Value | Location |
---|---|---|
alt-banner | Banner |
Login and self-provisioning pages |
alt-language | Language | User portal, login, and self-provisioning pages |
alt-logo | Logo |
Login and self-provisioning pages |
app.banner | Banner |
User portal |
app.info | Info |
User portal This string also appears in the mobile menu, when you dismiss the optional information that is displayed on the user portal using the custom.infobox.userportal key. |
app.logo | Logo |
User portal |
Text in the language menu
The language menu appears on the top-right of the user portal and login pages:
In the language files, you can customize the following values for the language menu:
Key | Default value |
---|---|
cs | Česky |
da | Dansk |
de | Deutsch |
en | English |
es | Español |
fi | Suomi |
fr | Français |
it | Italiano |
ja | 日本語 |
ko | 한국어 |
nb | Norsk |
nl | Nederlands |
pt-BR | Português Brasileiro |
sv | Svenska |
zh-CN | 简体中文 |
zh-TW | 繁體中文 |
Sample language file
When you customize a language file, edit the text strings that you want to customize and delete the other strings. The default values are used for any text strings that are not included in the file that you upload.
The language files are JSON files that you can edit in any text editor. Each JSON file contains the same list of key-value pairs.
The following is a sample of a complete English language file that is sorted alphabetically.