stoney cloud: Notification Architecture

Overview

The pages describes the notification architecture.

Requirements

OpenLDAP directory

Each service needs a notification entry in the form of:

dn: ou=notifications,uid=<RESELLER>,ou=reseller,ou=configuration,ou=<SERVICE>,ou=services,dc=stoney-cloud,dc=org

a settings entry in the form of:

dn: ou=settings,uid=<RESELLER>,ou=reseller,ou=configuration,ou=<SERVICE>,ou=services,dc=stoney-cloud,dc=org

and one or more template entries in the form of:

 dn: ou=<PROBLEM>,ou=templates,uid=<RESELLER>,ou=reseller,ou=configuration,ou=<SERVICE>,ou=services,dc=stoney-cloud,dc=org

The following example shows the backup service notification entry for the reseller with the uid 4000000:

dn: ou=notifications,uid=4000000,ou=reseller,ou=configuration,ou=backup,ou=services,dc=stoney-cloud,dc=org
objectclass: top
objectclass: organizationalUnit
objectclass: sstNotificationObjectClass
ou: notifications
description: The sub tree stores the notification information for the (online) backup service for the reseller Reseller Ltd. with the uid 4000000. This information is used independently of the notification settings of the users.
sstMailTo: Support stepping stone GmbH <support@stepping-stone.ch>
sstNotificationWarning: quota
sstNotificationWarning: schedule
sstNotificationWarning: unsuccessful

Where

• sstMailTo is the e-mail address to which the reseller notifications are sent
• sstNotificationWarning indicates which notifications should be sent to the specified address (sstMailTo), in this the, the reseller would receive notifications concerning:
  • backup quota
  • backup schedule
  • backup unseccessful

The following example shows the backup service settings entry for the reseller with the uid 4000000:

dn: ou=settings,uid=4000000,ou=reseller,ou=configuration,ou=backup,ou=services,o=stepping-stone,c=ch
description: This sub tree stores the information about what can be modified in which scope.
objectClass: top
objectClass: organizationalUnit
objectClass: sstServiceSettingsObjectClass
ou: settings
preferredLanguage: de-CH
sstMailFrom: Support stepping stone GmbH <support@stepping-stone.ch>
...

Where

• sstMailFrom is the e-mail address where the notification mail comes from
• preferredLanguage the language in which the mail will be sent to the reseller

The following example shows the backup service quota template entry for the reseller with the uid 4000000:.

dn: ou=quota,ou=templates,uid=4000000,ou=reseller,ou=configuration,ou=backup,ou=services,o=stepping-stone,c=ch
description: This leaf contains the quota templates for the (online) backup service.
objectClass: top
objectClass: organizationalUnit
objectClass: sstTemplateSetup
ou: quota
sstMailFrom: Support stepping stone GmbH <support@stepping-stone.ch>
sstMailTemplate: file:///var/www/selfcare/htdocs/themes/selfcare.stepping-stone.ch/templates/services/backup/quota/quota_mail
sstMailTemplateFormatSource: txt
sstMailTemplateFormatTarget: txt
sstMailTemplateReseller: file:///var/www/selfcare/htdocs/themes/selfcare.stepping-stone.ch/templates/services/backup/quota/quota_mail_reseller
sstMailTemplateResellerFormatSource: txt
sstMailTemplateResellerFormatTarget: txt

Where

• sstMailFrom is the e-mail address where the notification mail comes from
• sstMailTemplate is the path to the notification mail (the one which is sent to the user) template
• sstMailTemplateFormatSource is the format (file ending) of the notification mail (the one which is sent to the user) template
• sstMailTemplateFormatTarget is the format (file ending) of the notification mail (the one which is sent to the user) text (all placeholders from the template are now replaced)
• sstMailTemplateReseller is the path to the notification mail (the one which is sent to the reseller) template
• sstMailTemplateResellerFormatSource is the format (file ending) of the notification mail (the one which is sent to the reseller) template
• sstMailTemplateResellerFormatTarget is the format (file ending) of the notification mail (the one which is sent to the reseller) text (all placeholders from the template are now replaced)

Source Code

The source code is located in our GitHub Repository:

https://github.com/stepping-stone/notification