Notification Examples - Revision history

Paul at 14:44, 1 February 2013

2013-02-01T14:44:29Z

Paul at 18:51, 5 June 2012

2012-06-05T18:51:15Z

Paul at 18:26, 5 June 2012

2012-06-05T18:26:25Z

Show changes

Paul: /* Sending Emails with Attachments */

2011-11-13T22:43:35Z

‎Sending Emails with Attachments

Paul at 22:33, 13 November 2011

2011-11-13T22:33:30Z

Paul at 01:52, 22 August 2011

2011-08-22T01:52:03Z

Paul at 20:10, 21 August 2011

2011-08-21T20:10:27Z

Paul: 1 revision

2010-11-05T00:28:08Z

1 revision

Paul at 04:11, 11 December 2008

2008-12-11T04:11:37Z

New page

<center><big>'''<big>Examples</big>'''</big> </center>

== Defect state updates ==
Send notification to submitter ('Submitter' CQ field - reference to users) when Defect is postponed (with action postpone), rejected (with action reject) or closed (action close). Do not send notification if submitter is the same user that perform action to avoid email flooding. We have to test notification rule in test database and migrate it to production without changes (database name in http link should be updated automatically). lets define two functions in database properties: udb_property records: 

{| width="100%" border="1" cellspacing="2" cellpadding="2"
! width="20%" valign="top" | Name 
! valign="top" | nm_value 
|-
| width="20%" valign="top" | GetUserLoginName 
| valign="top" | <source lang="perl"> return $session->GetUserLoginName();</source>
|-
| width="20%" valign="top" | GetCurrentDatabaseName 
| valign="top" | <source lang="perl">
my $dbname = $session->GetSessionDatabase()->GetDatabaseName();
return $dbname;</source>
|}

 Email_Notification_Rule fields: 

