stoney cloud: Notification Architecture - Revision history

Michael: /* Graphical Workflow */

2014-06-27T14:11:24Z

Graphical Workflow

← Older revision		Revision as of 16:11, 27 June 2014
Line 134:		Line 134:
	= Graphical Workflow =		= Graphical Workflow =

	[[File:Notification-workflow.jpeg\|~~500px~~\|thumbnail\|none\|Figure 1: Workflow for the general notification process]]		[[File:Notification-workflow.jpeg\|800px\|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).		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).

2014-06-20T09:31:50Z

Configuration

← Older revision		Revision as of 11:31, 20 June 2014
Line 106:		Line 106:

	= Configuration =		= 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 =		= Graphical Workflow =

2014-06-20T08:52:30Z

How to use the Notification.pm module

← Older revision		Revision as of 10:52, 20 June 2014
Line 115:		Line 115:
	= How to use the Notification.pm module =		= How to use the Notification.pm module =
	Given the set up described in section [[#Requirements \| requirements]]: <br/>		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:		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>		<pre>
	Hello {$name}		Hello {$name}

2014-06-20T08:51:09Z

How to use the Notification.pm module

← Older revision		Revision as of 10:51, 20 June 2014
Line 117:		Line 117:
	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:		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:
	<pre>		<pre>
	Hello {name}		Hello {$name}

	This is a notification test from {hostname}		This is a notification test from {$hostname}

	Cheers		Cheers
	{writer}		{$writer}
	</pre>		</pre>
	You can now write a very simple perl script which will inform the user and the reseller for the service "notification" and the problem "test". All you need to do is:		You can now write a very simple perl script which will inform the user and the reseller for the service "notification" and the problem "test". All you need to do is:

2014-06-20T08:50:36Z

Graphical Workflow

← Older revision		Revision as of 10:50, 20 June 2014
Line 104:		Line 104:
	== File System ==		== File System ==
	In addition to the above explained LDAP Directory entries, the templates specified in '''sstMailTemplate''' and '''sstMailTemplateReseller''' must be present on the local file system. The notification script would throw an warning if they do not exist (or have wrong permission), but for the notification to work they must be present.		In addition to the above explained LDAP Directory entries, the templates specified in '''sstMailTemplate''' and '''sstMailTemplateReseller''' must be present on the local file system. The notification script would throw an warning if they do not exist (or have wrong permission), but for the notification to work they must be present.

			= Configuration =

	= Graphical Workflow =		= Graphical Workflow =

2014-06-20T08:49:48Z

How to use the Notification.pm module

@@ Line 159: / Line 159: @@
 $notification->notify();
 </source>
 = Source Code =

2014-06-20T08:38:40Z

How to use the Notification.pm module

2014-06-20T08:37:41Z

How to use the Notification.pm module

← Older revision		Revision as of 10:37, 20 June 2014
Line 130:		Line 130:
	<source lang="perl">		<source lang="perl">
	my $notification = Notification->new( service => "notification",		my $notification = Notification->new( service => "notification",
	problem => "test",		problem => "test",
	product_uid => $uid,		product_uid => $uid,
	);		);
	</source>		</source>

2014-06-20T08:36:40Z

How to use the Notification.pm module

@@ Line 120: / Line 120: @@
 Cheers
-Sysadm
+{writer}
 </pre>
 You can now write a very simple perl script which will inform the user and the reseller for the service "notification" and the problem "test". All you need to do is:
@@ Line 141: / Line 141: @@
                                   $ldap_bind_pw,
                                 );
 </source>

2014-06-20T08:31:51Z

How to use the Notification.pm module

← Older revision		Revision as of 10:31, 20 June 2014
Line 136:		Line 136:
	* Tell the notification module to connect to the LDAP backend		* Tell the notification module to connect to the LDAP backend
	<source lang="perl">		<source lang="perl">
	~~# Connect to the backend~~
	$notification->connectToBackend( $ldap_server,		$notification->connectToBackend( $ldap_server,
	$ldap_port,		$ldap_port,