Changes
/* Overview */
= Overview =
The pages describes the basic notification architectureand framework.* Fetches Its main goal is to provide a script (class) which implements all generic methods used by the txt different [[:Category:Self-Service Modules|Self-Service Modules]] to inform the user and/or odt templates used for the user mail reseller. When instantiating the notification object, you only need to provide three parameters: * The product/service UID (expendable with other methods like SMSe.g. 4000004) notifications* The service name (e.g. "backup")* The problem name (e.g."quota") According to these three parameters the notification script# Gets the reseller according to the product/service UID from the LDAP directory# Gets the user and reseller template files (template path and file-ending) from the LDAP directory and according to the reseller# Uses this template-file to instantiate a perl-template object# Creates an empty replace-hash#:This empty hash must be set by the [[:Category:Self-Service Modules|Self-Service Module]] script, using the <code>setReplaceHash</code> method.# Checks if the user should be informed about the given problem (according to the LDAP directory)#* If the user should be informed:#** Gets the E-Mail address which should be used to inform the user (according to the LDAP directory)#** Fills in the user template using the replace-hash#** Sends the mail (in future it will be possible to use SMS instead) to the given address# Checks if the reseller wants to be informed (according to the LDAP)#** Gets the E-Mail address which should be used to inform the reseller (according to the LDAP directory)#** Fills in the reseller template using the replace-hash#** Sends the mail (in future it will be possible to use SMS instead) to the given address
The following [[:Category:Self-Service Modules|Self-Service Modules]] depend on this notification framework:
* [[stoney backup: Notification Overview]]: Warns the user when the backup is running out of space (quota), if the backup wasn't executed at the planned time (schedule) and if the backup was executed, but finished with errors (unsuccessful).
= Requirements =
