Difference between revisions of "ClearQuest Email Notification Package FAQ"
m |
|||
| Line 17: | Line 17: | ||
== Configuration == | == Configuration == | ||
| + | === Can I create HTML emails? === | ||
| + | Absolutely! You can set proper content-type in the email header (Header Add-in field), and use HTML the email body. This RFC-compliant email will be properly recognized by most of the email clients. Please check [[Notification_Examples#Sending_HTML_Emails | examples]] page. | ||
| + | |||
| + | === Can I send attachments with notifications? === | ||
| + | It is not recommended to attach large files to notifications, as it can impact performance of ClearQuest application. Nevertheless, it is possible. You can find detailed instructions on the [[Notification_Examples#Sending_Emails_with_Attachments | examples]] page. | ||
| + | |||
| + | === Where can I find notification rule examples? === | ||
| + | # [[Notification_Examples | Notification examples]] | ||
| + | # [[Package_configuration | Package configuration guide]] | ||
| + | # [http://cqadmin.org/data/CCMA43.pdf Extending IBM(R) Rational(R) ClearQuest(R) Email Notifications] presentation | ||
| + | # [http://forum.cqadmin.org/ Support forum] | ||
| + | |||
| + | === In multisited environment, can I use different SMTP relays for different sites? === | ||
| + | Yes, it is possible by defining site-specific property for email_host, i.e. if your site name is '''Atlanta''', Atlantaemail_host would work as email_host property for that specific site only. | ||
| + | |||
| + | You can also unset paticular property by using '''EN_NONE''' as a value. | ||
| + | |||
| + | === Can I customize the package for my own needs? === | ||
| + | You can enable package editing and add customization. | ||
| + | # close ClearQuest designer and enable package editing from command line: | ||
| + | #; <source lang="bash"> packageutil enableediting [-dbset <dbset>] <login_name> <password> -enable <login_name> </source> | ||
| + | #: where "[-dbset <dbset>]" is a specification of schema repository connection name that was configured in ClearQuest Maintenance Tool. It can be omitted if you have only one configured schema repository. | ||
| + | # open schema in Designer and update Submit action access controls for udb_property and Email_Notification_Rule record types (for example, limit to a group) | ||
| + | # test your changes | ||
| + | # disable package editing from command line to prevent accidental modifications | ||
| + | #; <source lang="bash"> packageutil enableediting [-dbset <dbset>] <login_name> <password> -disable <login_name> </source> | ||
| + | # check the schema in, and promote changes to production database | ||
| + | |||
| + | Nevertheless, I would recommend researching first, if is it possible to achieve what you are going to implement using functionality available in the package, as your changes will be overwritten when new package release is installed. | ||
== Known Issues == | == Known Issues == | ||
[[Category:ClearQuest]] [[Category:Email_Notification_Package]] | [[Category:ClearQuest]] [[Category:Email_Notification_Package]] | ||
Revision as of 14:44, 22 August 2011
ClearQuest Email Notification Package
Frequently asked questions
Contents
Installation
What version of ClearQuest the package Can be used with?
ClearQuest 2001A and later versions are supported. In order to use EmailNotification 1.3 with ClearQuest 7.1, CodePage entry needs to be added in the [General] section of "package.ini" files. Detailed instructions are provided on the following page: ClearQuest_7.1
Do I need to deploy the package on each ClearQuest client?
There is no need to install the package on CQ clients. ClearQuest package is applied to a schema and needs to be deployed on machines where you perform development of new schema versions only.
Can I use the package with VBScript-based schema?
Yes, the package can be used with VBScript or Perl schema. Package extensions can be implemented with Perl.
Can I apply package to a stateless record type?
It is possible. This option is not available in wizard. You would need to use command line. Please check applying package to a stateless records page for details.
Configuration
Can I create HTML emails?
Absolutely! You can set proper content-type in the email header (Header Add-in field), and use HTML the email body. This RFC-compliant email will be properly recognized by most of the email clients. Please check examples page.
Can I send attachments with notifications?
It is not recommended to attach large files to notifications, as it can impact performance of ClearQuest application. Nevertheless, it is possible. You can find detailed instructions on the examples page.
Where can I find notification rule examples?
- Notification examples
- Package configuration guide
- Extending IBM(R) Rational(R) ClearQuest(R) Email Notifications presentation
- Support forum
In multisited environment, can I use different SMTP relays for different sites?
Yes, it is possible by defining site-specific property for email_host, i.e. if your site name is Atlanta, Atlantaemail_host would work as email_host property for that specific site only.
You can also unset paticular property by using EN_NONE as a value.
Can I customize the package for my own needs?
You can enable package editing and add customization.
- close ClearQuest designer and enable package editing from command line:
packageutil enableediting [-dbset <dbset>] <login_name> <password> -enable <login_name>
- where "[-dbset <dbset>]" is a specification of schema repository connection name that was configured in ClearQuest Maintenance Tool. It can be omitted if you have only one configured schema repository.
- open schema in Designer and update Submit action access controls for udb_property and Email_Notification_Rule record types (for example, limit to a group)
- test your changes
- disable package editing from command line to prevent accidental modifications
packageutil enableediting [-dbset <dbset>] <login_name> <password> -disable <login_name>
- check the schema in, and promote changes to production database
Nevertheless, I would recommend researching first, if is it possible to achieve what you are going to implement using functionality available in the package, as your changes will be overwritten when new package release is installed.
