Message Templates
  Download PDF

1. Overview

This guide will reveal where to look for the message templates, how-to modify the English message templates and how-to add another language.

2. Message Templates

2.1 OpenOTP

Log into the WebADM GUI, under Applications, choose OpenOTP and click on CONFIGURE.

screenshot

Under MAIL OTP, one can change the default Email Subject.

screenshot

Scroll down to Message Templates to find the other message templates for OpenOTP.

screenshot

Here the English message templates can be modified. If you want to add or modify another language then click on Localized.

screenshot

Message templates for other languages can be added here. One can export/import as/from a CSV file. Per default, only the languages “EN”,“FR”,“DE”,“ES”,“IT”,“FI” are available. However, one can add more by adding it to /opt/webadm/conf/webadm.conf. Have a look at the chapter 2.7 Localized Messages.

2.2 SpanKey

Log into the WebADM GUI, under Applications, choose SpanKey and click on CONFIGURE.

screenshot

Under User Notifications, one can add the Notification Email Subject.

screenshot

Scroll down to Message Templates to find the other message templates for SpanKey.

screenshot

Here the English message templates can be modified. If you want to add or modify another language then click on Localized.

screenshot

Message templates for other languages can be added here. One can export/import as/from a CSV file. Per default, only the languages “EN”,“FR”,“DE”,“ES”,“IT”,“FI” are available. However, one can add more by adding it to /opt/webadm/conf/webadm.conf. Have a look at the chapter 2.7 Localized Messages.

2.3 Secure Password Reset (PwReset)

Log into the WebADM GUI, under Applications, choose Secure Password Reset (PwReset) and click on CONFIGURE.

screenshot

Under Email & SMS Settings, one can change the Email Subject. Under Message Templates to find the other message templates for Secure Password Reset (PwReset). Here, the English message templates can be modified.

screenshot

If you want to add or modify another language then have a look at the following folder /opt/webadm/webapps/pwreset/lang/.

-bash-4.2# ls -lha /opt/webadm/webapps/pwreset/lang/
total 52K
drwxr-xr-x 2 root root  226 Feb 26 17:18 .
drwxr-xr-x 7 root root  224 Feb 26 17:23 ..
-rw-r--r-- 1 root root  490 Feb 22 12:55 cancel.json
-rw-r--r-- 1 root root 5.0K Feb 22 12:55 common.json
-rw-r--r-- 1 root root 5.9K Feb 22 12:55 home.json
-rw-r--r-- 1 root root  181 Feb 22 12:55 index.json
-rw-r--r-- 1 root root  684 Feb 22 12:55 login_pki.json
-rw-r--r-- 1 root root   20 Feb 22 12:55 login_sso.json
-rw-r--r-- 1 root root  573 Feb 22 12:55 login_uid.json
-rw-r--r-- 1 root root   20 Feb 22 12:55 logout.json
-rw-r--r-- 1 root root  631 Feb 22 12:55 openotp.json
-rw-r--r-- 1 root root 1.1K Feb 22 12:55 tiqr.json
-rw-r--r-- 1 root root  725 Feb 22 12:55 tiqr_offline.json

For example, to translate or modify the sentence Server error, edit the following file /opt/webadm/webapps/pwreset/lang/common.json like below.