{| width="100%" border="1" cellspacing="2" cellpadding="2"
! width="20%" valign="top" | Form Field Name (CQ field name) 
! valign="top" | Value 
|-
| width="20%" valign="top" | Name (name) 
| valign="top" | State change submitter notification (any unique name) 
|-
| width="20%" valign="top" | Record Type (Entity_Def) 
| valign="top" | Defect 
|-
| width="20%" valign="top" | Actions (actions) 
| valign="top" | Postpone Reject Close 
|-
| width="20%" valign="top" | Condition (Msg_Condition) 
| valign="top" | '''GetUserLoginName()''' ne '''$Submitter''' 
|-
| valign="top" | To (Msg_To_Users) 
| valign="top" | '''$Submitter.email''' 
|-
| valign="top" | Subject (Msg_Subject) 
| valign="top" | Your Defect ''''$ID'''' has been '''${state}'''. 
|-
| valign="top" | Body (Msg_Body) 
| valign="top" | Your Defect ''''$ID'''' has been '''${state}'''. Defect title: ''''$Headline'''' <nowiki>http://newcqweb-server/cqweb/main?USE_CASE=GO&service=CQ&schema=DBSET&contextid=</nowiki>'''GetCurrentDatabaseName()'''&entityID='''${dbid}'''&entityDefName=Defect 
|}

 Subject will be evaluated when email notification is triggered, for example: "Your Defect 'SAMPL00000001' has been Rejected." We use ${State} notation for state field to avoid ambiguity, because it is followed by '.' (valid symbol for variable name). 

== Using SQL query ==
Send notification to clearquest user group 'CCB_Approvers' and submitter when request been resolved 

{| width="100%" border="1" cellspacing="2" cellpadding="2"
! width="20%" valign="top" | Form Field Name (CQ field name) 
! valign="top" | Value 
|-
| width="20%" valign="top" | Name (name) 
| valign="top" | Resolution Notification (any unique name) 
|-
| width="20%" valign="top" | Record Type (Entity_Def) 
| valign="top" | Defect 
|-
| width="20%" valign="top" | Actions (actions) 
| valign="top" | Resolve 
|-
| valign="top" | To (Msg_To_Users) 
| valign="top" | '''$Submitter.email SQL("SELECT T2.email FROM parent_child_links T1, groups T3, users T2 WHERE T1.parent_dbid = T2.dbid AND T1.child_dbid = T3.dbid AND T3.name = 'CCB_Approvers' AND T2.is_active = 1") '''
|-
| valign="top" | Subject (Msg_Subject) 
| valign="top" | Defect ''''$ID'''' has been resolved. Resolution ''''$Resolution'''' 
|-
| valign="top" | Body (Msg_Body) 
| valign="top" | Defect ''''$ID'''' has been resolved. Defect title: ''''$Headline'''' Resolution: ''''$Resolution'''' Description: '''$Description''' <nowiki>http://newcqweb-server/cqweb/main?USE_CASE=GO&service=CQ&schema=DBSET&contextid=</nowiki>'''GetCurrentDatabaseName()'''&entityID='''${dbid}'''&entityDefName=Defect 
|}

 You can also create reusable function and put it into properties udb_property record 

{| width="100%" border="1" cellspacing="2" cellpadding="2"
! width="20%" valign="top" | Name 
! valign="top" | nm_value 
|-
| width="20%" valign="top" | GetGroupEmailAddresses 
| valign="top" | <source lang="perl"> my ($groupname) = @_;
my $return_string;

# SQL statement
my $result_set = $session->BuildSQLQuery(
"SELECT T2.email
FROM parent_child_links T1, groups T3, users T2
WHERE T1.parent_dbid = T2.dbid
AND T1.child_dbid = T3.dbid
AND T3.name = '$groupname'
AND T2.is_active = 1");

$result_set->Execute();
# fetch email addresses
while( $result_set->MoveNext() == $CQPerlExt::CQ_SUCCESS ){
my $tmp_str = $result_set->GetColumnValue(1);
$return_string .= "$tmp_str\n";
}
# clear 'errors'
$result_set = undef;
$@ = '';

return $return_string;</source>
|}

 In this case 'To' field in Notification rule could be changed to: 

{| width="100%" border="1" cellspacing="2" cellpadding="2"
! width="20%" valign="top" | Form Field Name (CQ field name) 
! valign="top" | Value 
|-
| valign="top" | To (Msg_To_Users) 
| valign="top" | '''$Submitter.email GetGroupEmailAddresses( 'CCB_Approvers' ) '''
|}
 

== SQL query and dynamically assigned message priority ==
To simplify defect management, we use assignment or functional group idea. Defect submitters do not know who is responsible for particular feature, but can guess, what functional area is. Submitter needs to select Assignment group only. We need to notify Assignment group manager(s) about new defect assigned to group. If defect Severity is '1-Critical' or Priority is '1-Resolve Immediately', email message has to be flagged as 'High Priority'. Possible AssignmentGroups stateless record type implementation: 

{| style="width: 60%; text-align: left" border="1" cellspacing="2" cellpadding="2"
| style="vertical-align: top; width: 15%" | '''Name '''
| style="vertical-align: top; width: 25%" | SHORT_STRING 
| style="vertical-align: top" | Unique group name
|-
| style="vertical-align: top; width: 15%" | '''Managers '''
| style="vertical-align: top; width: 25%" | REFERENCE to users 
| style="vertical-align: top" | group managers
|-
| style="vertical-align: top; width: 15%" | '''Users '''
| style="vertical-align: top; width: 25%" | REFERENCE to users
| style="vertical-align: top" | group members
|-
| style="vertical-align: top; width: 15%" | '''Active'''
| style="vertical-align: top; width: 25%" | INT 
| style="vertical-align: top" | obsolete groups marked as '0', valid groups as '1'
|}

 ''Defect'' record type has Assigned_To_Group field (reference to ''AssignmentGroups''). 

{| width="100%" border="1" cellspacing="2" cellpadding="2"
! width="20%" valign="top" | Form Field Name (CQ field name) 
! valign="top" | Value 
|-
| width="20%" valign="top" | Name (name) 
| valign="top" | Notify Group Managers (any unique name) 
|-
| width="20%" valign="top" | Record Type (Entity_Def) 
| valign="top" | Defect 
|-
| width="20%" valign="top" | Field Change (Field_Change) 
| valign="top" | Assigned_To_Group 
|-
| valign="top" | Priority (Msg_Priority) 
| valign="top" | '''$Priority''' =~ /^1/ <nowiki>||</nowiki> '''$Severity''' =~ /^1/
|-
| valign="top" | To (Msg_To_Users) 
| valign="top" | '''SQL("SELECT T3.email FROM parent_child_links T1, fielddef T2, users T3, assignmentgroups T4 WHERE T1.parent_dbid = T4.dbid AND T1.child_dbid = T3.dbid AND T1.parent_fielddef_id = T2.id AND T2.name = 'Managers' AND T4.name = '${Assigned_To_Group}' ") '''
|-
| valign="top" | Subject (Msg_Subject) 
| valign="top" | Defect ''''$ID'''' with severity: ''''$Severity'''' and priority: ''''$Priority'''' has been assigned to your team. Please assign it to somebody in your team. 
|-
| valign="top" | Body (Msg_Body) 
| valign="top" | Defect ''''$ID'''' has been assigned to your team. Please assign Defect to somebody in your team or re-assign it to another team if initial assignment was incorrect. Defect title: ''''$Headline'''' Severity: ''''$Severity'''' Priority: ''''$Priority'''' Description: '''$Description''' <nowiki>http://newcqweb-server/cqweb/main?USE_CASE=GO&service=CQ&schema=DBSET&contextid=</nowiki>'''GetCurrentDatabaseName()'''&entityID='''${dbid}'''&entityDefName=Defect 
|}
 

== Using original field value ==
Notify assignee that defect priority assigned to him has been raised. Valid priorities are '1- something', '2 - something', etc. That simplifies comparison. Lets create user-defined function that retrieves previous value for field. udb_property record 

{| width="100%" border="1" cellspacing="2" cellpadding="2"
! width="20%" valign="top" | Name 
! valign="top" | nm_value 
|-
| width="20%" valign="top" | GetFieldOriginalValue 
| valign="top" | <source lang="perl">
my $name = shift;
my $value = '' ;
eval {
$value = $entity->GetFieldOriginalValue($name)->GetValue();
};
$@ = '';
return $value;</source>
|}

 Notification rule: 

{| width="100%" border="1" cellspacing="2" cellpadding="2"
! width="20%" valign="top" | Form Field Name (CQ field name) 
! valign="top" | Value 
|-
| width="20%" valign="top" | Name (name) 
| valign="top" | Priority has been raised - notify assignee 
|-
| width="20%" valign="top" | Record Type (Entity_Def) 
| valign="top" | Defect 
|-
| width="20%" valign="top" | Field Change (Field_Change) 
| valign="top" | Priority 
|-
| valign="top" | Condition (Msg_Condition) 
| valign="top" | '''$Priority''' gt '''GetFieldOriginalValue('Priority')'''
|-
| valign="top" | To (Msg_To_Users) 
| valign="top" | '''$owner.email '''
|-
| valign="top" | Subject (Msg_Subject)
| valign="top" | Priority has been raised for defect ''''$ID'''' from ''''GetFieldOriginalValue('Priority')' '''to ''''$Priority''''
|-
| valign="top" | Body (Msg_Body) 
| valign="top" | Priority has been raised for defect ''''$ID'''' from ''''GetFieldOriginalValue('Priority')' '''to ''''$Priority'''' Defect title: ''''$Headline'''' Severity: ''''$Severity'''' Priority: ''''$Priority'''' Description: '''$Description''' <nowiki>http://newcqweb-server/cqweb/main?USE_CASE=GO&service=CQ&schema=DBSET&contextid=</nowiki>'''GetCurrentDatabaseName()'''&entityID='''${dbid}'''&entityDefName=Defect 
|}

 

[[Category:Email_Notification_Package]]

← Older revision		Revision as of 14:44, 1 February 2013
Line 508:		Line 508:
	<br />		<br />

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

@@ Line 401: / Line 401: @@
-== '''Sending Consolidated Queries of Reports Using Timed Notification''' ==
+== '''Sending Consolidated Queries or Reports Using Timed Notification''' ==
 Timed notification was created to trigger alerts for individual records, but can it be used to send consolidated reports?
 There are few ways to achieve it. If you are using CQWeb 7.1 or later, you can employ data-pull reports and send URL to the users. No notification would be ever required in this case.

@@ Line 389: / Line 389: @@
 | valign="top" |  <source lang="text">IF( RT_HasAttachments(), "--Boundary_\($dbid)
 Content-type: text/plain; charset=us-ascii")
 Defect $ID
 Headline: $Headline

@@ Line 48: / Line 48: @@
 |}
-<br /> Subject will be evaluated when email notification is triggered, for example:<br /> "Your Defect 'SAMPL00000001' has been Rejected."<br /> We use ${State} notation for state field to avoid ambiguity, because it is followed by '.' (valid symbol for variable name).<br /><br />
+<br /> Subject will be evaluated when email notification is triggered, for example:<br /> "Your Defect 'SAMPL00000001' has been Rejected."<br /> We use ${State} notation for state field to avoid ambiguity, because it is followed by '.' (valid symbol for variable name).<br />
+Starting version 1.5, '''$UserLoginName''' predefined package variable can be used instead of GetUserLoginName user-defined function<br /><br />
 == Using SQL query ==
@@ Line 172: / Line 172: @@
 == Using original field value ==
 Notify assignee that defect priority assigned to him has been raised. Valid priorities are '1- something', '2 - something', etc. That simplifies comparison.<br /> Lets create user-defined function that retrieves previous value for field.<br /> udb_property record<br />
@@ Line 284: / Line 285: @@
+   }
+}
-return $result; # TRUE if current record has attachment</source>
+# TRUE if current record has attachment
 |-
 | width="20%" valign="top" | RT_InsertAttachments<br />
@@ Line 350: / Line 352: @@
 Content-transfer-encoding: base64
 Content-disposition: attachment; filename=$file
 $content\n";
+       }

@@ Line 2: / Line 2: @@
 == Defect state updates ==
-Send notification to submitter ('Submitter' CQ field - reference to users) when Defect is postponed (with action postpone), rejected (with action reject) or closed (action close).<br /> Do not send notification if submitter is the same user that perform action to avoid email flooding.<br /> We have to test notification rule in test database and migrate it to production without changes (database name in http link should be updated automatically).<br /><br /> lets define two functions in database properties:<br /> udb_property records:<br />
+Send notification to submitter ('Submitter' CQ field - reference to users) when Defect is postponed (with action postpone), rejected (with action reject) or closed (action close).<br /> Do not send notification if submitter is the same user that perform action to avoid email flooding.<br /> We have to test notification rule in test database and migrate it to production without changes (database name in http link should be updated automatically).<br /><br />
 {| width="100%" border="1" cellspacing="2" cellpadding="2"
@@ Line 253: / Line 256: @@
 </TABLE> </BODY> </HTML> </source>
 |}
 <br /><br />
 [[Category:Email_Notification_Package]]

← Older revision		Revision as of 20:10, 21 August 2011
Line 216:		Line 216:
	<br /><br />		<br /><br />

		+	== Sending HTML Emails ==
		+	We need to specify proper '''content type''' in the message header ("Header add-in" field). When it is done, we can use HTML in the message body, highlighting text, using different fonts and colors, etc.
		+
		+	<br /> Notification rule:<br />
		+
		+	{\| width="100%" border="1" cellspacing="2" cellpadding="2"
		+	! width="20%" valign="top" \| Form Field Name<br /> (CQ field name)<br />
		+	! valign="top" \| Value<br />
		+	\|-
		+	\| width="20%" valign="top" \| Name<br /> (name)<br />
		+	\| valign="top" \| My first HTML email<br />
		+	\|-
		+	\| width="20%" valign="top" \| Record Type<br /> (Entity_Def)<br />
		+	\| valign="top" \| Defect<br />
		+	\|-
		+	\| valign="top" \| Header add-in<br /> (Msg_Header)<br />
		+	\| valign="top" \| '''Content-Type: text/html; charset=us-ascii'''
		+	\|-
		+	\| valign="top" \| To<br /> (Msg_To_Users)<br />
		+	\| valign="top" \| '''$owner.email<br />'''
		+	\|-
		+	\| valign="top" \| Subject<br /> (Msg_Subject)
		+	\| valign="top" \| HTML test message for defect ''''$ID''''
		+	\|-
		+	\| valign="top" \| Body<br /> (Msg_Body)<br />
		+	\| valign="top" \| <source lang="xml">
		+	<HTML> <BODY>
		+	<H2 ALIGN="left">$EntityDefName $ID</H2>
		+	<TABLE ALIGN="left" BORDER="1">
		+	<TR><TD><b>ID</b> </TD> <TD>$id </TD></TR>
		+	<TR><TD><b>headline</b></TD> <TD>$Headline</TD></TR>
		+	<TR><TD><b>Priority</b></TD> <TD>$Priority</TD></TR>
		+	<TR><TD><b>Severity</b></TD> <TD>$Severity</TD></TR>
		+	<TR><TD><b>Description</b></TD>
		+	<TD><PRE>$Description</PRE> </TD></TR>
		+	</TABLE> </BODY> </HTML> </source>
		+	\|}
		+
		+	<br /><br />

	[[Category:Email_Notification_Package]]		[[Category:Email_Notification_Package]]

← Older revision	Revision as of 00:28, 5 November 2010
(No difference)