= Configuration =
The notification needs the following configuration:
* Notification
** Backend_service_base: The base object in the backend (LDAP) which contains all services
** People_base: The base object in the backend (LDAP) which contains all people
** Resller_base: The base object in the backend (LDAP) which contains all reseller
** Default_mail_to: If something goes terribly wrong and no-one can be informed write a mail to this address
* Mail
** Host: The mail host to use to send the notification messages
** Port: The corresponding port
** Username: The username to authenticate on the mail host
** Password: The corresponding password
For example:
<pre>
[Notification]
Backend_service_base = ou=services,dc=stoney-cloud,dc=org
People_base = ou=people,dc=stoney-cloud,dc=org
Reseller_base = ou=reseller,dc=stoney-cloud,dc=org
Default_mail_to = support@stoney-cloud.org
[Mail]
Host = mail.tombstone.org
Port = 587
Username = <Sender-Email-Adderss>
Password = verysecret
</pre>
= Graphical Workflow =
[[File:Notification-workflow.jpeg|500px800px|thumbnail|none|Figure 1: Workflow for the general notification process]]
You can modify/update these interactions by editing [[File:Notification-workflow.xmi]] (you may need [http://uml.sourceforge.net/ Umbrello UML Modeller] diagram programme for KDE to display the content properly).
= How to use the Notification.pm module =
Given the set up described in section [[#Requirements | requirements]]: <br/>
Suppose you have the <code><Service></code> "notification" and the <code><Problem></code> "test". The template referenced in the LDAP (<code>ou=test,ou=templates,uid=<RESELLER>,ou=reseller,ou=configuration,ou=notification,ou=services,dc=stoney-cloud,dc=org</code>) looks like(the notification module uses the perl module [http://search.cpan.org/~mjd/Text-Template-1.46/lib/Text/Template.pm Text::Template]):
<pre>
Hello {$name}