Skip to end of metadata
Go to start of metadata

Introduction

The mobilEcho Client Management system is used to manage your mobilEcho clients’ access to your mobilEcho servers and to configure mobilEcho client security and application settings.

Users are added to the client management system using a PIN number that is included in an invitation email sent by the mobilEcho Client Management server.

mobilEcho uses a default template for this email. If you would like to customize the contents of this email, you can edit the files containing these templates.

Note:

Edited templates are not updated automatically by future mobilEcho version upgrades
If you manually edit the email template files, they will not be updated automatically when you install future versions of mobilEcho on your server. We recommend you replace your email template files with the originals, or simple rename your edited versions before upgrading mobilEcho server, so that the new versions will be installed if necessary. Once installation completes, you can view the new template files and make any necessary changes, or simply go back to using your old custom templates if appropriate.

Editing the email templates

There are two invitation email templates: one in HTML format and one in plain text format. Both are included in the invitation email sent to your users. Normally users should see the HTML version, but in the case that their email client does not support HTML, they will see the plain text version.

These files are located in a folder within the mobilEcho Server program directory on the mobilEcho Client Management server.

The location of this folder is typically:

C:\Program Files\Group Logic\mobilEcho Server\ManagementUI\app\views\user_mailer\

In the “user_mailer” folder are two files:

  • invite.html.erb
  • invite.txt.erb

These files can be customized with any valid HTML or plain text. It is recommended that you make a backup copy of the original files before you edit them.

There are 4 variables that can be used within these files. Ensure that you continue to include these variables in your template, as the are necessary for the client enrollment process.

Available Variables

User’s email address:      <%= @invitation.email %>
User’s PIN:      <%= @invitation.pin %>
Management server address:      <%= @management_server_address %>
PIN expiration date:      <%= @expiration %>
mobilEcho URL:      <%= @url %>
Username:      <%= @invitation.user %>
Note:

Once you’ve finished editing the invitation email template files, a restart of the mobilEcho Management service is required in order for the changes to take effect. This can be done from the Windows Services control panel.

Configuring custom invitation emails

You can configure your own invitation emails. To do so, navigate to C:\Program Files (x86)\Group Logic\mobilEcho Server\ManagementUI\config\locales\views\mailers and choose one of these files:

  • de.yml - This is the file for German invitations.
  • en.yml - This is the file for English invitations.
  • fr.yml - This is the file for French invitations.
  • ja.yml  - This is the file for Japanese invitations.

You can create your own, custom invitations, by editing these files to suit your preferences. You should edit only the text in brackets ("this") as the rest are keywords for the mobilEcho server. Click on the links to download the defaults.

Note:

When upgrading mobilEcho server, the custom invitations will not be upgraded. They will continue to use your custom text but the Subject will be localized.

Editing the email subject

Since mobilEcho 4.2 there is a new config file dealing with the localization of the Subject text in mobilEcho invitation emails. 

The English enrollment email subject can be customized in the C:\Program Files (x86)\Group Logic\mobilEcho Server\ManagementUI\mobilEcho_management.cfg file.

The rest of the languages are located in C:\Program Files (x86)\Group Logic\mobilEcho Server\ManagementUI\mobilEcho_manager_intl.cfg 

If you would like to customize the enrollment email Subject text for French, German, or Japanese, these setting are in the mobilEcho_manager_intl.cfg fileIf you have a mobilEcho client in French, German, Japanese or English, you need to have the Windows language pack for the required languages installed on your server in order for the client to receive some of the possible error messages in their native language. 

 Click here to expand mobilEcho_manager.intl.cfg
Note:

 These changes will take effect after you restart the mobilEcho Management service.

Note:

The file should be saved using the UTF-8 encoding.

Labels
  • None