Package configuration - Revision history

Paul at 14:47, 1 February 2013

2013-02-01T14:47:02Z

Paul: /* GetFieldOriginalValue() */

2011-11-04T13:23:12Z

‎GetFieldOriginalValue()

Paul: /* Predefined variable names */

2011-11-04T13:19:03Z

‎Predefined variable names

Paul at 16:21, 31 August 2011

2011-08-31T16:21:06Z

Paul: /* Installation */

2011-08-31T16:11:25Z

‎Installation

Paul: /* Function name lookup order */

2011-08-31T16:07:38Z

‎Function name lookup order

Paul: /* Functions */

2011-08-31T16:07:08Z

‎Functions

Paul: /* Notification Rules */

2011-08-31T16:06:16Z

‎Notification Rules

Paul: /* Examples: */

2011-08-31T15:45:22Z

‎Examples:

Paul: /* Notification Rules */

2011-08-31T15:43:50Z

‎Notification Rules

← Older revision		Revision as of 14:47, 1 February 2013
Line 787:		Line 787:
	Additional examples can be found on [[Notification_Examples \| Examples]] page.		Additional examples can be found on [[Notification_Examples \| Examples]] page.

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

← Older revision		Revision as of 13:23, 4 November 2011
Line 476:		Line 476:
	<br />		<br />

		+
		+	===GetGroupEmailAddresses(<group> [, <group2> [, ... ]])===
		+	'''Parameters:'''
		+	{\| style="width: 60%; height: 60px; text-align: left" border="1" cellspacing="2" cellpadding="5"
		+	\| style="vertical-align: top; width: 30%" \| '''<group>'''
		+	\| style="vertical-align: top; width: 80%" \| ClearQuest groups list
		+	\|}
		+
		+	'''Returns:'''<br />
		+	ClearQuest field original value.<br /><br />
		+
		+	'''Examples:'''
		+	<source lang="perl">
		+	GetGroupEmailAddresses( 'Admins', 'Engineering' )
		+	</source>
		+	<br />

	===GetDateTime( [ <offset> ] )===		===GetDateTime( [ <offset> ] )===

@@ Line 194: / Line 194: @@
 | style="vertical-align: top" | '''$SiteName'''
 | style="vertical-align: top" | Site name in multisited environment
 |-
 | style="vertical-align: top" | '''$EmailNotificationRuleName'''

← Older revision		Revision as of 16:21, 31 August 2011
Line 655:		Line 655:
	<source lang="perl">DateTimeDiff( $action_date, GetDateTime(), 'd')</source>		<source lang="perl">DateTimeDiff( $action_date, GetDateTime(), 'd')</source>
	Returns a difference between $action_date field and current date/time in days.<br /><br />		Returns a difference between $action_date field and current date/time in days.<br /><br />
		+
		+
		+	= Access control =
		+	'''udb_property''' and '''Email_Notification_Rule''' records are protected using security context (udb_visibility). By default, security context field is not set, and superuser only can submit, update, or delete configuration records. You can delegate maintenance tasks by creating desirable security context records and setting PropertyDefaultSecurityGroup and NotificationDefaultSecurityGroup database properties to populate security context field automatically when records are created (records existing before setting these properties would need to be updated manually). Default security group properties also affect action permissions.
		+
		+	{\| border="1" width="100%" align="center"
		+	! Record Type
		+	! Action
		+	! Permissions
		+	\|-
		+	\|rowspan="3"\|'''udb_visibility'''
		+	\| Submit
		+	\|
		+	* Superuser
		+	\|-
		+	\| Update
		+	\|
		+	* Superuser
		+	* Security Administrator
		+	* Security context group member
		+	\|-
		+	\| Remove
		+	\|
		+	* Superuser
		+	\|-
		+
		+	\|rowspan="3"\|'''udb_property'''
		+	\| Submit
		+	\|
		+	* Superuser
		+	* Security Administrator
		+	* Default Security context group member
		+	: (set by PropertyDefaultSecurityGroup database property)
		+	\|-
		+	\| Update
		+	\|
		+	* Superuser
		+	* Security Administrator
		+	* Security context group member
		+	\|-
		+	\| Remove
		+	\|
		+	* Superuser
		+	\|-
		+	\|rowspan="3"\|'''Email_Notification_Rule'''
		+	\| Submit
		+	\|
		+	* Superuser
		+	* Security Administrator
		+	* Default Security context group member
		+	: (set by NotificationDefaultSecurityGroup database property)
		+	\|-
		+	\| Update
		+	\|
		+	* Superuser
		+	* Security Administrator
		+	* Security context group member
		+	\|-
		+	\| Remove
		+	\|
		+	* Superuser
		+	\|-
		+	\|rowspan="3"\|'''en_email_message'''
		+	\| Submit
		+	\|
		+	* Superuser
		+	* A member of group specified by EN_AdminGroup database property
		+	\|-
		+	\| Update
		+	\|
		+	* Superuser
		+	* A member of group specified by EN_AdminGroup database property
		+	\|-
		+	\| Remove
		+	\|
		+	* Superuser
		+	* A member of group specified by EN_AdminGroup database property
		+	\|-
		+	\|rowspan="5"\|'''Email_Subscription'''
		+	\| Submit
		+	\|
		+	* Superuser
		+	* Security Administrator
		+	* Default Security context group member
		+	: (set by NotificationDefaultSecurityGroup database property)
		+	\|-
		+	\| Update
		+	\|
		+	* Superuser
		+	* Security Administrator
		+	* Security context group member
		+	\|-
		+	\| Remove
		+	\|
		+	* Superuser
		+	\|-
		+	\| Subscribe_Me
		+	\|
		+	* All users
		+	\|-
		+	\| Unsubscribe_Me
		+	\|
		+	* All users
		+	\|}
		+	<BR />
		+	Submit action can be enabled for all users by setting '''Notification_Bypass_Access_Control''' database property.
		+	<BR />
		+

