Notifications | SBC Online Help

Purpose

SBC sends out email notifications to users in various scenarios. A proper configuration of the SMTP server is a prerequisite for any notification.

Via “Contact” users can send a message to the support contact defined for their organisation.

Furthermore, SBC uses notifications to send system-generated emails when related events occur. The email templates described below are used for this purpose.

Who receives a notification

Depending on the type of notification, it is sent to:

the user, who is doing an action or affected by the change, or
the user’s support contact, or
the global support email.

These terms are used in the further explanations below.

The global support email is defined at Settings > System > General as “Support email”. It is one central email address for the whole system. It is recommended to use a support@ or info@ general email of your organisation instead of personal email addresses of individuals. If required, additional addresses can be defined in the field “Forward incoming emails“.

The user’s support contact depends on the global system setting “Enable redirect of contact email requests“ (see Settings > System > Notifications).

If this setting is enabled, the message is sent to the support email of the organisation it belongs to. If this support email is empty, it is sent to the parent organisation, and so on. If no organisation in the hierarchy has a support email defined, it is sent to the global support email (see above).
If this setting is disabled, it is sent to the global support email (see above).

If the global support email is not defined, the messages will not be delivered.

Contact

The Contact form allows any user to reach an administrative user. It mainly targets End Users seeking support.

The message is sent to the user’s support contact.

Email Templates

SBC includes predefined email templates that are automatically sent when related events occur. These templates contain subject and body sections defined in HTML files, included with the SBC installation and stored in the appropriate language directory.

Example

..\SBC\Leica.Spider.BusinessCenter.CentralServer\Resources\<Language Code>\mails\InstallationDefaults\

The SBC distribution installs all available languages to your computer. This also contains the email templates. Notification emails are sent in the preferred language of the recipient if the template exists in this language. Otherwise, the email is sent in English.

The following table shows the relation between event, recipient, and used email template:

Event	Recipient	Name of email template
Test Email	User	TestEmail.html
Forgotten password	User	ForgottenPassword.html
New User Registration	Email to User after he finished the Registration Form Email to User after User pressed the registration activation link within 5 days Email to user’s support contact after User pressed the registration activation link within 5 days	NewUserRegistration.html ConfirmedRegistrationUser.html ConfirmedRegistrationAdministrator.html
New / Renew a package subscription	Email to User after User has requested a new subscription Email to user’s support contact after user has requested a new subscription Email to User after the subscription order has been processed	RequestedSubscriptionUser.html RequestedSubscriptionAdministrator.html ActivatedSubscriptionUser.html
Contact message	User’s support contact Carbon copy to user	ContactMessageAdministrator.html ContactMessageCCUser.html
Subscription expiry	Email to user – Subscription will expire in 2 / 14 days Email to user – Subscription has expired	SubscriptionExpiryWarningUser.html SubscriptionExpiredUser.html
User details changed by user	User’s support contact	UpdatedUserDetailsAdministrator.html
User made a request with one of the Post-Processing services, which either finished or failed	User	CoordinateComputationFailedUser.html CoordinateComputationFinishedUser.html CoordinateTransformationFailedUser.html CoordinateTransformationFinishedUser.html RinexDataRequestFailedUser.html RinexDataRequestFinishedUser.html VRinexDataRequestFailedUser.html VRinexDataRequestFinishedUser.html

Supported Email Template Keywords

The following lists all keywords that are used by SBC email 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.
%RequestTime%	Used in X-pos related emails to show the time the request was made.
%PostProcessingResultsLink%	Used to provide a direct link for X-pos related emails to the results page of SBC.

Customisation of email templates

SBC supports customization of predefined email templates that are automatically sent by the system when related events are raised. The email 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\Leica.Spider.BusinessCenter.CentralServer\Resources\<Language Code>\mails“. The emails 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.

Restart the SBC Central Server after placing new or modified customised files in the folder to apply the changes.

Hints for editing the templates

Always edit the files in folder “..\SBC\Leica.Spider.BusinessCenter.CentralServer\Resources\<Language Code>\mails”.
Use a standard text editor to edit the HTML-formatted files, so you will see all actual HTML code. Use a standard Internet browser to verify the layout of the result.
Do not modify any file name of email template file.
Do not modify any Template Keywords within the text.

If the latest default templates shall be used again, then the customized ones must be replaced with the files from the “InstallationDefaults” subfolder.

Hints for translating the templates

In case the desired language folder “..\SBC\Leica.Spider.BusinessCenter.CentralServer\Resources\<Language Code>” is empty and does not contain a “mails” subfolder, one can translate the templates themselves.

Start translating using the English default templates from folder “..\SBC\Leica.Spider.BusinessCenter.CentralServer\Resources\en\mails\InstallationDefaults\“ and copy them to “..\SBC\Leica.Spider.BusinessCenter.CentralServer\Resources\<Language Code>\mails”.
Use a standard text editor to edit the HTML-formatted files, so you will see all actual HTML code. Use a standard Internet browser to verify the layout of the result.
Do not modify any file name of email template file.
Do not modify any Template Keywords within the text.
In order to translate the email subject properly, edit the text in the very first line starting with “Subject:”. Do not translate the keyword “Subject:”, but only start translating after the colon.