Difference between revisions of "Package installation"

From cqwiki
Jump to navigationJump to search
m (Select EmailNotification 1.3 package from the list of installed packages)
 
m
 
(4 intermediate revisions by the same user not shown)
Line 3: Line 3:
  
 
== Backup your schema repository and users databases ==
 
== Backup your schema repository and users databases ==
There is no simple way to uninstall package when schema changes are applied to the user database. Please make sure that you created backup to be able to roll back the change if necessary.
+
There is no simple way to uninstall package when schema changes are applied to the user database. Please make sure that you '''created backup''' to be able to roll back the change if necessary.
  
 +
It is strongly recommended to test it on a test copy of your schema first. Also, it would make sense to use it with the same database vendor as your production database. In this case, you can minimize risks and safely deploy the package to your production schema and database later.
 +
 +
Are you scared yet?
  
 
== Download and unpack the distribution ==
 
== Download and unpack the distribution ==
Line 18: Line 21:
  
  
== Select EmailNotification 1.3 package from the list of installed packages ==
+
== Select EmailNotification 1.6 package from the list of installed packages ==
 
click on 'More Packages' button if not in the list
 
click on 'More Packages' button if not in the list
 
[[Image:image004.jpg | none ]]
 
[[Image:image004.jpg | none ]]
Line 25: Line 28:
 
[[Image:image006.jpg]]
 
[[Image:image006.jpg]]
  
 +
and select package version you would like to apply.
  
 
== Select record types in your schema, which will be enabled for notification ==
 
== Select record types in your schema, which will be enabled for notification ==
 
[[Image:image008.jpg]]
 
[[Image:image008.jpg]]
  
Please also check [[Applying_Package_to_Stateless_Records| applying package to a stateless record type]] section.
 
  
 
== Check schema in and upgrade user databases ==
 
== Check schema in and upgrade user databases ==
Line 35: Line 38:
  
  
== Open ClearQuest and configure package according to package configuration instructions ==  
+
== Configuring Package ==
submit properties:
 
[[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!
 
 
 
 
 
=== Set other properties if required ===
 
Check other available properties in the [[Package_configuration | configuration guide]]
 
 
 
 
 
=== Create simple notification rule ===
 
[[Image:submit_Email_Notification_Rule.jpg]]
 
 
 
 
 
For example, a simple rule to notify submitter that Defect is closed:
 
[[Image:en_1.jpg]]
 
 
 
 
 
[[Image:en_2.jpg]]
 
 
 
 
 
[[Image:en_3.jpg]]
 
  
 +
Proceed to [[EmailNotification_Creating_First_Notification_Rule | Creating First Notification Rule]] section.
  
=== Test created notification rule ===
 
  
[[Category:Email_Notification_Package]]
+
[[Category:Rational]] [[Category:Email_Notification_Package]]

Latest revision as of 14:40, 1 February 2013

ClearQuest Email Notification Package Installation


Backup your schema repository and users databases

There is no simple way to uninstall package when schema changes are applied to the user database. Please make sure that you created backup to be able to roll back the change if necessary.

It is strongly recommended to test it on a test copy of your schema first. Also, it would make sense to use it with the same database vendor as your production database. In this case, you can minimize risks and safely deploy the package to your production schema and database later.

Are you scared yet?

Download and unpack the distribution

Extract.jpg


Run 'install.bat' from distribution to install and register packages

Install.jpg


Start ClearQuest Designer Package Wizard

Image002.jpg


Select EmailNotification 1.6 package from the list of installed packages

click on 'More Packages' button if not in the list

Image004.jpg

Select Schema name to apply the package

Image006.jpg

and select package version you would like to apply.

Select record types in your schema, which will be enabled for notification

Image008.jpg


Check schema in and upgrade user databases

Upgrade udb.jpg


Configuring Package

Proceed to Creating First Notification Rule section.