@@ Line 12: / Line 12: @@
 = Installation =
-Please refer to [[Package_installation | installation instructions]] page. You will need to install the latest version of EmailNotification package only. UDBProperties will be installed automatically for you.
+Please refer to [[Package_installation | installation instructions]] page. You will need to install the latest version of EmailNotification package only. UDBProperties will be installed automatically for you. <br />
+EmailSubscription is an optional package delivering end-user self-subscription functionality.
 = Configuration =

@@ Line 313: / Line 313: @@
 * Condition function:<br />
 <source lang="perl">
-   IF(($attempt > 0), 1, -1 )
+   IF($attempt > 0, 1, -1 )
 </source>

@@ Line 289: / Line 289: @@
 * single-quoted strings,
 * double quoted strings with variables, functions, etc.
-* expression in round brackets ( )
+* expressions
 * numeric constants
@@ Line 371: / Line 371: @@
    return $return_value;
 </source>
 ===Double-quoted string===

@@ Line 142: / Line 142: @@
 |-
 | style="vertical-align: top" | '''Header Add-in'''
-| style="vertical-align: top" | Additional lines to be included in message header (envelope) - parameterized field.
+| style="vertical-align: top" | Additional lines to be included in message header (envelope) - parameterized field. You can use it to specify content type, charset, etc. Please check [[Notification_Examples | notification examples]] page (HTML emails, attachments)
 |-
 | style="vertical-align: top; width: 15%" | '''Subject'''
@@ Line 149: / Line 149: @@
 | style="vertical-align: top; width: 15%" | '''Body'''
 | style="vertical-align: top" | message body (parameterized).
 |}

@@ Line 205: / Line 205: @@
 |-
 | style="vertical-align: top; width: 20%" | <source lang="perl">${Property_Name}</source>
-| style="vertical-align: top" | value of property "Property_Name"
+| style="vertical-align: top" | value of database property "Property_Name" (udb_property record)
 |}
@@ Line 211: / Line 211: @@
 * Property names and Build-in Environment variables are case sensitive, while Field names are case insensitive!
 * Date_Time variables: format that is used for Date_Time variable type inside ClearQuest hooks is '''yyyy-mm-dd hh:mm:ss'''. <br />
 ===SQL statements===

@@ Line 128: / Line 128: @@
 # otherwise, email address of the user executing action triggering email is used as from email address
-<br /> One email address per line is expected as evaluation result.
+<br /> One email address is expected as evaluation result.
 |-
 | style="vertical-align: top; width: 15%" | '''To'''