-bash-4.2# vi /opt/webadm/webapps/pwreset/lang/common.json
{
        "OpenOTP is not installed or configured": {
                "FR": "OpenOTP n'est pas installé ou configuré",
                "DE": "OpenOTP ist nicht installiert oder konfiguriert"
        },
        "Server error": {
                "FR": "Erreur du serveur",
                "DE": "Serverfehler"
        },
...

Add a new language, for example DE, then modify languages="FR,DE" to the following file /opt/webadm/webapps/pwreset/pwreset.xml just like below.

-bash-4.2# vi /opt/webadm/webapps/pwreset/pwreset.xml
<?xml version="1.0" encoding="UTF-8" ?>

<!-- YOU SHOULD NOT NEED TO MODIFY THIS FILE -->

<WebApp name="PwReset"
        icon="pwreset.png"
        version="1.0.12-1"
        wapi="51" eapi="2"
        admcss="style.css"
        section="Self-Service"
        license="freeware"
        languages="FR,DE"
        desc="Secure Password Reset"
        help="Use this Web application to securely reset your LDAP or Domain password when it is lost or expired.">
...

2.4 User Self-Service Desk (SelfDesk)

If you want to add or modify another language then have a look at the following folder /opt/webadm/webapps/selfdesk/lang/.

-bash-4.2# ls -lha /opt/webadm/webapps/selfdesk/lang/
total 280K
drwxr-xr-x 2 root root 4.0K Feb 26 17:57 .
drwxr-xr-x 5 root root  148 Feb 26 17:56 ..
-rw-r--r-- 1 root root 1.1K Feb 22 12:55 appkeys.json
-rw-r--r-- 1 root root 2.0K Feb 22 12:55 appkeys_register.json
-rw-r--r-- 1 root root 1004 Feb 22 12:55 appkeys_unregister.json
-rw-r--r-- 1 root root  16K Feb 22 12:55 common.json
-rw-r--r-- 1 root root  517 Feb 22 12:55 drop_emergency.json
-rw-r--r-- 1 root root   20 Feb 22 12:55 drop_otplist.json
-rw-r--r-- 1 root root  419 Feb 22 12:55 drop_prefix.json
-rw-r--r-- 1 root root  394 Feb 22 12:55 edit_emergency.json
-rw-r--r-- 1 root root  448 Feb 22 12:55 edit_mailmode.json
-rw-r--r-- 1 root root  455 Feb 22 12:55 edit_otpfallback.json
-rw-r--r-- 1 root root  444 Feb 22 12:55 edit_otplength.json
-rw-r--r-- 1 root root  502 Feb 22 12:55 edit_otptimeout.json
-rw-r--r-- 1 root root  419 Feb 22 12:55 edit_otptype.json
-rw-r--r-- 1 root root 2.2K Feb 22 12:55 edit_password.json
-rw-r--r-- 1 root root 1.6K Feb 22 12:55 edit_pincode.json
-rw-r--r-- 1 root root 1020 Feb 22 12:55 edit_prefix.json
-rw-r--r-- 1 root root  369 Feb 22 12:55 edit_pushlogin.json
-rw-r--r-- 1 root root  361 Feb 22 12:55 edit_securemail.json
-rw-r--r-- 1 root root  397 Feb 22 12:55 edit_simplereg.json
-rw-r--r-- 1 root root  436 Feb 22 12:55 edit_smsmode.json
-rw-r--r-- 1 root root  423 Feb 22 12:55 edit_smstype.json
-rw-r--r-- 1 root root  340 Feb 22 12:55 edit_ssoenabled.json
-rw-r--r-- 1 root root  463 Feb 22 12:55 edit_ssotimeout.json
-rw-r--r-- 1 root root  840 Feb 22 12:55 edit_userinfos.json
-rw-r--r-- 1 root root 1.4K Feb 22 12:55 index.json
-rw-r--r-- 1 root root 1.5K Feb 22 12:55 login_pki.json
-rw-r--r-- 1 root root 2.2K Feb 22 12:55 login_uid.json
-rw-r--r-- 1 root root   20 Feb 22 12:55 logout.json
-rw-r--r-- 1 root root 1.4K Feb 22 12:55 openid.json
-rw-r--r-- 1 root root 7.1K Feb 22 12:55 openotp.json
-rw-r--r-- 1 root root 1.4K Feb 22 12:55 openotp_disable.json
-rw-r--r-- 1 root root 2.4K Feb 22 12:55 openotp_download.json
-rw-r--r-- 1 root root   20 Feb 22 12:55 openotp_listdrop.json
-rw-r--r-- 1 root root 1.2K Feb 22 12:55 openotp_listinit.json
-rw-r--r-- 1 root root  399 Feb 22 12:55 openotp_listview.json
-rw-r--r-- 1 root root  674 Feb 22 12:55 openotp_logintest.json
-rw-r--r-- 1 root root  13K Feb 22 12:55 openotp_register.json
-rw-r--r-- 1 root root 5.4K Feb 22 12:55 openotp_resync.json
-rw-r--r-- 1 root root  453 Feb 22 12:55 openotp_unblock.json
-rw-r--r-- 1 root root  139 Feb 22 12:55 openotp_unregister.json
-rw-r--r-- 1 root root 1.4K Feb 22 12:55 openu2f.json
-rw-r--r-- 1 root root 1.3K Feb 22 12:55 openu2f_logintest.json
-rw-r--r-- 1 root root 3.4K Feb 22 12:55 openu2f_register.json
-rw-r--r-- 1 root root  696 Feb 22 12:55 openu2f_removeall.json
-rw-r--r-- 1 root root  248 Feb 22 12:56 openu2f_unregister.json
-rw-r--r-- 1 root root 1013 Feb 22 12:56 pki.json
-rw-r--r-- 1 root root  331 Feb 22 12:56 pki_create_cert.json
-rw-r--r-- 1 root root  868 Feb 22 12:56 pki_find_cert.json
-rw-r--r-- 1 root root  450 Feb 22 12:56 pki_remove_cert.json
-rw-r--r-- 1 root root  314 Feb 22 12:56 pki_renew_cert.json
-rw-r--r-- 1 root root 4.0K Feb 22 12:56 spankey.json
-rw-r--r-- 1 root root 4.4K Feb 22 12:56 spankey_register.json
-rw-r--r-- 1 root root  977 Feb 22 12:56 spankey_unregister.json
-rw-r--r-- 1 root root  916 Feb 22 12:56 support.json
-rw-r--r-- 1 root root 3.0K Feb 22 12:56 tiqr.json
-rw-r--r-- 1 root root 1.5K Feb 22 12:56 tiqr_download.json
-rw-r--r-- 1 root root 1.5K Feb 22 12:56 tiqr_logintest.json
-rw-r--r-- 1 root root 1.9K Feb 22 12:56 tiqr_register.json
-rw-r--r-- 1 root root  436 Feb 22 12:56 tiqr_unblock.json
-rw-r--r-- 1 root root  614 Feb 22 12:56 tiqr_unregister.json
-bash-4.2# 

For example, to translate or modify the sentence Logout, edit the following file /opt/webadm/webapps/selfdesk/lang/common.json like below.

-bash-4.2# vi /opt/webadm/webapps/selfdesk/lang/common.json
{
        "Home": {
                "FR": "Accueil",
                "DE": "Willkommen"
        },
        "Logout": {
                "FR": "Déconnexion",
                "DE": "Ausloggen"
        },
...

Add a new language, for example DE, then modify languages="FR,DE" to the following file /opt/webadm/webapps/selfdesk/selfdesk.xml just like below.

-bash-4.2# vi /opt/webadm/webapps/selfdesk/selfdesk.xml
<?xml version="1.0" encoding="UTF-8" ?>

<!-- YOU SHOULD NOT NEED TO MODIFY THIS FILE -->

<WebApp name="SelfDesk"
        icon="selfdesk.png"
        version="1.1.8-1"
        wapi="51"
        section="Self-Service"
        license="freeware"
        languages="FR,DE"
        desc="User Self-Service Desk"
        help="Use this Web application to edit your account details, reset password, manage OTP tokens or FIDO devices...">
...

2.5 User Self-Registration (SelfReg)

Log into the WebADM GUI, under Applications, choose User Self-Registration (SelfReg) and click on CONFIGURE.

screenshot

Under Email & SMS Settings, one can change the Email Subject. Under Message Templates to find the other message templates for User Self-Registration (SelfReg). Here, the English message templates can be modified.

screenshot

If you want to add or modify another language then have a look at the following folder /opt/webadm/webapps/selfreg/lang/.

-bash-4.2# ls -lha /opt/webadm/webapps/selfreg/lang/
total 196K
drwxr-xr-x 2 root root 4.0K Feb 26 17:18 .
drwxr-xr-x 7 root root  203 Feb 26 17:23 ..
-rw-r--r-- 1 root root 1.2K Feb 22 12:56 appkeys.json
-rw-r--r-- 1 root root 2.0K Feb 22 12:56 appkeys_register.json
-rw-r--r-- 1 root root  848 Feb 22 12:56 appkeys_unregister.json
-rw-r--r-- 1 root root  470 Feb 22 12:56 cancel.json
-rw-r--r-- 1 root root  15K Feb 22 12:56 common.json
-rw-r--r-- 1 root root  419 Feb 22 12:56 drop_prefix.json
-rw-r--r-- 1 root root 1.7K Feb 22 12:56 edit_pincode.json
-rw-r--r-- 1 root root 1020 Feb 22 12:56 edit_prefix.json
-rw-r--r-- 1 root root 2.4K Feb 22 12:56 index.json
-rw-r--r-- 1 root root   20 Feb 22 12:56 login_pki.json
-rw-r--r-- 1 root root   20 Feb 22 12:56 login_uid.json
-rw-r--r-- 1 root root   89 Feb 22 12:56 logout.json
-rw-r--r-- 1 root root 5.3K Feb 22 12:56 openotp.json
-rw-r--r-- 1 root root 1.4K Feb 22 12:56 openotp_disable.json
-rw-r--r-- 1 root root 2.5K Feb 22 12:56 openotp_download.json
-rw-r--r-- 1 root root   20 Feb 22 12:56 openotp_endpoint.json
-rw-r--r-- 1 root root  273 Feb 22 12:56 openotp_listdrop.json
-rw-r--r-- 1 root root 1.4K Feb 22 12:56 openotp_listinfo.json
-rw-r--r-- 1 root root 1.3K Feb 22 12:56 openotp_listinit.json
-rw-r--r-- 1 root root  397 Feb 22 12:56 openotp_listview.json
-rw-r--r-- 1 root root  651 Feb 22 12:56 openotp_logintest.json
-rw-r--r-- 1 root root  13K Feb 22 12:56 openotp_register.json
-rw-r--r-- 1 root root 5.5K Feb 22 12:56 openotp_resync.json
-rw-r--r-- 1 root root  471 Feb 22 12:56 openotp_unblock.json
-rw-r--r-- 1 root root   20 Feb 22 12:56 openotp_unregister.json
-rw-r--r-- 1 root root 1.4K Feb 22 12:56 openu2f.json
-rw-r--r-- 1 root root 1.4K Feb 22 12:56 openu2f_logintest.json
-rw-r--r-- 1 root root 3.4K Feb 22 12:56 openu2f_register.json
-rw-r--r-- 1 root root  748 Feb 22 12:56 openu2f_removeall.json
-rw-r--r-- 1 root root  248 Feb 22 12:56 openu2f_unregister.json
-rw-r--r-- 1 root root 3.8K Feb 22 12:56 spankey.json
-rw-r--r-- 1 root root 4.5K Feb 22 12:56 spankey_register.json
-rw-r--r-- 1 root root  890 Feb 22 12:56 spankey_unregister.json
-rw-r--r-- 1 root root 3.1K Feb 22 12:56 tiqr.json
-rw-r--r-- 1 root root 1.5K Feb 22 12:56 tiqr_download.json
-rw-r--r-- 1 root root 1.2K Feb 22 12:56 tiqr_logintest.json
-rw-r--r-- 1 root root 1.9K Feb 22 12:56 tiqr_register.json
-rw-r--r-- 1 root root  436 Feb 22 12:56 tiqr_unblock.json
-rw-r--r-- 1 root root  614 Feb 22 12:56 tiqr_unregister.json

For example, to translate or modify the sentence One-time access ID is invalid, edit the following file /opt/webadm/webapps/selfreg/lang/common.json like below.

-bash-4.2# vi /opt/webadm/webapps/selfreg/lang/common.json
{
        "One-time access ID not provided": {
                "FR": "ID unique non fourni",
                "DE": "Einmalige Zugangs-ID nicht angegeben"
        },
        "One-time access ID is invalid": {
                "FR": "ID unique invalide",
                "DE": "Einmalige Zugriffs-ID ist ungültig"
        },
...

Add a new language, for example DE, then modify languages="FR,DE" to the following file /opt/webadm/webapps/selfreg/selfreg.xml just like below.

-bash-4.2# vi /opt/webadm/webapps/selfreg/selfreg.xml
<?xml version="1.0" encoding="UTF-8" ?>

<!-- YOU SHOULD NOT NEED TO MODIFY THIS FILE -->

<WebApp name="SelfReg"
        icon="selfreg.png"
        version="1.1.8"
        wapi="49" eapi="1"
        admcss="style.css"
        section="Self-Service"
        license="freeware"
        languages="FR,DE"
        desc="User Self-Registration"
        help="Use this Web application to self-register your OTP token or FIDO device after receiving a one-time email or SMS.">
...

2.6 OpenID & SAML Provider (OpenID)

If you want to add or modify another language then have a look at the following folder /opt/webadm/webapps/openid/lang/.

-bash-4.2# ls -lha /opt/webadm/webapps/openid/lang/
total 68K
drwxr-xr-x 2 root root  322 Feb 26 17:18 .
drwxr-xr-x 8 root root  197 Feb 26 17:23 ..
-rw-r--r-- 1 root root 1.5K Feb 22 12:54 appsso.json
-rw-r--r-- 1 root root 8.7K Feb 22 12:54 common.json
-rw-r--r-- 1 root root  340 Feb 22 12:54 edit_enabled.json
-rw-r--r-- 1 root root  443 Feb 22 12:54 edit_simplereg.json
-rw-r--r-- 1 root root  463 Feb 22 12:54 edit_timeout.json
-rw-r--r-- 1 root root 2.2K Feb 22 12:54 home.json
-rw-r--r-- 1 root root   21 Feb 22 12:54 index.json
-rw-r--r-- 1 root root 1.2K Feb 22 12:54 login_pki.json
-rw-r--r-- 1 root root   20 Feb 22 12:54 login_sso.json
-rw-r--r-- 1 root root  149 Feb 22 12:54 logout.json
-rw-r--r-- 1 root root  615 Feb 22 12:54 openotp.json
-rw-r--r-- 1 root root 1.2K Feb 22 12:54 tiqr.json
-rw-r--r-- 1 root root   20 Feb 22 12:54 tiqr_check.json
-rw-r--r-- 1 root root  832 Feb 22 12:54 tiqr_offline.json
-rw-r--r-- 1 root root  818 Feb 22 12:54 trust.json
-bash-4.2# 

For example, to translate or modify the sentence Server error, edit the following file /opt/webadm/webapps/openid/lang/common.json like below.

-bash-4.2# vi /opt/webadm/webapps/openid/lang/common.json
{
        "OpenOTP is not installed or configured": {
                "FR": "OpenOTP n'est pas installé ou configuré",
                "DE": "OpenOTP ist nicht installiert oder konfiguriert"
        },
        "Server error": {
                "FR": "Erreur du serveur",
                "DE": "Serverfehler"
        },
...

Add a new language, for example DE, then modify languages="FR,DE" to the following file /opt/webadm/webapps/openid/openid.xml just like below.

-bash-4.2# vi /opt/webadm/webapps/openid/openid.xml
<?xml version="1.0" encoding="UTF-8" ?>

<!-- YOU SHOULD NOT NEED TO MODIFY THIS FILE -->

<WebApp name="OpenID"
        version="1.3.0-1"
        wapi="50"
        section="Single Sign-On"
        license="freeware"
        languages="FR,DE"
        icon="openid.png"
        desc="OpenID &amp; SAML Provider"
        help="OpenID &amp; SAML single sign-on service (Identity Provider), supporting SAML2, OpenID-Connect and OAuth2.">
...

2.7 Localized Messages

To get an overview of all the message templates go to Databases and click on Localized Messages.

screenshot

Message templates for other languages can be added here. One can export/import as/from a CSV file. Click on Import from CSV file.

screenshot

The translation files for OpenOTP are located in the /opt/webadm/websrvs/openotp/doc/languages/ folder and for SpanKey in the /opt/webadm/websrvs/spankey/doc/languages/ folder.

-bash-4.2# ls -lha /opt/webadm/websrvs/openotp/doc/languages/
total 12K
drwxr-xr-x 2 root root   50 Mar  1 11:01 .
drwxr-xr-x 5 root root 4.0K Mar  1 11:01 ..
-rw-r--r-- 1 root root 1.8K Mar  1 11:01 OpenOTP-DE.csv
-rw-r--r-- 1 root root 1.6K Mar  1 11:01 OpenOTP-FR.csv
-bash-4.2# ls -lha /opt/webadm/websrvs/spankey/doc/languages/
total 8.0K
drwxr-xr-x  2 root root   50 Mar  1 11:01 .
drwxr-xr-x. 3 root root   85 Mar  1 11:01 ..
-rw-r--r--  1 root root 1.2K Mar  1 11:01 SpanKey-DE.csv
-rw-r--r--  1 root root 1.2K Mar  1 11:01 SpanKey-FR.csv
-bash-4.2# 

screenshot screenshot screenshot

Per default, only the languages “EN”,“FR”,“DE”,“ES”,“IT”,“FI” are available. However, one can add more by adding it to /opt/webadm/conf/webadm.conf. For example, “LU” for luxembourgish. Afterward, restart WebADM with /opt/webadm/bin/webadm restart.

-bash-4.2# vi /opt/webadm/conf/webadm.conf
#
# WebADM Server Configuration
#
...
# Application languages
languages "EN","FR","DE","ES","IT","FI","LU"
...

screenshot

2.8 Custom Messages

To modify any English or other language message templates.

For example: To change the “OTP Password:” to “OTP Token:” in the Secure Password Reset log in webpage.

screenshot

First, create the custom.json file, modify it like below and save it.

-bash-4.2# cp /opt/webadm/webapps/pwreset/lang/openotp.json /opt/webadm/webapps/pwreset/lang/custom.json
-bash-4.2# vi /opt/webadm/webapps/pwreset/lang/custom.json"
{
	"OTP Password:": {
		"EN": "OTP Token:",
		"FR": "OTP Token:",
		"DE": "OTP Token:"
	}
}

Afterward, clear the WebADM System Caches WebADM GUI > Admin > Clear WebADM System Caches.