Paul at 14:40, 1 February 2013

2013-02-01T14:40:02Z

Paul: Created page with "'''ClearQuest Email Notification Package''' '''Creating first notification rule''' == Minimum configuration == Detailed package configuration instructio..."

2011-08-22T19:39:07Z

Created page with "<big>'''ClearQuest Email Notification Package'''</big> <big>'''Creating first notification rule'''</big> == Minimum configuration == Detailed package configuration instructio..."

New page

<big>'''ClearQuest Email Notification Package'''</big>

<big>'''Creating first notification rule'''</big>

== Minimum configuration ==
Detailed package configuration instructions can be found [[Package_configuration | here]]

At least two database propertied must be defined to start using the package:
# '''email_host''' - SMTP relay name, the host that will accept generated emails for delivery
# '''email_enabled''' - should be set to 1 to enable email notifications

Open ClearQuest and configure package according to package configuration instructions

submit properties (udb_property records):
[[Image:submit_properties.jpg | none ]]

=== Set mail_host = your SMTP host ===
[[Image:email_host.jpg]]

=== Set email_enabled = 1 ===

Second mandatory property besides mail_host. Notifications will not be generated is the property is not set!

Submit udb_property record, set name to '''email_enabled''' and value '''1''', click OK to commit property to the database.

=== Set other properties if required ===
Check other available properties in the [[Package_configuration | configuration guide]]

=== Create simple notification rule ===

In this example, we will define a rule to notify submitted that defect is closed. We are using standard Defect record from "Defect Tracking" schema.

[[Image:submit_Email_Notification_Rule.jpg]]

Create new email_notification_rule record

[[Image:en_1.jpg]]

Set name to some unique value, "Notify Submitter", and record type field to "Defect" (the package must be applied for this record type). Action "Close" will trigger notification, because we specified it in the "Actions" field.

[[Image:en_2.jpg]]

The email is going to be sent to submitter, and we use "$Submitter.email" variable (extracting email from Submitter ClearQuest reference field). We can also add some statics email addresses here as free text, one email address per line, not other delimiters, i.e.
$owner.email
my_favorite_email_address@my.domain.com

[[Image:en_3.jpg]]

We are using free text with embedded ClearQuest record fields to format email body.

=== Test created notification rule ===
Close a defect, and check if email was created and sent properly.
You can use existing or create new query for en_email_message record type to check email queue,

[[Category:Email_Notification_Package]]

← Older revision		Revision as of 14:40, 1 February 2013
Line 60:		Line 60:


−	[[Category:Email_Notification_Package]]	+
		+	[[Category:Rational]] [[Category:Email_Notification_Package]]

EmailNotification Creating First Notification Rule - Revision history

Paul at 14:40, 1 February 2013

Paul: Created page with "'''ClearQuest Email Notification Package''' '''Creating first notification rule''' == Minimum configuration == Detailed package configuration instructio..."