SBC sends out E-mail notifications to users at various scenarios. A proper configuration of the E-mail server is a pre-requisite for any notification.
Via “Tools > Notifications” on the admin portal SBC Administrators, Operators and Support Viewers can either contact a single user, multiple user or user groups. E-mails are sent out in plain text format separately to each user. It does not use CC or BCC. A copy will also be sent to the specific admin portal user who contacts the user.
Via “Contact” on the user portal, users can send a message to the organisation managing the network. All the Administrators, Operators and Support Viewers will be notified when a user contacts SBC operators with a copy being sent to user.
Furthermore, SBC uses the notification to send e-mails automatically by the system when related events are raised. Therefore, see next section.
SBC supports a number of predefined E-mail templates that are automatically sent by the system when related events are raised. The templates consist of subject and body that are predefined in HTML formatted text files. They are coming with the SBC installation, stored in the related language directory.
Example
...\SBC\SBCCentralServer\ <Language Code> \mails\<template.html>
The SBC distribution installs all available languages to your computer. This also contains the E-mail templates. Notification E-mails are sent in the preferred language of the recipient if the template exists in this language. Otherwise, the E-mail is sent in English. The “Test E-mail” is sent in the default language (defined at Settings > System > General) to all administrators, independent of their preferred language.
The following table is showing the relation between event and used E-mail template.
| Event | Recipient | Name of E-mail template | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Test E-mail | Administrators | TestEmail.html | ||||||||
| Forgotten password | User | ForgottenPassword.html | ||||||||
| New User Registration |
|
|
||||||||
| New / Renew a package subscription |
|
|
||||||||
| Contact message |
|
|
||||||||
| Subscription expiry |
|
|
||||||||
| User details changed by user | Administrators | UpdatedUserDetailsAdministrator.html | ||||||||
| Administrator contacts individual user | User | AdminMessageToUser.html | ||||||||
| Administrator contacts group of users | Group of users | AdminMessageToUserGroup.html | ||||||||
| User made a request with one of the Post-Processing services, which either finished or failed | User |
|
The following lists all keywords that are used by SBC E-mail templates. All keywords start and end with the percentage sign.
| Keyword | Function |
|---|---|
| %NetworkName% | Agency or Network name |
| %ReplyEmailAddress% | Administrator E-mail address |
| %ServerName% | Hostname of SBC central server |
| %UserFirstName% | First name of user |
| %UserLastName% | Last name of user |
| %UserID% | User-ID of user |
| %NetworkURL% | SBC Frontend URL |
| %ActivationConfirmationLink% | Automatically generated by SBC for user auto registration |
| %PasswordRecoveryLink% | Link for a password recovery |
| %PasswordRecoveryLinkExpiration% | Time when password recovery link expires |
| %UserEmailAddress% | E-mail address of user |
| %Language% | Preferred language of user |
| %ContactMessageText% | Contact message posted by user to SBC administrators |
| %NumExpireDays% | Remaining days until a package subscription will expire |
| %OrderNumber% | Automatically generated subscription order number |
| %Company% | Users company or organisation |
| %GPUID1% | User-ID for GPUID authentication |
| %GPUID2% | Password for GPUID authentication |
| %RoverPhoneNumber% | User’s phone number for dial-in authentication |
| %RoverHostName% | User’s host name for host name authentication |
| %SubscriptionName% | Name of the package(s) a user has subscribed to |
| %DynamicEntries% | Contains the list of all dynamic entries configured at the profile template. |
| %Subject% | Subject text as entered by the SBC administrator. Only supported in E-mail template AdminMessageToUser.html and AdminMessageToUserGroup.html. |
SBC supports customization of predefined E-mail templates that are automatically sent by the system when related events are raised. The E-mail templates can also be translated, in case no default translation is provided.
The HTML formatted template files are placed in the SBC Central Server machine in the installation directory subfolder “...\SBC\SBCCentralServer\ <Language Code> \mails\”. The E-Mails sent by SBC will be generated using the files from this folder. The subfolder “InstallationDefaults” contains the default template files as provided by Leica Geosystems. Those files will be overwritten with an upgrade of SBC, while the potentially customized files in the main folder will be kept.
If the latest default templates shall be used again, then the customized ones must be replaced with the files from the “InstallationDefaults” subfolder.
In case the desired language folder “..\SBC\SBCCentralServer\< Language Code>” is empty and does not contain a “mails” subfolder, one can translate the templates themselves.