https://cqadmin.org/w/api.php?action=feedcontributions&feedformat=atom&user=Paulcqwiki - User contributions [en]2026-04-22T17:20:00ZUser contributionsMediaWiki 1.32.0https://cqadmin.org/w/index.php?title=ClearQuest_Email_Notification_Package&diff=288ClearQuest Email Notification Package2017-04-24T03:37:30Z<p>Paul: </p>
<hr />
<div><big>'''ClearQuest Email Notification Package'''</big> [[File:R4_Rational.jpg|right|140px]] <!--[[File:R4_Rational.jpg|right|140px]]--><br />
<br />
Created by ClearQuest admin for ClearQuest admins.<br />
<br />
== Email Notification Package ==<br />
It is NOT a solution that is provided and supported by IBM-Rational. It is a replacement of existing package that allows you to overcome drawbacks of standard solution and satisfy all notification requirements that you might possibly have, creating custom emails using text or HTML. <br />
The package offers ultimately flexible way of customizing notifications with no need of modifying ClearQuest schema. Usually, you need to update schema once, when you installing the package and applying it to desirable record types. It offers you rich functionality from the beginning and allows your to enhance it.<br />
<br />
The package was initially released in 2004, and presented on [http://cqadmin.org/data/CCMA43.pdf RUC 2006] and [http://cqadmin.org/data/Reno_VoiCE-ClearQuest_Email.pdf IBM VoiCE 2011].<br />
<br />
Here is a quick overview of some of the features. <br />
<br />
<br />
=== Centralized configuration and maintenance ===<br />
Email settings are stored in the ClearQuest user database. You do not need to configure every client. You configured notification on the database, turned them on – and it is working for all users, regardless of the client type: Windows, CCWeb, UNIX. It also easy to turn off notifications when they are not necessary. For example, you copied your production database to a test environment, turned the plug off, and you do not bother your users with annoying emails while testing. <br />
<br />
<br />
=== Reliable delivery/Message Queue ===<br />
If message cannot be delivered due to SMTP relay outage, delivery error or connectivity issue, it is saved in the message queue and will be re-delivered. You can optimize delivery mode based on your own requirements and needs. There are tree delivery modes offered by the package '''Light''', '''Deferred''' (default), and '''Queue'''.<br />
<br />
In case of '''Light''' delivery mode each client tries to deliver message to SMTP relay immediately, and store generated messages in the database for further re-delivery if attempt was unsuccessful only.<br />
<br />
'''Deferred''' delivery means that client stores all triggered messages in database message queue first, and then tries to deliver them, as well as other eligible messages that might be left from previous unsuccessful delivery attempts. All messages are sent in batch mode when rules evaluation is completed.<br />
<br />
In case of '''Queue''' delivery mode, client stores all messages in database and does not attempt to deliver. In this case, SMTP delivery is performed by separate CQPerl script running from ClearQuest server.<br />
<br />
You can find out more about delivery modes [[ClearQuest_Email_Notification_Package_Delivery_Mode | here]].<br />
<br />
<br />
=== Email Message Log/Audit trail ===<br />
In Deferred and Queue delivery mode all generated messages are stored in the message queue, which is a ClearQuest table. You are able to validate what was sent and when, check for delivery errors, error messages. In addition to that you can update and re-deliver messages if necessary within the ClearQuest.<br />
<br />
Message queue is also useful to develop and debug email notification rules. For example, you can turn on email notifications on your test database, and set Queue delivery mode without delivery script running. Email Rules will be evaluated, emails triggered and saved in the database, but users would not be disturbed. You can review generated emails and sent them manually, if necessary.<br />
<br />
<br />
=== Customizable message envelope and body ===<br />
You can create almost any message you want. Most of the field in the notification rule that defines email message are free-text fields, where you can embed parameters, such as record fields, database properties, results of SQL statements execution, Package or Perl build-in, and user-defined function. At runtime, during the rules evaluation, these parameters will be expanded, substituted with actual field values and function's return results.<br />
<br />
<br />
For example, you configured subject in your email notification rule as: <br />
Defect $ID has been $State<br />
and subject in the generated email message might look like <br />
Subject: Defect RATL0000001 has been closed <br />
<br />
<br />
You can also use html emails with rich formatting, colors, embedded images, links, etc.<br /><br /><br />
[[File:sample_email.png|border]]<br />
<br />
<br />
=== Configurable email message priority ===<br />
Users receive tons of emails, and sometimes you need to attract their attention to some of them. Priority field can be used to flag some messages. It can be a static priority specified for email notification rule, or dynamically evaluated priority. For example, you can flag messages that are generated by incident with Severity 1 only. Since your email body is also customizable, you can add there details instructions for the recipient on what needs to be done when they received such email.<br />
<br />
<br />
=== Additional header information ===<br />
It might be required to include some information not just to message body, but also to the message envelope. For example, to inform the mail agent about character set used in the message, or specify particular message type, such as html, etc. <br />
It could be used for specifying reply-to address, references, or other special information.<br />
<br />
<br />
=== Notification conditions ===<br />
Notification condition filed provide you additional mechanism to customize message behavior. Along with fields, parameters and function, you can use logical comparison, arithmetic and other operators, as well as regular expressions patterns.<br />
<br />
<br />
=== Message sender and reply-to address ===<br />
You can send email using the current user email address in the “From:” field, select a dedicated email address that will be used for all emails generated in the database, or create from email address dynamically when email is triggered. It is flexible and can be used in many ways. For example, it can help you satisfying mail relaying policies in very restrictive environments. If necessary, you can configure different Reply-To address, that will be used when users try to reply to generated emails.<br />
<br />
<br />
=== Site-specific settings in Multisited environment ===<br />
If you use ClearQuest multisite, you might change some database settings based on the site where you are located. For example, to point your users to a site-specific SMTP relay. It is not a problem: the package allows you to create global, as well as site specific settings, to modify or unset global database properties on particular site.<br />
<br />
<br />
=== Password authentication with SMTP relay ===<br />
Optionally, you can configure password authentication with SMTP relay. Credentials used for notification can be saved as encrypted values in the database<br />
<br />
<br />
=== Reminders ===<br />
Another nice feature of the package that it allows you to configure reminders, such as notifications about approaching due date, or other important events. I called it [[Timed_Notification | Timed Notification]]. You can create a template using the same flexible email notification rules, and Timed Notification script will trigger them using dummy action.<br />
<br />
<br />
=== Email Notification Subscription ===<br />
You can allow users to manage there email notification rules subscription preferences. This functionality is delivered with optional '''EmailSubscription''' package. It can be used as-is, enhanced, or taken as an example to implement your own, more sophisticated end-user subscription solution. Please check [[ClearQuest_Email_Subscription | Email Subscription]] page for details.<br />
<br />
== Getting Started ==<br />
<br />
Would you like to try it? Then, '''create a backup of your schema and user database''', or (even better) create test environment with master and user databases. Many customers have been using the package for years, but it is always makes sense to test the package in your specific environment and check for conflicts with existing hooks, issues with particular database vendor and version, etc, and update production when you are sure that it would be safe to do it only.<br />
<br />
<br />
# [[Download | Download]] the package.<br />
# [[Package_installation | Install it]].<br />
# Create your [[EmailNotification_Creating_First_Notification_Rule | first notification rule]]<br />
<br />
<br />
== Additional Information ==<br />
# It could be useful to read [[Package_configuration | package configuration guide]] and<br />
# [[ClearQuest_Email_Notification_Package_FAQ | Frequently Asked Questions ]]<br />
# Please check [[Notification_Examples | Examples]] and<br />
# [http://cqadmin.org/data/CCMA43.pdf Extending IBM(R) Rational(R) ClearQuest(R) Email Notifications] presentation<br />
# [[Timed_Notification | Reminders / Timed Notifications]]<br />
# [[ClearQuest_Email_Subscription | End users self-subscription to email notifications]]<br />
# If you have questions or problems, welcome to the [http://forum.cqadmin.org/ support forum]<br />
<br />
<br />
== License == <br />
<br />
The ''ClearQuest Email Notification Package'' is licensed under the ''GNU Lesser General Public License'' (AKA, the "LGPL"), Version 2.1, February, 1999.<br />
<br />
<br />
<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=Email_Notification_1.6_Release_Notes&diff=287Email Notification 1.6 Release Notes2017-04-24T03:35:46Z<p>Paul: </p>
<hr />
<div><big>'''Email Notification Package 1.5'''</big><br />
<big>'''Release Notes'''</big><br />
<br />
<br />
== Enhancements ==<br />
<br />
=== Support for Non-ASCII code pages ===<br />
Safe support of non-ascii code pages was added, with few limitations.<br />
<br />
==== Using non-ascii field names ====<br />
Currently, the parser does not provide full support non-ascii characters in field names using variable-like notation. For instance, the following field name would not be recognized: '''${моё_самое_любимое_имя}'''. One of the possible workarounds is to use '''GetFieldValue''' function to access such fields in email notification rules. For instance, in my example, I could use the following syntax: '''GetFieldValue('моё_самое_любимое_имя')'''<br />
<br />
==== Using non-ascii characters in message envelope ====<br />
Using non-ascii characters email envelope is permitted. Nevertheless, you might hit some limitations in your environment. Please check the following page for details: [[Email_Envelope_and_UTF-8 | Non-ASCII Characters in Email]].<br />
<br />
<br /><br />
<br />
== Prerequisites ==<br />
=== ClearQuest client version ===<br />
The package can be used with ClearQuest 7.0.0 or later. Earlier versions are supported in version 1.5 only.<br />
<br />
<br /><br />
<br />
<br />
<br />
== Read More ==<br />
* [[Email_Notification_1.5_Release_Notes | Email Notification Package Release 1.5 Notes]]<br />
* [[ClearQuest_Email_Notification_Package | ClearQuest Email Notification Package]]<br />
* [[Package_configuration | Package configuration guide]]<br />
* [[ClearQuest_Email_Notification_Package_FAQ | Frequently Asked Questions ]]<br />
* [[Notification_Examples | Examples]]<br />
<br />
<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=Email_Notification_1.6_Release_Notes&diff=286Email Notification 1.6 Release Notes2017-04-24T03:35:18Z<p>Paul: </p>
<hr />
<div><big>'''Email Notification Package 1.5'''</big><br />
<big>'''Release Notes'''</big><br />
<br />
<br />
== Enhancements ==<br />
<br />
=== Support for Non-ASCII code pages ===<br />
Safe support of non-ascii code pages was added, with few limitations.<br />
<br />
==== Using non-ascii field names ====<br />
Currently, the parser does not provide full support non-ascii characters in field names using variable-like notation. For instance, the following field name would not be recognized: '''${моё_самое_любимое_имя}'''. One of the possible workarounds is to use '''GetFieldValue''' function to access such fields in email notification rules. For instance, in my example, I could use the following syntax: '''GetFieldValue('моё_самое_любимое_имя')'''<br />
<br />
==== Using non-ascii characters in message envelope ====<br />
Using non-ascii characters email envelope is permitted. Nevertheless, you might hit some limitations in your environment. Please check the following page for details: [[Email_Envelope_and_UTF-8 | Non-ASCII Characters in Email]].<br />
<br />
<br /><br />
<br />
== Prerequisites ==<br />
=== ClearQuest client version ===<br />
The package can be used with ClearQuest 7.0.0 or later. Earlier versions are supported in version 1.5 only.<br />
<br />
<br /><br />
<br />
== Other Notes ==<br />
=== Supplementary scripts ===<br />
Supplementary script, such as Delivery Script for Queue delivery mode and Timed Notification script for reminders, need to be updated in order to support non-ascii databases. New versions are available for download from [http://store.cqadmin.com/index.php/clearquest.html CQAdmin store].<br />
<br />
<br />
== Read More ==<br />
* [[Email_Notification_1.5_Release_Notes | Email Notification Package Release 1.5 Notes]]<br />
* [[ClearQuest_Email_Notification_Package | ClearQuest Email Notification Package]]<br />
* [[Package_configuration | Package configuration guide]]<br />
* [[ClearQuest_Email_Notification_Package_FAQ | Frequently Asked Questions ]]<br />
* [[Notification_Examples | Examples]]<br />
<br />
<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=Download&diff=285Download2017-04-24T03:30:42Z<p>Paul: </p>
<hr />
<div><big>'''Downloads'''</big><br />
<br />
== ClearQuest Email Notification Package ==<br />
Please visit [[Package_installation | installation]] and [[Package_configuration | configuration]] pages for detailed instructions.<br /><br />
The package and supplementary scripts are available now at [http://cqadmin.org/data/emailnotificationpackagesetup.exe this link]<br />
<br /><br /><br />
<br />
== Dynamic List Editor for IBM-Rational ClearQuest ==<br />
Please check the [[ClearQuest_Dynamic_List_Editor | documentation]] page for details.<br /><br />
The distribution is available at [http://cqadmin.org/data/cqdynamiclisteditor_1.exe this link].<br />
<br /><br /><br />
<br />
== User Administration Tool for IBM-Rational ClearQuest ==<br />
Please check the [[User_Admin_Tool_Installation | installation]] and [[User_Admin_Tool_Configuration | configuration]] pages for details.<br /><br />
The distribution is available at [http://cqadmin.org/data/cquseradmintoolsetup.exe this link].<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]] [[Category:Dynamic_List_Editor]] [[Category:User_Admin_Tool]]</div>Paulhttps://cqadmin.org/w/index.php?title=Download&diff=284Download2017-04-24T03:30:16Z<p>Paul: </p>
<hr />
<div><big>'''Downloads'''</big><br />
<br />
== ClearQuest Email Notification Package ==<br />
Please visit [[Package_installation | installation]] and [[Package_configuration | configuration]] pages for detailed instructions.<br /><br />
The package and supplementary scripts are available now at [http://cqadmin.org/data/emailnotificationpackagesetup.exe this link]<br />
<br /><br /><br />
<br />
== Dynamic List Editor for IBM-Rational ClearQuest ==<br />
Please check the [[ClearQuest_Dynamic_List_Editor | documentation]] page for details.<br /><br />
The distribution is available at [http://cqadmin.org/data/cqdynamiclisteditor_1.exe this link].<br />
<br /><br /><br />
<br />
== User Administration Tool for IBM-Rational ClearQuest ==<br />
Please check the [[User_Admin_Tool_Installation | installation]] and [[User_Admin_Tool_Configuration | configuration]] pages for details.<br /><br />
The distribution is available at [[http://cqadmin.org/data/cquseradmintoolsetup.exe this link].<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]] [[Category:Dynamic_List_Editor]] [[Category:User_Admin_Tool]]</div>Paulhttps://cqadmin.org/w/index.php?title=Download&diff=283Download2017-04-24T03:29:47Z<p>Paul: </p>
<hr />
<div><big>'''Downloads'''</big><br />
<br />
== ClearQuest Email Notification Package ==<br />
Please visit [[Package_installation | installation]] and [[Package_configuration | configuration]] pages for detailed instructions.<br /><br />
The package and supplementary scripts are available now at [http://cqadmin.org/data/emailnotificationpackagesetup.exe this link]<br />
<br /><br /><br />
<br />
== Dynamic List Editor for IBM-Rational ClearQuest ==<br />
Please check the [[ClearQuest_Dynamic_List_Editor | documentation]] page for details.<br /><br />
The distribution is available at [http://cqadmin.org/data/cqdynamiclisteditor_1.exe this kink].<br />
<br /><br /><br />
<br />
== User Administration Tool for IBM-Rational ClearQuest ==<br />
Please check the [[User_Admin_Tool_Installation | installation]] and [[User_Admin_Tool_Configuration | configuration]] pages for details.<br /><br />
The distribution is available at [[http://cqadmin.org/data/cquseradmintoolsetup.exe this link].<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]] [[Category:Dynamic_List_Editor]] [[Category:User_Admin_Tool]]</div>Paulhttps://cqadmin.org/w/index.php?title=Download&diff=282Download2017-04-24T03:29:26Z<p>Paul: </p>
<hr />
<div><big>'''Downloads'''</big><br />
<br />
== ClearQuest Email Notification Package ==<br />
Please visit [[Package_installation | installation]] and [[Package_configuration | configuration]] pages for detailed instructions.<br /><br />
The package and supplementary scripts are available now at [http://cqadmin.org/data/emailnotificationpackagesetup.exe this link]<br />
<br /><br /><br />
<br />
== Dynamic List Editor for IBM-Rational ClearQuest ==<br />
Please check the [[ClearQuest_Dynamic_List_Editor | documentation]] page for details.<br /><br />
The distribution is available at [http://cqadmin.org/data/cqdynamiclisteditor_1.exe this kink].<br />
<br /><br /><br />
<br />
== User Administration Tool for IBM-Rational ClearQuest ==<br />
Please check the [[User_Admin_Tool_Installation | installation]] and [[User_Admin_Tool_Configuration | configuration]] pages for details.<br /><br />
The distribution is available at [[http://cqadmin.org/data/cquseradmintoolsetup.exe this kink].<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]] [[Category:Dynamic_List_Editor]] [[Category:User_Admin_Tool]]</div>Paulhttps://cqadmin.org/w/index.php?title=CQAdmin&diff=281CQAdmin2016-12-29T02:55:04Z<p>Paul: /* Latest news */</p>
<hr />
<div><big>'''Rational Administrators'''</big><br />
<br />
This site was created to provide tools, information, and share experience that might be useful for Rational tools administrators. <br />
<br />
<br />
<br />
== Latest news ==<br />
* '''The [[User_Admin_Tool | User Administration Tool for IBM-Rational ClearQuest]] is "Ready for IBM-Rational Software"'''<br />
: The User Administration Tool was successfully validated to the requirements of <i style="color:blue;">Ready for IBM Rational Software</i>. It met the requirements for the IBM Software Delivery Platform level of the program. The User Administration tool simplifies site management and adds other valuable features, such as Web-based user administration, ultimate query and search capabilities, customizable defaults and validations, user profiling and templates, granular access, reporting and audit, email notifications and more.<br />
<br />
* '''[[ClearQuest_Email_Notification_Package | Email Notification Package]] is "Ready for IBM-Rational Software"'''<br />
: Email Notification package was successfully validated to the requirements of <i style="color:blue;">Ready for IBM Rational Software</i>. The package met the requirements for the IBM Software Delivery Platform level of the program.<br />
<br />
* '''Commercial Support'''<br />
: ClearQuest Email Notification package is supported via '''free''' community at [http://forum.cqadmin.com http://forum.cqadmin.com].<br />
<br />
== Resources ==<br />
* [[ClearQuest_Email_Notification_Package | Email Notification Package]] for IBM-Rational ClearQuest. <br />
: If you would like to use flexible notification rules, reliable delivery, sending HTML emails with rich text, fonts, and colors, configuring reminders, and many other features, you might like the package.<br />
<br />
* [[User_Admin_Tool | User Administration Tool]] for IBM-Rational ClearQuest.<br />
: It simplifies site management and adds other valuable features, such as customizable defaults and validations, user profiling and templates, reporting and audit, email notifications and more. <br />
<br />
* [[ClearQuest_Dynamic_List_Editor | Dynamic List Editor]] for IBM-Rational ClearQuest. <br />
: Would you like to administer Dynamic Lists via the ClearQuest Web client? You might consider using the editor.<br />
<br />
* '''Support forum'''<br />
: Support forum is available now. Please do not hesitate to ask questions or share your experience.<br />
: [http://forum.cqadmin.com/ http://forum.cqadmin.com/]<br />
<br />
<br /><br /><br />
<br />
[[Category:Rational]]</div>Paulhttps://cqadmin.org/w/index.php?title=CQAdmin&diff=280CQAdmin2013-11-05T12:34:03Z<p>Paul: </p>
<hr />
<div><big>'''Rational Administrators'''</big><br />
<br />
This site was created to provide tools, information, and share experience that might be useful for Rational tools administrators. <br />
<br />
<br />
<br />
== Latest news ==<br />
* '''The [[User_Admin_Tool | User Administration Tool for IBM-Rational ClearQuest]] is "Ready for IBM-Rational Software"'''<br />
: The User Administration Tool was successfully validated to the requirements of <i style="color:blue;">Ready for IBM Rational Software</i>. It met the requirements for the IBM Software Delivery Platform level of the program. The User Administration tool simplifies site management and adds other valuable features, such as Web-based user administration, ultimate query and search capabilities, customizable defaults and validations, user profiling and templates, granular access, reporting and audit, email notifications and more.<br />
<br />
* '''[[ClearQuest_Email_Notification_Package | Email Notification Package]] is "Ready for IBM-Rational Software"'''<br />
: Email Notification package was successfully validated to the requirements of <i style="color:blue;">Ready for IBM Rational Software</i>. The package met the requirements for the IBM Software Delivery Platform level of the program.<br />
<br />
* '''Commercial Support'''<br />
: ClearQuest Email Notification package is officially [http://store.cqadmin.com/index.php/clearquest/cq-email-notification/email-notification-package-support.html supported] by [http://cqadmin.com CQAdmin, inc]. Three levels or support are currently offered, starting with '''free''' community support at [http://forum.cqadmin.com http://forum.cqadmin.com]. Consulting services are also available.<br />
<br />
<br />
== Resources ==<br />
* [[ClearQuest_Email_Notification_Package | Email Notification Package]] for IBM-Rational ClearQuest. <br />
: If you would like to use flexible notification rules, reliable delivery, sending HTML emails with rich text, fonts, and colors, configuring reminders, and many other features, you might like the package.<br />
<br />
* [[User_Admin_Tool | User Administration Tool]] for IBM-Rational ClearQuest.<br />
: It simplifies site management and adds other valuable features, such as customizable defaults and validations, user profiling and templates, reporting and audit, email notifications and more. <br />
<br />
* [[ClearQuest_Dynamic_List_Editor | Dynamic List Editor]] for IBM-Rational ClearQuest. <br />
: Would you like to administer Dynamic Lists via the ClearQuest Web client? You might consider using the editor.<br />
<br />
* '''Support forum'''<br />
: Support forum is available now. Please do not hesitate to ask questions or share your experience.<br />
: [http://forum.cqadmin.com/ http://forum.cqadmin.com/]<br />
<br />
<br /><br /><br />
<br />
[[Category:Rational]]</div>Paulhttps://cqadmin.org/w/index.php?title=CQAdmin&diff=279CQAdmin2013-10-24T14:51:50Z<p>Paul: </p>
<hr />
<div><big>'''Rational Administrators'''</big><br />
<br />
This site was created to provide tools, information, and share experience that might be useful for Rational tools administrators. <br />
<br />
<br />
<br />
== Latest news ==<br />
* '''The [[User_Admin_Tool | User Administration Tool for IBM-Rational ClearQuest]] is "Ready for IBM-Rational Software"'''<br />
: The User Administration Tool was successfully validated to the requirements of <i style="color:blue;">Ready for IBM Rational Software</i>. It met the requirements for the IBM Software Delivery Platform level of the program. The User Administration tool simplifies site management and adds other valuable features, such as Web-based user administration, ultimate query and search capabilities, customizable defaults and validations, user profiling and templates, granular access, reporting and audit, email notifications and more.<br />
<br />
* '''[[ClearQuest_Email_Notification_Package | Email Notification Package]] is "Ready for IBM-Rational Software"'''<br />
: Email Notification package was successfully validated to the requirements of <i style="color:blue;">Ready for IBM Rational Software</i>. The package met the requirements for the IBM Software Delivery Platform level of the program.<br />
<br />
* '''Commercial Support'''<br />
: ClearQuest Email Notification package is officially [http://store.cqadmin.com/index.php/clearquest/cq-email-notification/email-notification-package-support.html supported] by [http://cqadmin.com CQAdmin, inc]. Three levels or support are currently offered, starting with '''free''' community support at [http://forum.cqadmin.org http://forum.cqadmin.org]. Consulting services are also available.<br />
<br />
<br />
== Resources ==<br />
* [[ClearQuest_Email_Notification_Package | Email Notification Package]] for IBM-Rational ClearQuest. <br />
: If you would like to use flexible notification rules, reliable delivery, sending HTML emails with rich text, fonts, and colors, configuring reminders, and many other features, you might like the package.<br />
<br />
* [[User_Admin_Tool | User Administration Tool]] for IBM-Rational ClearQuest.<br />
: It simplifies site management and adds other valuable features, such as customizable defaults and validations, user profiling and templates, reporting and audit, email notifications and more. <br />
<br />
* [[ClearQuest_Dynamic_List_Editor | Dynamic List Editor]] for IBM-Rational ClearQuest. <br />
: Would you like to administer Dynamic Lists via the ClearQuest Web client? You might consider using the editor.<br />
<br />
* '''Support forum'''<br />
: Support forum is available now. Please do not hesitate to ask questions or share your experience.<br />
: [http://forum.cqadmin.com/ http://forum.cqadmin.com/]<br />
<br />
<br /><br /><br />
<br />
[[Category:Rational]]</div>Paulhttps://cqadmin.org/w/index.php?title=MediaWiki:Sidebar&diff=278MediaWiki:Sidebar2013-10-24T14:51:22Z<p>Paul: </p>
<hr />
<div>* navigation<br />
** mainpage|CQ Admin Home<br />
** ClearQuest_Email_Notification_Package | Email notification package<br />
** User_Admin_Tool | User Admin Tool<br />
** ClearQuest_Dynamic_List_Editor | Dynamic List Editor<br />
** Download | Downloads<br />
** http://forum.cqadmin.com | Forum<br />
** Category:Rational | Index<br />
* SEARCH<br />
* TOOLBOX<br />
* LANGUAGES</div>Paulhttps://cqadmin.org/w/index.php?title=CQAdmin&diff=277CQAdmin2013-10-20T14:09:40Z<p>Paul: </p>
<hr />
<div><big>'''Rational Administrators'''</big><br />
<br />
This site was created to provide tools, information, and share experience that might be useful for Rational tools administrators. <br />
<br />
<br />
<br />
== Latest news ==<br />
* '''The [[User_Admin_Tool | User Administration Tool for IBM-Rational ClearQuest]] is "Ready for IBM-Rational Software"'''<br />
: The User Administration Tool was successfully validated to the requirements of <i style="color:blue;">Ready for IBM Rational Software</i>. It met the requirements for the IBM Software Delivery Platform level of the program. The User Administration tool simplifies site management and adds other valuable features, such as Web-based user administration, ultimate query and search capabilities, customizable defaults and validations, user profiling and templates, granular access, reporting and audit, email notifications and more.<br />
<br />
* '''[[ClearQuest_Email_Notification_Package | Email Notification Package]] is "Ready for IBM-Rational Software"'''<br />
: Email Notification package was successfully validated to the requirements of <i style="color:blue;">Ready for IBM Rational Software</i>. The package met the requirements for the IBM Software Delivery Platform level of the program.<br />
<br />
* '''Commercial Support'''<br />
: ClearQuest Email Notification package is officially [http://store.cqadmin.com/index.php/clearquest/cq-email-notification/email-notification-package-support.html supported] by [http://cqadmin.com CQAdmin, inc]. Three levels or support are currently offered, starting with '''free''' community support at [http://forum.cqadmin.org http://forum.cqadmin.org]. Consulting services are also available.<br />
<br />
<br />
== Resources ==<br />
* [[ClearQuest_Email_Notification_Package | Email Notification Package]] for IBM-Rational ClearQuest. <br />
: If you would like to use flexible notification rules, reliable delivery, sending HTML emails with rich text, fonts, and colors, configuring reminders, and many other features, you might like the package.<br />
<br />
* [[User_Admin_Tool | User Administration Tool]] for IBM-Rational ClearQuest.<br />
: It simplifies site management and adds other valuable features, such as customizable defaults and validations, user profiling and templates, reporting and audit, email notifications and more. <br />
<br />
* [[ClearQuest_Dynamic_List_Editor | Dynamic List Editor]] for IBM-Rational ClearQuest. <br />
: Would you like to administer Dynamic Lists via the ClearQuest Web client? You might consider using the editor.<br />
<br />
* '''Support forum'''<br />
: Support forum is available now. Please do not hesitate to ask questions or share your experience.<br />
: [http://forum.cqadmin.org/ http://forum.cqadmin.org/]<br />
<br />
<br /><br /><br />
<br />
[[Category:Rational]]</div>Paulhttps://cqadmin.org/w/index.php?title=Email_Notification_Service_Configuration&diff=276Email Notification Service Configuration2013-08-29T20:03:27Z<p>Paul: </p>
<hr />
<div>'''EmailNotification Service Configuration File'''<br />
<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="UTF-8" standalone="no"?><br />
<configuration><br />
<br />
<!-- <br />
ClearQuest login and password <br />
cleartext password must be encrypted using "encrypt" command <br />
--><br />
<login>admin</login><br />
<password>unencrypted_password</password><br />
<br />
<!--<br />
DBSets configured for email notification<br />
--><br />
<dbsets><br />
<!--each connection starts with <dbset> tag --> <br />
<dbset><br />
<!--connection name (dbset)--><br />
<name>ClearQuest Connection Name</name><br />
<!-- dbset specific credentials can be specified here. It would override global settings<br />
password can be provided as clear text and encrypted using “encrypt” command.<br />
<br />
<login>connection-specific-login-name</login><br />
<password>connection-specific-password</password><br />
--> <br />
<br />
<!-- all user databases --><br />
<databases><br />
<database>DB1</database><br />
<database>DB2</database><br />
</databases><br />
</dbset><br />
<br />
<dbset><br />
<name>Another ClearQuest DBSet</name><br />
<databases><br />
<database>DB3</database><br />
</databases><br />
</dbset><br />
</dbsets><br />
<br />
<!-- scheduled execution parameters <br />
by default the service queries the databases<br />
every 5 minutes (30 seconds) with <br />
0 seconds offset from the beginning of the hour<br />
<interval>300</interval><br />
<offset>0</offset><br />
--><br />
<!--additional configuration options <br />
Logfile – alternative log file name--><br />
<logfile>new_log_file_name</logfile><br />
<br />
<!-- Log level – desirable logging level --><br />
<loglevel>ALL</loglevel><br />
<br />
<!-- debug – turn on debug output --><br />
<debug>true</debug><br />
<br />
<!-- verbose – turn on console output --><br />
<verbose>true</verbose><br />
<br />
<br />
<!-- <br />
Local configuration flag<br />
when set to "false" email settings are retrieved from the ClearQuest database<br />
--><br />
<localconfig>false</localconfig><br />
<br />
<!-- example of the local email settings<br />
<localconfig>true</localconfig><br />
<br />
email host – SMTP server name. It might include port number. <br />
<br />
<email_host>hostname:port</email_host><br />
Alternatively, port number can be specified as <mail.smtp.port>port</mail.smtp.port><br />
<br />
Authentication credentials. Password can be provided as clear text and encrypted using “encrypt” command.<br />
<email_login>loginname</email_login><br />
<email_password>password</email_password><br />
<br />
turn on STARTTLS on smtp connection:<br />
<mail.smtp.starttls>true</mail.smtp.starttls><br />
trust particular host self-signed or invalid certificate<br />
<mail.smtp.ssl.trust>my.host.name</mail.smtp.ssl.trust><br />
<br />
use SSL:<br />
<email_use_ssl>true</email_use_ssl><br />
<br />
<br />
--><br />
<br />
</configuration><br />
<br />
</source><br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=Email_Notification_Service_Configuration&diff=275Email Notification Service Configuration2013-08-29T20:00:53Z<p>Paul: </p>
<hr />
<div>'''EmailNotification Service Configuration File'''<br />
<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="UTF-8" standalone="no"?><br />
<configuration><br />
<br />
<!-- <br />
ClearQuest login and password <br />
cleartext password must be encrypted using "encrypt" command <br />
--><br />
<login>admin</login><br />
<password>unencrypted_password</password><br />
<br />
<!--<br />
DBSets configured for email notification<br />
--><br />
<dbsets><br />
<!--each connection starts with <dbset> tag --> <br />
<dbset><br />
<!--connection name (dbset)--><br />
<name>ClearQuest Connection Name</name><br />
<!-- dbset specific credentials can be specified here. It would override global settings<br />
password can be provided as clear text and encrypted using “encrypt” command.<br />
<br />
<login>connection-specific-login-name</login><br />
<password>connection-specific-password</password><br />
--> <br />
<br />
<!-- all user databases --><br />
<databases><br />
<database>DB1</database><br />
<database>DB2</database><br />
</databases><br />
</dbset><br />
<br />
<dbset><br />
<name>Another ClearQuest DBSet</name><br />
<databases><br />
<database>DB3</database><br />
</databases><br />
</dbset><br />
</dbsets><br />
<br />
<!-- scheduled execution parameters <br />
by default the service queries database<br />
every 5 minutes (30 seconds) with <br />
0 seconds offset from the beginning of the hour<br />
<interval>300</interval><br />
<offset>0</offset><br />
--><br />
<!--additional configuration options <br />
Logfile – alternative log file name--><br />
<logfile>new_log_file_name</logfile><br />
<br />
<!-- Log level – desirable logging level --><br />
<loglevel>ALL</loglevel><br />
<br />
<!-- debug – turn on debug output --><br />
<debug>true</debug><br />
<br />
<!-- verbose – turn on console output --><br />
<verbose>true</verbose><br />
<br />
<br />
<!-- <br />
Local configuration flag<br />
when set to "false" email settings are retrieved from the ClearQuest database<br />
--><br />
<localconfig>false</localconfig><br />
<br />
<!-- example of the local email settings<br />
<localconfig>true</localconfig><br />
<br />
email host – SMTP server name. It might include port number. <br />
<br />
<email_host>hostname:port</email_host><br />
Alternatively, port number can be specified as <mail.smtp.port>port</mail.smtp.port><br />
<br />
Authentication credentials. Password can be provided as clear text and encrypted using “encrypt” command.<br />
<email_login>loginname</email_login><br />
<email_password>password</email_password><br />
<br />
turn on STARTTLS on smtp connection:<br />
<mail.smtp.starttls>true</mail.smtp.starttls><br />
trust particular host self-signed or invalid certificate<br />
<mail.smtp.ssl.trust>my.host.name</mail.smtp.ssl.trust><br />
<br />
use SSL:<br />
<email_use_ssl>true</email_use_ssl><br />
<br />
<br />
--><br />
<br />
</configuration><br />
<br />
</source><br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=Email_Notification_Service&diff=274Email Notification Service2013-06-22T23:18:57Z<p>Paul: </p>
<hr />
<div>'''EmailNotification Package Delivery Service'''<br />
<br />
ClearQuest Email Service performs centralized email delivery for ClearQuest user databases utilizing the [[ClearQuest_Email_Notification_Package | Email Notification]] package in the '''Queue''' mode. <br /><br />
It features:<br />
* Servicing multiple user databases and multiple connections (dbsets)<br />
* Performing scheduled deliveries with a configured interval and offset.<br />
* Operating in console mode or working as a service.<br />
* Supporting login, digest, and NTLM authentication mechanisms.<br />
* Sending emails via a secure connection using an SMTP over SSL or STARTTLS extension.<br />
* Preventing user credentials from exposure by encrypting them in the configuration file.<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=Email_Notification_Service&diff=273Email Notification Service2013-06-22T22:53:43Z<p>Paul: </p>
<hr />
<div>'''EmailNotification Package Delivery Service'''<br />
<br />
ClearQuest Email Service performs centralized email delivery for ClearQuest user databases utilizing the [[ClearQuest_Email_Notification_Package | Email Notification]] package in the '''Queue''' mode. <br /><br />
It features:<br />
* Servicing multiple user databases and multiple connections (dbsets)<br />
* Performing scheduled deliveries with a configured interval and offset.<br />
* Operating in console mode or working as a service.<br />
* Supporting login, digest, and NTLM authentication mechanisms.<br />
* Sending emails via a secure connection using SMTP over SSL or STARTTLS extension.<br />
* Preventing user credentials from exposure by encrypting them in the configuration file.<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=Email_Notification_Service&diff=272Email Notification Service2013-06-22T22:21:24Z<p>Paul: </p>
<hr />
<div>'''EmailNotification package Delivery Service'''<br />
<br />
ClearQuest Email Service performs centralized email delivery for ClearQuest user databases utilizing [[ClearQuest_Email_Notification_Package | Email Notification]] package in '''Queue''' mode. <br /><br />
It features:<br />
* Servicing multiple user databases and multiple connections (dbsets)<br />
* Performing scheduled delivery with configured interval and offset.<br />
* Operating in console mode, or working as a service.<br />
* Supporting login, digest, and NTLM authentication mechanisms.<br />
* Sending emails via secure connection using SMTP over SSL or STARTTLS extension.<br />
* Preventing user credentials from exposure by encrypting them in the configuration file.<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=Email_Notification_Service&diff=271Email Notification Service2013-06-22T22:18:10Z<p>Paul: </p>
<hr />
<div>'''EmailNotification package Delivery Service'''<br />
<br />
The service performs centralized email delivery for ClearQuest user databases utilizing [[ClearQuest_Email_Notification_Package | Email Notification]] package in '''Queue''' mode. It features:<br />
* Servicing multiple user databases and multiple connections (dbsets)<br />
* Performing scheduled delivery with configured interval and offset.<br />
* Operating in console mode, or working as a service.<br />
* Sending emails via secure connection using SMTP over SSL or STARTTLS extension.<br />
* Supporting login, digest, and NTLM authentication mechanisms.<br />
* Preventing user credentials from exposure by encrypting them in the configuration file.<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=ClearQuest_Dynamic_List_Editor&diff=270ClearQuest Dynamic List Editor2013-06-16T18:30:52Z<p>Paul: </p>
<hr />
<div><big>'''ClearQuest Dynamic List Editor'''</big><br />
<br />
Created by ClearQuest admin for ClearQuest admins.<br />
<br />
= Dynamic List Editor =<br />
This is NOT a solution that is provided and supported by IBM-Rational. <br />
The Dynamic List Editor is an add-on to your existing ClearQuest schema, VBScript or Perl based, that provides a unified interface to administer Dynamic Lists for Windows, Eclipse, UNIX clients, and (most importantly) the Web client. Additionally, it adds basic audit capabilities that can be enhanced using the Audit Trail package.<br />
The enhancement is distributed as a ClearQuest schema integration, and it can be easily removed from the schema when it is no longer required.<br />
<br />
In the Editor, all dynamic lists are represented by correspondent stateless records of the Dynamic_List record type.<br />
<br />
[[File:Dynamic_List_Editor.png|center]] <br />
<br />
Dynamic List administrators work with the stateless records, and when the update is completed and records are submitted to the database, the correspondent dynamic lists are updated automatically.<br />
<br />
== Installation Instruction ==<br />
'''Please create a backup of schema and user databases before the installation.'''<br /><br />
The package is an add-on to your existing ClearQuest schema. In order to install it, you will need ClearQuest administrative access and administrative tools (ClearQuest designer). When the configuration is completed, users with the "Dynamic List Admin" privilege or super users can modify the content of the Dynamic Lists using ClearQuest Web or other ClearQuest clients.<br />
<br />
=== Automatic Install ===<br />
* Download the distribution to your local or network drive<br />
* Launch "setup.exe"<br />
* Accept license agreement<br />
* When configuration wizard is launched, provide administrative user credentials, ClearQuest connection, database name, and click on "Connect" (or, you can cancel ClearQuest schema configuration wizard and configure selected database later).<br />
<br />
When installation is completed, login to the user database and run "Public Queries/Administration/Dynamic_Lists" query to verify Dynamic list data. You can start using the tool immediately.<br />
<br />
=== Manual Install ===<br />
You can install the Editor manually: [[ClearQuest_Dynamic_List_Editor_ManualSetup | Manual Setup ]].<br />
<br />
<br />
== Administering Dynamic Lists ==<br />
When installation is completed, ClearQuest administrators can start using ClearQuest client to query Dynamic_Lists records to modify the content of the linked dynamic lists. If you used installation wizard, "Dynamic Lists" query is located in the "Administration" folder of the "Public Queries" workspace:<br />
<br />
<br />
[[File:Dynamic_List_Sync_3.png|center]]<br />
<br />
<br />
Most of the time, the "Update" action is sufficient. In addition, the Editor offers the following actions to simplify administration:<br />
{| class="wikitable"<br />
! Action Name<br />
! Action Type<br />
! Access Control<br />
! Description<br />
|-<br />
| Submit<br />
| Submit<br />
| Super User<br />
| Submit allows the creation of new records when a new Dynamic List added to the ClearQuest schema. You can also use the "SyncAllLists" utility action to synchronize all the records at once.<br />
|-<br />
| Update<br />
| Modify<br />
| Super User, Dynamic List Admins<br />
| Update is the primary action for administering Dynamic Lists content. When an action is initialized, the record is refreshed with the latest content of the dynamic list (please check "Dynamic List Caching" section). When the updated record is saved, its content is saved in the correspondent dynamic list as well.<br />
|-<br />
| Delete<br />
| Utilities / Delete<br />
| Super User<br />
| This action allows you to delete existing Dynamic_List records, such as when a correspondent dynamic list is removed from the schema. Alternatively, you can use the "SyncAllLists" utility action to synchronize all records at once after a database upgrade.<br />
|-<br />
| LoadList<br />
| Utilities / Script<br />
| Super User, Dynamic List Admins<br />
| Load List action updates the current ClearQuest record with the content of the correspondent dynamic list. Please be aware that in order to see the update you might need to refresh the ClearQuest query or even to close and re-run it.<br />
|-<br />
| SaveList<br />
| Utilities / Script<br />
| Super User, Dynamic List Admins<br />
| Save List action saves the content of the current ClearQuest records into a correspondent dynamic list.<br />
|-<br />
| SaveAllLists<br />
| Utilities / Script<br />
| Super User, Dynamic List Admins<br />
| Save all lists saves the content of all ClearQuest Dynamic List records into correspondent dynamic lists. It might be useful when records are imported from an external source.<br />
|-<br />
| SyncAllLists<br />
| Utilities / Script<br />
| Super User<br />
| This action syncs ClearQuest records with their correspondent dynamic lists:<br />
* when the ClearQuest record already exists, its content is updated from the dynamic list<br />
* when the ClearQuest record does not exist, a new record is created<br />
* when a dynamic list for the existing ClearQuest record does not exist, the record is deleted.<br />
|}<br />
<br />
== Dynamic Lists Caching ==<br />
In order to improve performance, ClearQuest caches the content of dynamic lists. When you update the content of dynamic lists using native tools, the update is not available to all existing clients and sessions immediately. Your clients might need to re-login to the database in order to see the changes.<br />
Similarly, the dynamic list editor is using an actual dynamic list as a primary trusted source of data for the records. When you initiate a record update, the record content is loaded from the dynamic list first. In an environment where dynamic lists are actively updated from many clients simultaneously, it might cause overwriting, because the cached list values could be used by ClearQuest. In a so changing environment, it is recommended to re-login to the database before starting a dynamic list modification (the same issue exists when you use native tools in the legacy ClearQuest Windows Client). <br />
If you rarely use native tools to update dynamic lists (for instance, when a ClearQuest full client is not installed on the Dynamic List Admins' machines, and they use the Editor's Web Client capability to modify lists only), you can select the ClearQuest records as a trusted source of data for the dynamic lists. In order to do so, you need to remove the "Update" action initialization hook from the Dynamic_List record type, and upgrade the user database to apply changes. This would ensure that the most accurate data is used for list modification.<br />
<br />
== Support ==<br />
: ClearQuest Dynamic List Editor is supported by [http://cqadmin.com CQAdmin, inc]. Three levels or support agreement are currently offered, starting with '''free''' community support at [http://forum.cqadmin.org http://forum.cqadmin.org]. Consulting services are also available.<br />
<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Dynamic_List_Editor]]</div>Paulhttps://cqadmin.org/w/index.php?title=ClearQuest_Dynamic_List_Editor&diff=269ClearQuest Dynamic List Editor2013-06-16T18:25:20Z<p>Paul: </p>
<hr />
<div><big>'''ClearQuest Dynamic List Editor'''</big><br />
<br />
Created by ClearQuest admin for ClearQuest admins.<br />
<br />
= Dynamic List Editor =<br />
This is NOT a solution that is provided and supported by IBM-Rational. <br />
The Dynamic List Editor is an add-on to your existing ClearQuest schema, VBScript or Perl based, that provides a unified interface to administer Dynamic Lists for Windows, Eclipse, UNIX clients, and (most importantly) the Web client. Additionally, it adds basic audit capabilities that can be enhanced using the Audit Trail package.<br />
The enhancement is distributed as a ClearQuest schema integration, and it can be easily removed from the schema when it is no longer required.<br />
<br />
In the Editor, all dynamic lists are represented by correspondent stateless records of the Dynamic_List record type.<br />
<br />
[[File:Dynamic_List_Editor.png|center]] <br />
<br />
Dynamic List administrators work with the stateless records, and when the update is completed and records are submitted to the database, the correspondent dynamic lists are updated automatically.<br />
<br />
== Installation Instruction ==<br />
'''Please create a backup of schema and user databases before the installation.'''<br /><br />
The package is an add-on to your existing ClearQuest schema. In order to install it, you will need ClearQuest administrative access and administrative tools (ClearQuest designer). When the configuration is completed, users with the "Dynamic List Admin" privilege or super users can modify the content of the Dynamic Lists using ClearQuest Web or other ClearQuest clients.<br />
<br />
=== Automatic Install ===<br />
* Unpack the distribution to your local or network drive (you cannot start the installation from a network share using UNC path)<br />
* Launch "install.bat" in the root of the distribution<br />
* Accept license agreement<br />
* Provide administrative user credentials, ClearQuest connection, database name, and click on "Connect"<br />
<br />
When installation is completed, login to the user database and run "Public Queries/Administration/Dynamic_Lists" query to verify Dynamic list data. You can start using the tool immediately.<br />
<br />
=== Manual Install ===<br />
You can install the Editor manually: [[ClearQuest_Dynamic_List_Editor_ManualSetup | Manual Setup ]].<br />
<br />
<br />
== Administering Dynamic Lists ==<br />
When installation is completed, ClearQuest administrators can start using ClearQuest client to query Dynamic_Lists records to modify the content of the linked dynamic lists. If you used installation wizard, "Dynamic Lists" query is located in the "Administration" folder of the "Public Queries" workspace:<br />
<br />
<br />
[[File:Dynamic_List_Sync_3.png|center]]<br />
<br />
<br />
Most of the time, the "Update" action is sufficient. In addition, the Editor offers the following actions to simplify administration:<br />
{| class="wikitable"<br />
! Action Name<br />
! Action Type<br />
! Access Control<br />
! Description<br />
|-<br />
| Submit<br />
| Submit<br />
| Super User<br />
| Submit allows the creation of new records when a new Dynamic List added to the ClearQuest schema. You can also use the "SyncAllLists" utility action to synchronize all the records at once.<br />
|-<br />
| Update<br />
| Modify<br />
| Super User, Dynamic List Admins<br />
| Update is the primary action for administering Dynamic Lists content. When an action is initialized, the record is refreshed with the latest content of the dynamic list (please check "Dynamic List Caching" section). When the updated record is saved, its content is saved in the correspondent dynamic list as well.<br />
|-<br />
| Delete<br />
| Utilities / Delete<br />
| Super User<br />
| This action allows you to delete existing Dynamic_List records, such as when a correspondent dynamic list is removed from the schema. Alternatively, you can use the "SyncAllLists" utility action to synchronize all records at once after a database upgrade.<br />
|-<br />
| LoadList<br />
| Utilities / Script<br />
| Super User, Dynamic List Admins<br />
| Load List action updates the current ClearQuest record with the content of the correspondent dynamic list. Please be aware that in order to see the update you might need to refresh the ClearQuest query or even to close and re-run it.<br />
|-<br />
| SaveList<br />
| Utilities / Script<br />
| Super User, Dynamic List Admins<br />
| Save List action saves the content of the current ClearQuest records into a correspondent dynamic list.<br />
|-<br />
| SaveAllLists<br />
| Utilities / Script<br />
| Super User, Dynamic List Admins<br />
| Save all lists saves the content of all ClearQuest Dynamic List records into correspondent dynamic lists. It might be useful when records are imported from an external source.<br />
|-<br />
| SyncAllLists<br />
| Utilities / Script<br />
| Super User<br />
| This action syncs ClearQuest records with their correspondent dynamic lists:<br />
* when the ClearQuest record already exists, its content is updated from the dynamic list<br />
* when the ClearQuest record does not exist, a new record is created<br />
* when a dynamic list for the existing ClearQuest record does not exist, the record is deleted.<br />
|}<br />
<br />
== Dynamic Lists Caching ==<br />
In order to improve performance, ClearQuest caches the content of dynamic lists. When you update the content of dynamic lists using native tools, the update is not available to all existing clients and sessions immediately. Your clients might need to re-login to the database in order to see the changes.<br />
Similarly, the dynamic list editor is using an actual dynamic list as a primary trusted source of data for the records. When you initiate a record update, the record content is loaded from the dynamic list first. In an environment where dynamic lists are actively updated from many clients simultaneously, it might cause overwriting, because the cached list values could be used by ClearQuest. In a so changing environment, it is recommended to re-login to the database before starting a dynamic list modification (the same issue exists when you use native tools in the legacy ClearQuest Windows Client). <br />
If you rarely use native tools to update dynamic lists (for instance, when a ClearQuest full client is not installed on the Dynamic List Admins' machines, and they use the Editor's Web Client capability to modify lists only), you can select the ClearQuest records as a trusted source of data for the dynamic lists. In order to do so, you need to remove the "Update" action initialization hook from the Dynamic_List record type, and upgrade the user database to apply changes. This would ensure that the most accurate data is used for list modification.<br />
<br />
== Support ==<br />
: ClearQuest Dynamic List Editor is supported by [http://cqadmin.com CQAdmin, inc]. Three levels or support agreement are currently offered, starting with '''free''' community support at [http://forum.cqadmin.org http://forum.cqadmin.org]. Consulting services are also available.<br />
<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Dynamic_List_Editor]]</div>Paulhttps://cqadmin.org/w/index.php?title=ClearQuest_Dynamic_List_Editor_ManualSetup&diff=268ClearQuest Dynamic List Editor ManualSetup2013-06-16T18:16:38Z<p>Paul: Created page with "<big>'''ClearQuest Dynamic List Editor'''</big> === Manual Setup of a ClearQuest Schema === It is highly recommended to test the procedure in your development environment, an..."</p>
<hr />
<div><big>'''ClearQuest Dynamic List Editor'''</big><br />
<br />
=== Manual Setup of a ClearQuest Schema ===<br />
It is highly recommended to test the procedure in your development environment, and backup master and user databases before you start.<br />
<br />
==== Schema Integration ====<br />
The schema integration, "Dynamic_List_Editor.txt", is locate in the "data" folder of the installation directory. It is a text file that can be easily scanned or inspected.<br />
<br />
==== Apply Integration to ClearQuest Schema ====<br />
* Verify that the ClearQuest schema is checked in, and that there are no pending schema changes that have not been applied to the user database.<br />
* Open the command line tool, (Start->Run "cmd") and change the directory to the location where the integration package was extracted.<br />
* Import integration using the "cqload importintegration" command. For example:<br />
cqload importintegration -dbset <db_connection_name> <admin_user> <admin_password> <ClearQuest_Schema_Name> "" "Dynamic List Editor" 1.0 Dynamic_List_Editor.txt ""<br />
* Verify that the schema update was imported and no issues were detected.<br />
<br />
<br />
[[File:cqload_completed.png|center]]<br />
<br />
<br />
==== Upgrade User Database ====<br />
Now, you can apply changes to the user database using ClearQuest Designer. For Eclipse Designer, in the ClearQuest Database Admin section, right click on the user database that you are going to apply changes to, and select "Upgrade Database" from the context menu. (In legacy Windows Designer, select the "Upgrade Database..." option from the database menu and select your user database).<br />
<br />
<br />
[[File:upgrade_db.png|center]]<br />
<br />
<br />
Apply the change that you imported on the previous step by clicking the "OK" button. Verify that user database was upgraded successfully.<br />
<br />
<br />
[[File:upgrade_db_completed.png|center]]<br />
<br />
<br />
==== Import First Dynamic List ====<br />
The rest of the configuration can be completed from a ClearQuest client. You can use any client of your choice. The instructions are based on ClearQuest Web client, version 8.0.<br />
Login as an administrator (super user), and submit a new record of the "Dynamic_List" type:<br />
<br />
<br />
[[File:Submit_Dynamic_List_1.png|center]]<br />
<br />
<br />
Select one of the list names from the "Name" drop-down list.<br />
<br />
<br />
[[File:Submit_Dynamic_List_2.png|center]]<br />
<br />
<br />
Dynamic list values will be populated automatically.<br />
<br />
<br />
[[File:Submit_Dynamic_List_3.png|center]]<br />
<br />
<br />
click "Save" to commit the record to the database<br />
<br />
<br />
==== Creating Dynamic List Administration Query ====<br />
Now, you will need to create a simple query that will be used by Dynamic Lists administrators. Right click on the folder you are going to save the query to, and select "New Query" from the context menu.<br />
<br />
<br />
[[File:Dynamic_List_Query _1.png|center]] <br />
<br />
<br />
Select "Dynamic_Query" as a record type<br />
<br />
<br />
[[File:Dynamic_List_Query _2.png|center]]<br />
<br />
<br />
Provide a query name (for instance, "Dynamic Lists"), add the "Name" field to the presentation/display section, and specify the "Ascending" (A-Z) sort order. Save the query.<br />
<br />
<br />
[[File:Dynamic_List_Query _3.png|center]]<br />
<br />
<br />
==== Importing Dynamic Lists ====<br />
Run the "Dynamic Lists" query that we created on the previous step. You should see one Dynamic List record in the result set. Select the record, and in the "Utilities" section, chose the "SyncAllLists" action.<br />
<br />
<br />
[[File:Dynamic_List_Sync_1.png|center]]<br />
<br />
<br />
The action syncs ClearQuest records with the correspondent dynamic lists:<br />
* when the ClearQuest record already exists, its content is updated from the dynamic list<br />
* when the ClearQuest record does not exist, a new record is created<br />
* when a dynamic list for the existing ClearQuest record does not exist, the record is deleted.<br />
<br />
<br />
[[File:Dynamic_List_Sync_2.png|center]]<br />
<br />
<br />
If no error occurred, a confirmation is displayed. Otherwise, you would see an error message.<br />
Refresh the query to verify that all dynamic lists with their proper content are loaded.<br />
<br />
<br />
[[File:Dynamic_List_Sync_3.png|center]]<br />
<br />
<br />
== Support ==<br />
: ClearQuest Dynamic List Editor is supported by [http://cqadmin.com CQAdmin, inc]. Three levels or support agreement are currently offered, starting with '''free''' community support at [http://forum.cqadmin.org http://forum.cqadmin.org]. Consulting services are also available.<br />
<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Dynamic_List_Editor]]</div>Paulhttps://cqadmin.org/w/index.php?title=User_Admin_Tool_Installation&diff=267User Admin Tool Installation2013-06-16T11:46:09Z<p>Paul: </p>
<hr />
<div><big>'''User Administration Tool Installation'''</big><br />
<br />
== Planing the Installation ==<br />
User Administration Tool for IBM-Rational ClearQuest is a ClearQuest database. The installer will add a custom schema to your schema repository, create user database associated with the schema, and load all data. Before you proceed, you need to collect:<br />
* Physical Database information of empty database (DB vendor, server, database name, database user account, and connect options). The database needs to be created in advance (unless you are going to use Microsoft Access).<br />
* Email notification settings - SMTP server name and email user credentials (if password authentication is required with SMTP relay). You can check [[Package_configuration | Email Notification Package Configuration]] page for additional information.<br />
* Obtain local administrative rights on the machine where you are going to perform the installation.<br />
* Create (or use an existing) ClearQuest account with Super User right that will be used for user account management. It is recommended to use ClearQuest authentication for the account to avoid problems related to password expiration.<br />
<br />
== Backup Schema Repository Database ==<br />
It is always a good idea to create a backup before you making any change to the schema repository to roll back the change if necessary, and I strongly recommend to install the tool in your testing environment first: you would be able to validate that it is compatible with your environment and database vendor. It would minimize risks associated with deployment of the tool in your production environment later.<br />
<br />
<br />
== Installing User Admin Tool ==<br />
You can run installation of the User Administration tool on any machine that has IBM-Rational ClearQuest installed and ClearQuest connection configured. <br />
<br />Download and run "setup.exe", accept license agreement. If "Run User Administration DB Setup Wizard" task is selected, user administration tool setup will be launched automatically. You can setup user administration database later by using "DB Setup" wizard located in the programs menu (Programs -> CQAdmin -> DB Setup). <br />
<br />
<br />Login to the ClearQuest using connection (dbset) that you would like to enable for user administration using Super User account you created on the "planning..." step.<br />
[[File:user_admin_install_login.png|none]]<br />
<br />
<br />Provide required information to create ClearQuest User Administration database. Depending on your database vendor and environment, you might need to provide additional connection options. Please check ClearQuest administration manual for details. If you aborted the installation for any reason after user database was created, you would be allowed to select user database created earlier instead of creating a new one.<br />
[[File:user_admin_db_settings.png|none]]<br />
<br />
<br />Verify that you entered all information and click on "Create DB" button. The installer will start creating user database and importing all user data. There is no progress indicator, please be patient. Depending on database server load and number of user accounts the initial load might take significant time. For example, in my local environment it takes about 15 minutes to load 3000 users and groups.<br />
<br />
When user database is created and data import is completed, the installer will offer you to configure email notification setting. Please provide required information and save settings. The installer will validate SMTP server connectivity.<br />
[[File:user_admin_en_config.png|none]]<br />
<br />
<br />It is the last step in the installation procedure, and no error occurred, you should receive the following confirmation. <br />
[[File:user_admin_install_completed.png|none]]<br />
<br />
<br />Congratulations! You have completed your installation. Log in to the ClearQuest database you created and you can start using it immediately.<br />
<br />
== Additional Information==<br />
The following links could be useful<br />
* [[User_Admin_Tool_Configuration | Configuring User Administration Tool]]<br />
* [[Managing_ClearQuest_Users | Managing ClearQuest Users]].<br />
* [http://forum.cqadmin.org/ Support forum]<br />
<br />
<br />
[[Category:Rational]] [[Category:User_Admin_Tool]]</div>Paulhttps://cqadmin.org/w/index.php?title=Email_Notification_Service_Configuration&diff=266Email Notification Service Configuration2013-06-07T12:34:08Z<p>Paul: Created page with "'''EmailNotification Service Configuration File''' <source lang="xml"> <?xml version="1.0" encoding="UTF-8" standalone="no"?> <configuration> <!-- ClearQuest login and pa..."</p>
<hr />
<div>'''EmailNotification Service Configuration File'''<br />
<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="UTF-8" standalone="no"?><br />
<configuration><br />
<br />
<!-- <br />
ClearQuest login and password <br />
cleartext password must be encrypted using "encrypt" command <br />
--><br />
<login>admin</login><br />
<password>unencrypted_password</password><br />
<br />
<!--<br />
DBSets configured for email notification<br />
--><br />
<dbsets><br />
<!--each connection starts with <dbset> tag --> <br />
<dbset><br />
<!--connection name (dbset)--><br />
<name>ClearQuest Connection Name</name><br />
<!-- dbset specific credentials can be specified here. It would override global settings<br />
password can be provided as clear text and encrypted using “encrypt” command.<br />
<br />
<login>connection-specific-login-name</login><br />
<password>connection-specific-password</password><br />
--> <br />
<br />
<!-- all user databases --><br />
<databases><br />
<database>DB1</database><br />
<database>DB2</database><br />
</databases><br />
</dbset><br />
<br />
<dbset><br />
<name>Another ClearQuest DBSet</name><br />
<databases><br />
<database>DB3</database><br />
</databases><br />
</dbset><br />
</dbsets><br />
<br />
<!--additional configuration options <br />
Logfile – alternative log file name--><br />
<logfile>new_log_file_name</logfile><br />
<br />
<!-- Log level – desirable logging level --><br />
<loglevel>ALL</loglevel><br />
<br />
<!-- debug – turn on debug output --><br />
<debug>true</debug><br />
<br />
<!-- verbose – turn on console output --><br />
<verbose>true</verbose><br />
<br />
<br />
<!-- <br />
Local configuration flag<br />
when set to "false" email settings are retrieved from the ClearQuest database<br />
--><br />
<localconfig>false</localconfig><br />
<br />
<!-- example of the local email settings<br />
<localconfig>true</localconfig><br />
<br />
email host – SMTP server name. It might include port number. <br />
<br />
<email_host>hostname:port</email_host><br />
Alternatively, port number can be specified as <mail.smtp.port>port</mail.smtp.port><br />
<br />
Authentication credentials. Password can be provided as clear text and encrypted using “encrypt” command.<br />
<email_login>loginname</email_login><br />
<email_password>password</email_password><br />
<br />
turn on STARTTLS on smtp connection:<br />
<mail.smtp.starttls>true</mail.smtp.starttls><br />
trust particular host self-signed or invalid certificate<br />
<mail.smtp.ssl.trust>my.host.name</mail.smtp.ssl.trust><br />
<br />
use SSL:<br />
<email_use_ssl>true</email_use_ssl><br />
<br />
<br />
--><br />
<br />
</configuration><br />
<br />
</source><br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=Email_Notification_Service_Command_Line&diff=265Email Notification Service Command Line2013-06-07T12:28:37Z<p>Paul: Paul moved page Delivery Service Command Line to Email Notification Service Command Line without leaving a redirect</p>
<hr />
<div>'''Email Notification Package Delivery Service Command Line'''<br />
<br />
'''Usage:''' cqemail [options] command<br />
<br />
{| class="wikitable" cellpadding="10"<br />
! align="center"| Command<br />
! Description<br />
|-<br />
|'''once'''<br />
|Query databases for eligible email messages, attempt delivery, and exit. It was a default behavior of the Email Delivery Script.<br />
|-<br />
|'''run'''<br />
|Run delivery attempts on defined schedule. Default schedule is to make delivery attempt every five minutes with 0 second offset from the beginning on the hour. It can be overridden by setting "interval" and "offset" parameters in the configuration file, or by correspondent command line options.<br />
|-<br />
|'''save-options'''<br />
|Save options given as command line parameters in the configuration file.<br />
|-<br />
|'''encrypt-passwords'''<br />
|Encrypt clear text password in the configuration file. All passwords in the configuration file must be in clear-text before running this command. It does not check if the password already encrypted or not.<br />
|-<br />
|'''configure'''<br />
|Run configuration graphical user interface.<br />
|-<br />
|}<br />
<br /><br />
{| class="wikitable" cellpadding="10"<br />
! align="center"| Option<br />
! Description<br />
|-<br />
| -h, --help<br />
|Print help message.<br />
|-<br />
| -V, --version<br />
|Print version information.<br />
|-<br />
| -C, --config <file><br />
|Use an alternative configuration file given as <file>. Default configuration file name is config/config.xml.<br />
|-<br />
| -u, --login <login><br />
|ClearQuest login name. Overrides login name provided in the configuration file.<br />
|-<br />
| -p, --password <password><br />
|ClearQuest password. Overrides user password specified in the configuration file.<br />
|-<br />
| -db, --database <database><br />
|ClearQuest database name. Overrides dbset options set in the configuration file.<br />
|-<br />
| -dbs, --dbset <dbset><br />
|ClearQuest connection name (dbset). Overrides dbset set in the configuration file<br />
|-<br />
| --localconfig<br />
|Use local configuration file for the email notification settings. When set in command line or in the configuration file, SMTP server name, port, authentication credential and connection settings retrieved from the configuration file. When is not set (or set to "false" in the configuration file), ClearQuest user database properties are queried first. It was a default behavior for the email notification package delivery script.<br />
|-<br />
| -L, --logfile <file><br />
|Use alternative log file name (default is log/notification.log)<br />
|-<br />
| --loglevel <LEVEL><br />
|Specify desirable log level. (one of the following: ALL SEVERE WARNING INFO FINE FINER FINEST).<br />
|-<br />
| --debug<br />
|Turn on debug output.<br />
|-<br />
| -v, --verbose<br />
|Turn on console output<br />
|-<br />
| --interval <seconds><br />
|Specify scheduled run interval in seconds. Default is 300 – every 5 minutes.<br />
|-<br />
| --offset <seconds><br />
|Specify desirable offset of the scheduled execution from the beginning of the hour. Default is 0. It can be used to schedule email delivery from multiple hosts for redundancy and avoid racing conditions. For instance, you can run delivery every 5 minutes on host1 and host2, and use offset 150 (2.5 minutes) on one of them. In this case host1 runs delivery at hh:00:00, hh:05:00, hh:10:00, hh:15:00 ... and host2 at hh:02:30, hh:07:30, hh:12:30, hh:17:30 ...<br />
|-<br />
|}<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=CQAdmin&diff=264CQAdmin2013-06-06T19:42:18Z<p>Paul: </p>
<hr />
<div><big>'''Rational Administrators'''</big><br />
<br />
This site was created to provide tools, information, and share experience that might be useful for Rational tools administrators. <br />
<br />
It is powered by [http://www.mediawiki.org MediaWiki] and opened for everyone. If you would like to contribute your materials, please feel free to do it.<br />
<br />
<br />
== Latest news ==<br />
* '''The [[User_Admin_Tool | User Administration Tool for IBM-Rational ClearQuest]] is "Ready for IBM-Rational Software"'''<br />
: The User Administration Tool was successfully validated to the requirements of <i style="color:blue;">Ready for IBM Rational Software</i>. It met the requirements for the IBM Software Delivery Platform level of the program. The User Administration tool simplifies site management and adds other valuable features, such as Web-based user administration, ultimate query and search capabilities, customizable defaults and validations, user profiling and templates, granular access, reporting and audit, email notifications and more.<br />
<br />
* '''[[ClearQuest_Email_Notification_Package | Email Notification Package]] is "Ready for IBM-Rational Software"'''<br />
: Email Notification package was successfully validated to the requirements of <i style="color:blue;">Ready for IBM Rational Software</i>. The package met the requirements for the IBM Software Delivery Platform level of the program.<br />
<br />
* '''Commercial Support'''<br />
: ClearQuest Email Notification package is officially [http://store.cqadmin.com/index.php/clearquest/cq-email-notification/email-notification-package-support.html supported] by [http://cqadmin.com CQAdmin, inc]. Three levels or support are currently offered, starting with '''free''' community support at [http://forum.cqadmin.org http://forum.cqadmin.org]. Consulting services are also available.<br />
<br />
<br />
== Resources ==<br />
* [[ClearQuest_Email_Notification_Package | Email Notification Package]] for IBM-Rational ClearQuest. <br />
: If you would like to use flexible notification rules, reliable delivery, sending HTML emails with rich text, fonts, and colors, configuring reminders, and many other features, you might like the package.<br />
<br />
* [[User_Admin_Tool | User Administration Tool]] for IBM-Rational ClearQuest.<br />
: It simplifies site management and adds other valuable features, such as customizable defaults and validations, user profiling and templates, reporting and audit, email notifications and more. <br />
<br />
* [[ClearQuest_Dynamic_List_Editor | Dynamic List Editor]] for IBM-Rational ClearQuest. <br />
: Would you like to administer Dynamic Lists via the ClearQuest Web client? You might consider using the editor.<br />
<br />
* '''Support forum'''<br />
: Support forum is available now. Please do not hesitate to ask questions or share your experience.<br />
: [http://forum.cqadmin.org/ http://forum.cqadmin.org/]<br />
<br />
<br /><br /><br />
<br />
[[Category:Rational]]</div>Paulhttps://cqadmin.org/w/index.php?title=Email_Notification_Service_Command_Line&diff=263Email Notification Service Command Line2013-06-02T10:42:11Z<p>Paul: Created page with "'''Email Notification Package Delivery Service Command Line''' '''Usage:''' cqemail [options] command {| class="wikitable" cellpadding="10" ! align="center"| Command ! Descr..."</p>
<hr />
<div>'''Email Notification Package Delivery Service Command Line'''<br />
<br />
'''Usage:''' cqemail [options] command<br />
<br />
{| class="wikitable" cellpadding="10"<br />
! align="center"| Command<br />
! Description<br />
|-<br />
|'''once'''<br />
|Query databases for eligible email messages, attempt delivery, and exit. It was a default behavior of the Email Delivery Script.<br />
|-<br />
|'''run'''<br />
|Run delivery attempts on defined schedule. Default schedule is to make delivery attempt every five minutes with 0 second offset from the beginning on the hour. It can be overridden by setting "interval" and "offset" parameters in the configuration file, or by correspondent command line options.<br />
|-<br />
|'''save-options'''<br />
|Save options given as command line parameters in the configuration file.<br />
|-<br />
|'''encrypt-passwords'''<br />
|Encrypt clear text password in the configuration file. All passwords in the configuration file must be in clear-text before running this command. It does not check if the password already encrypted or not.<br />
|-<br />
|'''configure'''<br />
|Run configuration graphical user interface.<br />
|-<br />
|}<br />
<br /><br />
{| class="wikitable" cellpadding="10"<br />
! align="center"| Option<br />
! Description<br />
|-<br />
| -h, --help<br />
|Print help message.<br />
|-<br />
| -V, --version<br />
|Print version information.<br />
|-<br />
| -C, --config <file><br />
|Use an alternative configuration file given as <file>. Default configuration file name is config/config.xml.<br />
|-<br />
| -u, --login <login><br />
|ClearQuest login name. Overrides login name provided in the configuration file.<br />
|-<br />
| -p, --password <password><br />
|ClearQuest password. Overrides user password specified in the configuration file.<br />
|-<br />
| -db, --database <database><br />
|ClearQuest database name. Overrides dbset options set in the configuration file.<br />
|-<br />
| -dbs, --dbset <dbset><br />
|ClearQuest connection name (dbset). Overrides dbset set in the configuration file<br />
|-<br />
| --localconfig<br />
|Use local configuration file for the email notification settings. When set in command line or in the configuration file, SMTP server name, port, authentication credential and connection settings retrieved from the configuration file. When is not set (or set to "false" in the configuration file), ClearQuest user database properties are queried first. It was a default behavior for the email notification package delivery script.<br />
|-<br />
| -L, --logfile <file><br />
|Use alternative log file name (default is log/notification.log)<br />
|-<br />
| --loglevel <LEVEL><br />
|Specify desirable log level. (one of the following: ALL SEVERE WARNING INFO FINE FINER FINEST).<br />
|-<br />
| --debug<br />
|Turn on debug output.<br />
|-<br />
| -v, --verbose<br />
|Turn on console output<br />
|-<br />
| --interval <seconds><br />
|Specify scheduled run interval in seconds. Default is 300 – every 5 minutes.<br />
|-<br />
| --offset <seconds><br />
|Specify desirable offset of the scheduled execution from the beginning of the hour. Default is 0. It can be used to schedule email delivery from multiple hosts for redundancy and avoid racing conditions. For instance, you can run delivery every 5 minutes on host1 and host2, and use offset 150 (2.5 minutes) on one of them. In this case host1 runs delivery at hh:00:00, hh:05:00, hh:10:00, hh:15:00 ... and host2 at hh:02:30, hh:07:30, hh:12:30, hh:17:30 ...<br />
|-<br />
|}<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=Email_Notification_Service&diff=262Email Notification Service2013-06-02T10:19:07Z<p>Paul: Created page with "'''EmailNotification package Delivery Service''' The service performs centralized email delivery for ClearQuest user databases utilizing [[ClearQuest_Email_Notification_Packag..."</p>
<hr />
<div>'''EmailNotification package Delivery Service'''<br />
The service performs centralized email delivery for ClearQuest user databases utilizing [[ClearQuest_Email_Notification_Package | Email Notification]] package in '''Queue''' mode. It features:<br />
* Servicing multiple user databases and multiple connections (dbsets)<br />
* Performing scheduled delivery with configured interval and offset.<br />
* Operating in console mode, or working as a service.<br />
* Sending emails via secure connection using SMTP over SSL or STARTTLS extension.<br />
* Supporting login, digest, and NTLM authentication mechanisms.<br />
* Preventing user credentials from exposure by encrypting them in the configuration file.<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=ClearQuest_Email_Notification_Package&diff=261ClearQuest Email Notification Package2013-04-15T19:43:17Z<p>Paul: </p>
<hr />
<div><big>'''ClearQuest Email Notification Package'''</big> [[File:R4_Rational.jpg|right|140px]] <!--[[File:R4_Rational.jpg|right|140px]]--><br />
<br />
Created by ClearQuest admin for ClearQuest admins.<br />
<br />
== Email Notification Package ==<br />
It is NOT a solution that is provided and supported by IBM-Rational. It is a replacement of existing package that allows you to overcome drawbacks of standard solution and satisfy all notification requirements that you might possibly have, creating custom emails using text or HTML. <br />
The package offers ultimately flexible way of customizing notifications with no need of modifying ClearQuest schema. Usually, you need to update schema once, when you installing the package and applying it to desirable record types. It offers you rich functionality from the beginning and allows your to enhance it.<br />
<br />
The package was initially released in 2004, and presented on [http://cqadmin.org/data/CCMA43.pdf RUC 2006] and [http://cqadmin.org/data/Reno_VoiCE-ClearQuest_Email.pdf IBM VoiCE 2011].<br />
<br />
Here is a quick overview of some of the features. <br />
<br />
<br />
=== Centralized configuration and maintenance ===<br />
Email settings are stored in the ClearQuest user database. You do not need to configure every client. You configured notification on the database, turned them on – and it is working for all users, regardless of the client type: Windows, CCWeb, UNIX. It also easy to turn off notifications when they are not necessary. For example, you copied your production database to a test environment, turned the plug off, and you do not bother your users with annoying emails while testing. <br />
<br />
<br />
=== Reliable delivery/Message Queue ===<br />
If message cannot be delivered due to SMTP relay outage, delivery error or connectivity issue, it is saved in the message queue and will be re-delivered. You can optimize delivery mode based on your own requirements and needs. There are tree delivery modes offered by the package '''Light''', '''Deferred''' (default), and '''Queue'''.<br />
<br />
In case of '''Light''' delivery mode each client tries to deliver message to SMTP relay immediately, and store generated messages in the database for further re-delivery if attempt was unsuccessful only.<br />
<br />
'''Deferred''' delivery means that client stores all triggered messages in database message queue first, and then tries to deliver them, as well as other eligible messages that might be left from previous unsuccessful delivery attempts. All messages are sent in batch mode when rules evaluation is completed.<br />
<br />
In case of '''Queue''' delivery mode, client stores all messages in database and does not attempt to deliver. In this case, SMTP delivery is performed by separate CQPerl script running from ClearQuest server.<br />
<br />
You can find out more about delivery modes [[ClearQuest_Email_Notification_Package_Delivery_Mode | here]].<br />
<br />
<br />
=== Email Message Log/Audit trail ===<br />
In Deferred and Queue delivery mode all generated messages are stored in the message queue, which is a ClearQuest table. You are able to validate what was sent and when, check for delivery errors, error messages. In addition to that you can update and re-deliver messages if necessary within the ClearQuest.<br />
<br />
Message queue is also useful to develop and debug email notification rules. For example, you can turn on email notifications on your test database, and set Queue delivery mode without delivery script running. Email Rules will be evaluated, emails triggered and saved in the database, but users would not be disturbed. You can review generated emails and sent them manually, if necessary.<br />
<br />
<br />
=== Customizable message envelope and body ===<br />
You can create almost any message you want. Most of the field in the notification rule that defines email message are free-text fields, where you can embed parameters, such as record fields, database properties, results of SQL statements execution, Package or Perl build-in, and user-defined function. At runtime, during the rules evaluation, these parameters will be expanded, substituted with actual field values and function's return results.<br />
<br />
<br />
For example, you configured subject in your email notification rule as: <br />
Defect $ID has been $State<br />
and subject in the generated email message might look like <br />
Subject: Defect RATL0000001 has been closed <br />
<br />
<br />
You can also use html emails with rich formatting, colors, embedded images, links, etc.<br /><br /><br />
[[File:sample_email.png|border]]<br />
<br />
<br />
=== Configurable email message priority ===<br />
Users receive tons of emails, and sometimes you need to attract their attention to some of them. Priority field can be used to flag some messages. It can be a static priority specified for email notification rule, or dynamically evaluated priority. For example, you can flag messages that are generated by incident with Severity 1 only. Since your email body is also customizable, you can add there details instructions for the recipient on what needs to be done when they received such email.<br />
<br />
<br />
=== Additional header information ===<br />
It might be required to include some information not just to message body, but also to the message envelope. For example, to inform the mail agent about character set used in the message, or specify particular message type, such as html, etc. <br />
It could be used for specifying reply-to address, references, or other special information.<br />
<br />
<br />
=== Notification conditions ===<br />
Notification condition filed provide you additional mechanism to customize message behavior. Along with fields, parameters and function, you can use logical comparison, arithmetic and other operators, as well as regular expressions patterns.<br />
<br />
<br />
=== Message sender and reply-to address ===<br />
You can send email using the current user email address in the “From:” field, select a dedicated email address that will be used for all emails generated in the database, or create from email address dynamically when email is triggered. It is flexible and can be used in many ways. For example, it can help you satisfying mail relaying policies in very restrictive environments. If necessary, you can configure different Reply-To address, that will be used when users try to reply to generated emails.<br />
<br />
<br />
=== Site-specific settings in Multisited environment ===<br />
If you use ClearQuest multisite, you might change some database settings based on the site where you are located. For example, to point your users to a site-specific SMTP relay. It is not a problem: the package allows you to create global, as well as site specific settings, to modify or unset global database properties on particular site.<br />
<br />
<br />
=== Password authentication with SMTP relay ===<br />
Optionally, you can configure password authentication with SMTP relay. Credentials used for notification can be saved as encrypted values in the database<br />
<br />
<br />
=== Reminders ===<br />
Another nice feature of the package that it allows you to configure reminders, such as notifications about approaching due date, or other important events. I called it [[Timed_Notification | Timed Notification]]. You can create a template using the same flexible email notification rules, and Timed Notification script will trigger them using dummy action.<br />
<br />
<br />
=== Email Notification Subscription ===<br />
You can allow users to manage there email notification rules subscription preferences. This functionality is delivered with optional '''EmailSubscription''' package. It can be used as-is, enhanced, or taken as an example to implement your own, more sophisticated end-user subscription solution. Please check [[ClearQuest_Email_Subscription | Email Subscription]] page for details.<br />
<br />
== Getting Started ==<br />
<br />
Would you like to try it? Then, '''create a backup of your schema and user database''', or (even better) create test environment with master and user databases. Many customers have been using the package for years, but it is always makes sense to test the package in your specific environment and check for conflicts with existing hooks, issues with particular database vendor and version, etc, and update production when you are sure that it would be safe to do it only.<br />
<br />
<br />
# [[Download | Download]] the package.<br />
# [[Package_installation | Install it]].<br />
# Create your [[EmailNotification_Creating_First_Notification_Rule | first notification rule]]<br />
<br />
<br />
== Additional Information ==<br />
# It could be useful to read [[Package_configuration | package configuration guide]] and<br />
# [[ClearQuest_Email_Notification_Package_FAQ | Frequently Asked Questions ]]<br />
# Please check [[Notification_Examples | Examples]] and<br />
# [http://cqadmin.org/data/CCMA43.pdf Extending IBM(R) Rational(R) ClearQuest(R) Email Notifications] presentation<br />
# [[Timed_Notification | Reminders / Timed Notifications]]<br />
# [[ClearQuest_Email_Subscription | End users self-subscription to email notifications]]<br />
# If you have questions or problems, welcome to the [http://forum.cqadmin.org/ support forum]<br />
<br />
<br />
== License == <br />
<br />
The ''ClearQuest Email Notification Package'' is licensed under the ''GNU Lesser General Public License'' (AKA, the "LGPL"), Version 2.1, February, 1999.<br />
<br />
<br />
== Support ==<br />
: ClearQuest Email Notification package is [http://store.cqadmin.com/index.php/clearquest/cq-email-notification/email-notification-package-support.html officially supported] by [http://cqadmin.com CQAdmin, inc]. Three levels or support agreement are currently offered, starting with '''free''' community support at [http://forum.cqadmin.org http://forum.cqadmin.org]. Consulting services are also available.<br />
<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=User_Admin_Tool&diff=260User Admin Tool2013-04-15T19:42:28Z<p>Paul: </p>
<hr />
<div><big>'''User Administration Tool for IBM-Rational ClearQuest'''</big> [[File:R4_Rational.jpg|right|140px]] <!-- comment --><br />
<br />
== Overview ==<br />
IBM-Rational ClearQuest is one of the greatest tools available in the IBM portfolio. It became even more valuable with introduction of the enhanced ClearQuest Web interface. Having Web based user administrating tool was a dream of ClearQuest administrators for a long time.<br />
I would like to present a Web based user administration tool that was implemented on IBM-Rational ClearQuest platform and does not require ClearQuest installation on an administrator's desktop. It simplifies remote site management and adds other features that were missing in the standard User Administrator.<br />
<br />
== Ultimate Query and Search Capabilities ==<br />
The User Administration tool is based on ClearQuest and utilized its powerful query and search capabilities. Finding users or groups has never been easier. The basic search can be enhanced using full-text search engine.<br />
<br />
== Customizable Defaults ==<br />
The tool allows you to setup defaults for most of the User and Group record fields. For example, you can choose default authentication mechanism to be LDAP instead of ClearQuest, specify default list of User Privileges, Groups, and Database subscription to simplify your life and save your valuable time. Even new user password can be randomly generated when you use ClearQuest authentication. <br />
<br />
== Customizable Fields Validation ==<br />
In addition to defaults, the tool offers enhanced validation features, and there would be no need to change schema. Most of the conditions can be specified in the database on the fly. For instance, you can check that user email is specified as an Internet email address from your company domain; use advanced validation for login name, full name, phone, etc. <br />
<br />
== Managing Users Using Profiles and Templates ==<br />
Have you ever tried creating user account that has "the same rights" as another user account in the enterprise database containing thousands of users and hundreds of groups? In this case you will like this feature. Mirroring user or adding "somebody else" rights has never been easier. You need to specify other user, and the system will take care of the rest.<br />
Moreover, it allows to setup a set of template profiles or roles that can be used to expedite new users provisioning and guard you from mistakes. Setting up new "CM Manager" or "Project Admin" would take seconds. <br />
<br />
== Granular Access ==<br />
In addition to the ClearQuest defined user permissions, the tool allows you to define its own equivalents. If you set up the system this way, the tool user admins would have user administration access within the User Admin Tool, but they would not be able to run the same operations using the standard user admin utility. It prevents from mistakes and unnecessary synchronizations between the databases.<br /><br />
In addition, the tool allows you to setup group administrators, users, that are allowed to administer specific group(s) only. If you are using ClearQuest authentication, you can also safely delegate password reset rights to your first-tier helpdesk personal. <br />
<br />
== Reporting ==<br />
The system provides a set of out-of-the box reports. In just few clicks you can get printable list of active users, or find out user accounts or groups that were updated since yesterday. You can also use provided report formats to build your own reports. <br />
<br />
== Audit Trail ==<br />
One of the most important for account management features is audit capability. When you use User Administration Tool, you can always answer the following questions: who, when, and what. More advanced audit capabilities are based on [[ClearQuest_Email_Notification_Package | Email Notification package]], and can be turned on at any time, and in case if it is not enough, you can use Audit Trail package to enhance audit capabilities.<br />
<br />
== Email Notifications ==<br />
The system offers customizable and ultimately flexible notification rules based on [[ClearQuest_Email_Notification_Package | Email Notification package]] for IBM-Rational ClearQuest. Configurable email formats, recipients, and advanced conditions allows you to implement any possible notification scenario. <br />
<br />
== Additional Information==<br />
The following links could be useful<br />
* [[User_Admin_Tool_Installation | Installing User Administration Tool]]<br />
* [[User_Admin_Tool_Configuration | Configuring User Administration Tool]]<br />
* [[Managing_ClearQuest_Users | Managing ClearQuest Users]].<br />
* [[Download | Downloads]]<br />
* [http://forum.cqadmin.org/ Support forum]<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:User_Admin_Tool]]</div>Paulhttps://cqadmin.org/w/index.php?title=CQAdmin&diff=259CQAdmin2013-04-15T19:41:47Z<p>Paul: </p>
<hr />
<div><big>'''Rational Administrators'''</big><br />
<br />
This site was created to provide tools, information, and share experience that might be useful for Rational tools administrators. <br />
<br />
It is powered by [http://www.mediawiki.org MediaWiki] and opened for everyone. If you would like to contribute your materials, please feel free to do it.<br />
<br />
<br />
== Latest news ==<br />
* '''The [[User_Admin_Tool | User Administration Tool for IBM-Rational ClearQuest]] is "Ready for IBM-Rational Software"'''<br />
: The User Administration Tool was successfully validated to the requirements of <i style="color:blue;">Ready for IBM Rational Software</i>. It met the requirements for the IBM Software Delivery Platform level of the program.<br />
<br />
* '''The [[User_Admin_Tool | User Administration Tool for IBM-Rational ClearQuest]] has been released.'''<br />
: The tool is implemented on IBM-Rational ClearQuest platform and does not require ClearQuest installation on administrator's desktop. It simplifies site management and adds other valuable features, such as ultimate query and search capabilities, customizable defaults and validations, user profiling and templates, granular access, reporting and audit, email notifications and more.<br />
<br />
* '''[[ClearQuest_Email_Notification_Package | Email Notification Package]] is "Ready for IBM-Rational Software"'''<br />
: Email Notification package was successfully validated to the requirements of <i style="color:blue;">Ready for IBM Rational Software</i>. The package met the requirements for the IBM Software Delivery Platform level of the program.<br />
<br />
* '''Commercial Support'''<br />
: ClearQuest Email Notification package is officially [http://store.cqadmin.com/index.php/clearquest/cq-email-notification/email-notification-package-support.html supported] by [http://cqadmin.com CQAdmin, inc]. Three levels or support are currently offered, starting with '''free''' community support at [http://forum.cqadmin.org http://forum.cqadmin.org]. Consulting services are also available.<br />
<br />
* '''IBM-Rational VoiCE 2011'''<br />
: ClearQuest Email Notification package was presented at IBM-Rational VoiCE 2011 conference in Reno, NV ([http://cqadmin.org/data/Reno_VoiCE-ClearQuest_Email.pdf presentation])<br />
<br /><br />
<br />
== Resources ==<br />
* [[ClearQuest_Email_Notification_Package | Email Notification Package]] for IBM-Rational ClearQuest. <br />
: If you would like to use flexible notification rules, reliable delivery, sending HTML emails with rich text, fonts, and colors, configuring reminders, and many other features, you might like the package.<br />
<br />
* [[User_Admin_Tool | User Administration Tool]] for IBM-Rational ClearQuest.<br />
: It simplifies site management and adds other valuable features, such as customizable defaults and validations, user profiling and templates, reporting and audit, email notifications and more. <br />
<br />
* [[ClearQuest_Dynamic_List_Editor | Dynamic List Editor]] for IBM-Rational ClearQuest. <br />
: Would you like to administer Dynamic Lists via the ClearQuest Web client? You might consider using the editor.<br />
<br />
* '''Support forum'''<br />
: Support forum is available now. Please do not hesitate to ask questions or share your experience.<br />
: [http://forum.cqadmin.org/ http://forum.cqadmin.org/]<br />
<br />
<br /><br /><br />
<br />
[[Category:Rational]]</div>Paulhttps://cqadmin.org/w/index.php?title=ClearQuest_Email_Notification_Package&diff=258ClearQuest Email Notification Package2013-04-13T17:26:35Z<p>Paul: </p>
<hr />
<div><big>'''ClearQuest Email Notification Package'''</big> <!--[[File:R4_Rational.jpg|right|140px]]--><br />
<br />
Created by ClearQuest admin for ClearQuest admins.<br />
<br />
== Email Notification Package ==<br />
It is NOT a solution that is provided and supported by IBM-Rational. It is a replacement of existing package that allows you to overcome drawbacks of standard solution and satisfy all notification requirements that you might possibly have, creating custom emails using text or HTML. <br />
The package offers ultimately flexible way of customizing notifications with no need of modifying ClearQuest schema. Usually, you need to update schema once, when you installing the package and applying it to desirable record types. It offers you rich functionality from the beginning and allows your to enhance it.<br />
<br />
The package was initially released in 2004, and presented on [http://cqadmin.org/data/CCMA43.pdf RUC 2006] and [http://cqadmin.org/data/Reno_VoiCE-ClearQuest_Email.pdf IBM VoiCE 2011].<br />
<br />
Here is a quick overview of some of the features. <br />
<br />
<br />
=== Centralized configuration and maintenance ===<br />
Email settings are stored in the ClearQuest user database. You do not need to configure every client. You configured notification on the database, turned them on – and it is working for all users, regardless of the client type: Windows, CCWeb, UNIX. It also easy to turn off notifications when they are not necessary. For example, you copied your production database to a test environment, turned the plug off, and you do not bother your users with annoying emails while testing. <br />
<br />
<br />
=== Reliable delivery/Message Queue ===<br />
If message cannot be delivered due to SMTP relay outage, delivery error or connectivity issue, it is saved in the message queue and will be re-delivered. You can optimize delivery mode based on your own requirements and needs. There are tree delivery modes offered by the package '''Light''', '''Deferred''' (default), and '''Queue'''.<br />
<br />
In case of '''Light''' delivery mode each client tries to deliver message to SMTP relay immediately, and store generated messages in the database for further re-delivery if attempt was unsuccessful only.<br />
<br />
'''Deferred''' delivery means that client stores all triggered messages in database message queue first, and then tries to deliver them, as well as other eligible messages that might be left from previous unsuccessful delivery attempts. All messages are sent in batch mode when rules evaluation is completed.<br />
<br />
In case of '''Queue''' delivery mode, client stores all messages in database and does not attempt to deliver. In this case, SMTP delivery is performed by separate CQPerl script running from ClearQuest server.<br />
<br />
You can find out more about delivery modes [[ClearQuest_Email_Notification_Package_Delivery_Mode | here]].<br />
<br />
<br />
=== Email Message Log/Audit trail ===<br />
In Deferred and Queue delivery mode all generated messages are stored in the message queue, which is a ClearQuest table. You are able to validate what was sent and when, check for delivery errors, error messages. In addition to that you can update and re-deliver messages if necessary within the ClearQuest.<br />
<br />
Message queue is also useful to develop and debug email notification rules. For example, you can turn on email notifications on your test database, and set Queue delivery mode without delivery script running. Email Rules will be evaluated, emails triggered and saved in the database, but users would not be disturbed. You can review generated emails and sent them manually, if necessary.<br />
<br />
<br />
=== Customizable message envelope and body ===<br />
You can create almost any message you want. Most of the field in the notification rule that defines email message are free-text fields, where you can embed parameters, such as record fields, database properties, results of SQL statements execution, Package or Perl build-in, and user-defined function. At runtime, during the rules evaluation, these parameters will be expanded, substituted with actual field values and function's return results.<br />
<br />
<br />
For example, you configured subject in your email notification rule as: <br />
Defect $ID has been $State<br />
and subject in the generated email message might look like <br />
Subject: Defect RATL0000001 has been closed <br />
<br />
<br />
You can also use html emails with rich formatting, colors, embedded images, links, etc.<br /><br /><br />
[[File:sample_email.png|border]]<br />
<br />
<br />
=== Configurable email message priority ===<br />
Users receive tons of emails, and sometimes you need to attract their attention to some of them. Priority field can be used to flag some messages. It can be a static priority specified for email notification rule, or dynamically evaluated priority. For example, you can flag messages that are generated by incident with Severity 1 only. Since your email body is also customizable, you can add there details instructions for the recipient on what needs to be done when they received such email.<br />
<br />
<br />
=== Additional header information ===<br />
It might be required to include some information not just to message body, but also to the message envelope. For example, to inform the mail agent about character set used in the message, or specify particular message type, such as html, etc. <br />
It could be used for specifying reply-to address, references, or other special information.<br />
<br />
<br />
=== Notification conditions ===<br />
Notification condition filed provide you additional mechanism to customize message behavior. Along with fields, parameters and function, you can use logical comparison, arithmetic and other operators, as well as regular expressions patterns.<br />
<br />
<br />
=== Message sender and reply-to address ===<br />
You can send email using the current user email address in the “From:” field, select a dedicated email address that will be used for all emails generated in the database, or create from email address dynamically when email is triggered. It is flexible and can be used in many ways. For example, it can help you satisfying mail relaying policies in very restrictive environments. If necessary, you can configure different Reply-To address, that will be used when users try to reply to generated emails.<br />
<br />
<br />
=== Site-specific settings in Multisited environment ===<br />
If you use ClearQuest multisite, you might change some database settings based on the site where you are located. For example, to point your users to a site-specific SMTP relay. It is not a problem: the package allows you to create global, as well as site specific settings, to modify or unset global database properties on particular site.<br />
<br />
<br />
=== Password authentication with SMTP relay ===<br />
Optionally, you can configure password authentication with SMTP relay. Credentials used for notification can be saved as encrypted values in the database<br />
<br />
<br />
=== Reminders ===<br />
Another nice feature of the package that it allows you to configure reminders, such as notifications about approaching due date, or other important events. I called it [[Timed_Notification | Timed Notification]]. You can create a template using the same flexible email notification rules, and Timed Notification script will trigger them using dummy action.<br />
<br />
<br />
=== Email Notification Subscription ===<br />
You can allow users to manage there email notification rules subscription preferences. This functionality is delivered with optional '''EmailSubscription''' package. It can be used as-is, enhanced, or taken as an example to implement your own, more sophisticated end-user subscription solution. Please check [[ClearQuest_Email_Subscription | Email Subscription]] page for details.<br />
<br />
== Getting Started ==<br />
<br />
Would you like to try it? Then, '''create a backup of your schema and user database''', or (even better) create test environment with master and user databases. Many customers have been using the package for years, but it is always makes sense to test the package in your specific environment and check for conflicts with existing hooks, issues with particular database vendor and version, etc, and update production when you are sure that it would be safe to do it only.<br />
<br />
<br />
# [[Download | Download]] the package.<br />
# [[Package_installation | Install it]].<br />
# Create your [[EmailNotification_Creating_First_Notification_Rule | first notification rule]]<br />
<br />
<br />
== Additional Information ==<br />
# It could be useful to read [[Package_configuration | package configuration guide]] and<br />
# [[ClearQuest_Email_Notification_Package_FAQ | Frequently Asked Questions ]]<br />
# Please check [[Notification_Examples | Examples]] and<br />
# [http://cqadmin.org/data/CCMA43.pdf Extending IBM(R) Rational(R) ClearQuest(R) Email Notifications] presentation<br />
# [[Timed_Notification | Reminders / Timed Notifications]]<br />
# [[ClearQuest_Email_Subscription | End users self-subscription to email notifications]]<br />
# If you have questions or problems, welcome to the [http://forum.cqadmin.org/ support forum]<br />
<br />
<br />
== License == <br />
<br />
The ''ClearQuest Email Notification Package'' is licensed under the ''GNU Lesser General Public License'' (AKA, the "LGPL"), Version 2.1, February, 1999.<br />
<br />
<br />
== Support ==<br />
: ClearQuest Email Notification package is [http://store.cqadmin.com/index.php/clearquest/cq-email-notification/email-notification-package-support.html officially supported] by [http://cqadmin.com CQAdmin, inc]. Three levels or support agreement are currently offered, starting with '''free''' community support at [http://forum.cqadmin.org http://forum.cqadmin.org]. Consulting services are also available.<br />
<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=User_Admin_Tool&diff=257User Admin Tool2013-04-13T17:26:11Z<p>Paul: </p>
<hr />
<div><big>'''User Administration Tool for IBM-Rational ClearQuest'''</big> <!--[[File:R4_Rational.jpg|right|140px]]--><br />
<br />
== Overview ==<br />
IBM-Rational ClearQuest is one of the greatest tools available in the IBM portfolio. It became even more valuable with introduction of the enhanced ClearQuest Web interface. Having Web based user administrating tool was a dream of ClearQuest administrators for a long time.<br />
I would like to present a Web based user administration tool that was implemented on IBM-Rational ClearQuest platform and does not require ClearQuest installation on an administrator's desktop. It simplifies remote site management and adds other features that were missing in the standard User Administrator.<br />
<br />
== Ultimate Query and Search Capabilities ==<br />
The User Administration tool is based on ClearQuest and utilized its powerful query and search capabilities. Finding users or groups has never been easier. The basic search can be enhanced using full-text search engine.<br />
<br />
== Customizable Defaults ==<br />
The tool allows you to setup defaults for most of the User and Group record fields. For example, you can choose default authentication mechanism to be LDAP instead of ClearQuest, specify default list of User Privileges, Groups, and Database subscription to simplify your life and save your valuable time. Even new user password can be randomly generated when you use ClearQuest authentication. <br />
<br />
== Customizable Fields Validation ==<br />
In addition to defaults, the tool offers enhanced validation features, and there would be no need to change schema. Most of the conditions can be specified in the database on the fly. For instance, you can check that user email is specified as an Internet email address from your company domain; use advanced validation for login name, full name, phone, etc. <br />
<br />
== Managing Users Using Profiles and Templates ==<br />
Have you ever tried creating user account that has "the same rights" as another user account in the enterprise database containing thousands of users and hundreds of groups? In this case you will like this feature. Mirroring user or adding "somebody else" rights has never been easier. You need to specify other user, and the system will take care of the rest.<br />
Moreover, it allows to setup a set of template profiles or roles that can be used to expedite new users provisioning and guard you from mistakes. Setting up new "CM Manager" or "Project Admin" would take seconds. <br />
<br />
== Granular Access ==<br />
In addition to the ClearQuest defined user permissions, the tool allows you to define its own equivalents. If you set up the system this way, the tool user admins would have user administration access within the User Admin Tool, but they would not be able to run the same operations using the standard user admin utility. It prevents from mistakes and unnecessary synchronizations between the databases.<br /><br />
In addition, the tool allows you to setup group administrators, users, that are allowed to administer specific group(s) only. If you are using ClearQuest authentication, you can also safely delegate password reset rights to your first-tier helpdesk personal. <br />
<br />
== Reporting ==<br />
The system provides a set of out-of-the box reports. In just few clicks you can get printable list of active users, or find out user accounts or groups that were updated since yesterday. You can also use provided report formats to build your own reports. <br />
<br />
== Audit Trail ==<br />
One of the most important for account management features is audit capability. When you use User Administration Tool, you can always answer the following questions: who, when, and what. More advanced audit capabilities are based on [[ClearQuest_Email_Notification_Package | Email Notification package]], and can be turned on at any time, and in case if it is not enough, you can use Audit Trail package to enhance audit capabilities.<br />
<br />
== Email Notifications ==<br />
The system offers customizable and ultimately flexible notification rules based on [[ClearQuest_Email_Notification_Package | Email Notification package]] for IBM-Rational ClearQuest. Configurable email formats, recipients, and advanced conditions allows you to implement any possible notification scenario. <br />
<br />
== Additional Information==<br />
The following links could be useful<br />
* [[User_Admin_Tool_Installation | Installing User Administration Tool]]<br />
* [[User_Admin_Tool_Configuration | Configuring User Administration Tool]]<br />
* [[Managing_ClearQuest_Users | Managing ClearQuest Users]].<br />
* [[Download | Downloads]]<br />
* [http://forum.cqadmin.org/ Support forum]<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:User_Admin_Tool]]</div>Paulhttps://cqadmin.org/w/index.php?title=CQAdmin&diff=256CQAdmin2013-02-18T17:31:38Z<p>Paul: </p>
<hr />
<div><big>'''Rational Administrators'''</big><br />
<br />
This site was created to provide tools, information, and share experience that might be useful for Rational tools administrators. <br />
<br />
It is powered by [http://www.mediawiki.org MediaWiki] and opened for everyone. If you would like to contribute your materials, please feel free to do it.<br />
<br />
<br />
== Latest news ==<br />
* '''The [[User_Admin_Tool | User Administration Tool for IBM-Rational ClearQuest]] is "Ready for IBM-Rational Software"'''<br />
: The User Administration Tool was successfully validated to the requirements of <i style="color:blue;">Ready for IBM Rational Software</i>. It met the requirements for the IBM Software Delivery Platform level of the program.<br />
<br />
* '''The [[User_Admin_Tool | User Administration Tool for IBM-Rational ClearQuest]] has been released.'''<br />
: The tool is implemented on IBM-Rational ClearQuest platform and does not require ClearQuest installation on administrator's desktop. It simplifies site management and adds other valuable features, such as ultimate query and search capabilities, customizable defaults and validations, user profiling and templates, granular access, reporting and audit, email notifications and more.<br />
<br />
* '''Email Notification Package is "Ready for IBM-Rational Software"'''<br />
: Email Notification package was successfully validated to the requirements of <i style="color:blue;">Ready for IBM Rational Software</i>. The package met the requirements for the IBM Software Delivery Platform level of the program.<br />
<br />
* '''Commercial Support'''<br />
: ClearQuest Email Notification package is officially [http://store.cqadmin.com/index.php/clearquest/cq-email-notification/email-notification-package-support.html supported] by [http://cqadmin.com CQAdmin, inc]. Three levels or support are currently offered, starting with '''free''' community support at [http://forum.cqadmin.org http://forum.cqadmin.org]. Consulting services are also available.<br />
<br />
* '''IBM-Rational VoiCE 2011'''<br />
: ClearQuest Email Notification package was presented at IBM-Rational VoiCE 2011 conference in Reno, NV ([http://cqadmin.org/data/Reno_VoiCE-ClearQuest_Email.pdf presentation])<br />
<br /><br />
<br />
== Resources ==<br />
* [[ClearQuest_Email_Notification_Package | Email Notification Package]] for IBM-Rational ClearQuest. <br />
: If you would like to use flexible notification rules, reliable delivery, sending HTML emails with rich text, fonts, and colors, configuring reminders, and many other features, you might like the package.<br />
<br />
* [[User_Admin_Tool | User Administration Tool]] for IBM-Rational ClearQuest.<br />
: It simplifies site management and adds other valuable features, such as customizable defaults and validations, user profiling and templates, reporting and audit, email notifications and more. <br />
<br />
* [[ClearQuest_Dynamic_List_Editor | Dynamic List Editor]] for IBM-Rational ClearQuest. <br />
: Would you like to administer Dynamic Lists via the ClearQuest Web client? You might consider using the editor.<br />
<br />
* '''Support forum'''<br />
: Support forum is available now. Please do not hesitate to ask questions or share your experience.<br />
: [http://forum.cqadmin.org/ http://forum.cqadmin.org/]<br />
<br />
<br /><br /><br />
<br />
[[Category:Rational]]</div>Paulhttps://cqadmin.org/w/index.php?title=CQAdmin&diff=255CQAdmin2013-02-18T17:31:02Z<p>Paul: </p>
<hr />
<div><big>'''Rational Administrators'''</big><br />
<br />
This site was created to provide tools, information, and share experience that might be useful for Rational tools administrators. <br />
<br />
It is powered by [http://www.mediawiki.org MediaWiki] and opened for everyone. If you would like to contribute your materials, please feel free to do it.<br />
<br />
<br />
== Latest news ==<br />
* '''The [[User_Admin_Tool | User Administration Tool for IBM-Rational ClearQuest]] is "Ready for IBM-Rational Software"'''<br />
: The User Administration Tool was successfully validated to the requirements of <i style="color:blue;">Ready for IBM Rational software</i>. It met the requirements for the IBM Software Delivery Platform level of the program.<br />
<br />
* '''The [[User_Admin_Tool | User Administration Tool for IBM-Rational ClearQuest]] has been released.'''<br />
: The tool is implemented on IBM-Rational ClearQuest platform and does not require ClearQuest installation on administrator's desktop. It simplifies site management and adds other valuable features, such as ultimate query and search capabilities, customizable defaults and validations, user profiling and templates, granular access, reporting and audit, email notifications and more.<br />
<br />
* '''Email Notification Package is "Ready for IBM-Rational Software"'''<br />
: Email Notification package was successfully validated to the requirements of <i style="color:blue;">Ready for IBM Rational software</i>. The package met the requirements for the IBM Software Delivery Platform level of the program.<br />
<br />
* '''Commercial Support'''<br />
: ClearQuest Email Notification package is officially [http://store.cqadmin.com/index.php/clearquest/cq-email-notification/email-notification-package-support.html supported] by [http://cqadmin.com CQAdmin, inc]. Three levels or support are currently offered, starting with '''free''' community support at [http://forum.cqadmin.org http://forum.cqadmin.org]. Consulting services are also available.<br />
<br />
* '''IBM-Rational VoiCE 2011'''<br />
: ClearQuest Email Notification package was presented at IBM-Rational VoiCE 2011 conference in Reno, NV ([http://cqadmin.org/data/Reno_VoiCE-ClearQuest_Email.pdf presentation])<br />
<br /><br />
<br />
== Resources ==<br />
* [[ClearQuest_Email_Notification_Package | Email Notification Package]] for IBM-Rational ClearQuest. <br />
: If you would like to use flexible notification rules, reliable delivery, sending HTML emails with rich text, fonts, and colors, configuring reminders, and many other features, you might like the package.<br />
<br />
* [[User_Admin_Tool | User Administration Tool]] for IBM-Rational ClearQuest.<br />
: It simplifies site management and adds other valuable features, such as customizable defaults and validations, user profiling and templates, reporting and audit, email notifications and more. <br />
<br />
* [[ClearQuest_Dynamic_List_Editor | Dynamic List Editor]] for IBM-Rational ClearQuest. <br />
: Would you like to administer Dynamic Lists via the ClearQuest Web client? You might consider using the editor.<br />
<br />
* '''Support forum'''<br />
: Support forum is available now. Please do not hesitate to ask questions or share your experience.<br />
: [http://forum.cqadmin.org/ http://forum.cqadmin.org/]<br />
<br />
<br /><br /><br />
<br />
[[Category:Rational]]</div>Paulhttps://cqadmin.org/w/index.php?title=User_Admin_Tool&diff=254User Admin Tool2013-02-18T16:59:20Z<p>Paul: </p>
<hr />
<div><big>'''User Administration Tool for IBM-Rational ClearQuest'''</big> [[File:R4_Rational.jpg|right|140px]]<br />
<br />
== Overview ==<br />
IBM-Rational ClearQuest is one of the greatest tools available in the IBM portfolio. It became even more valuable with introduction of the enhanced ClearQuest Web interface. Having Web based user administrating tool was a dream of ClearQuest administrators for a long time.<br />
I would like to present a Web based user administration tool that was implemented on IBM-Rational ClearQuest platform and does not require ClearQuest installation on an administrator's desktop. It simplifies remote site management and adds other features that were missing in the standard User Administrator.<br />
<br />
== Ultimate Query and Search Capabilities ==<br />
The User Administration tool is based on ClearQuest and utilized its powerful query and search capabilities. Finding users or groups has never been easier. The basic search can be enhanced using full-text search engine.<br />
<br />
== Customizable Defaults ==<br />
The tool allows you to setup defaults for most of the User and Group record fields. For example, you can choose default authentication mechanism to be LDAP instead of ClearQuest, specify default list of User Privileges, Groups, and Database subscription to simplify your life and save your valuable time. Even new user password can be randomly generated when you use ClearQuest authentication. <br />
<br />
== Customizable Fields Validation ==<br />
In addition to defaults, the tool offers enhanced validation features, and there would be no need to change schema. Most of the conditions can be specified in the database on the fly. For instance, you can check that user email is specified as an Internet email address from your company domain; use advanced validation for login name, full name, phone, etc. <br />
<br />
== Managing Users Using Profiles and Templates ==<br />
Have you ever tried creating user account that has "the same rights" as another user account in the enterprise database containing thousands of users and hundreds of groups? In this case you will like this feature. Mirroring user or adding "somebody else" rights has never been easier. You need to specify other user, and the system will take care of the rest.<br />
Moreover, it allows to setup a set of template profiles or roles that can be used to expedite new users provisioning and guard you from mistakes. Setting up new "CM Manager" or "Project Admin" would take seconds. <br />
<br />
== Granular Access ==<br />
In addition to the ClearQuest defined user permissions, the tool allows you to define its own equivalents. If you set up the system this way, the tool user admins would have user administration access within the User Admin Tool, but they would not be able to run the same operations using the standard user admin utility. It prevents from mistakes and unnecessary synchronizations between the databases.<br /><br />
In addition, the tool allows you to setup group administrators, users, that are allowed to administer specific group(s) only. If you are using ClearQuest authentication, you can also safely delegate password reset rights to your first-tier helpdesk personal. <br />
<br />
== Reporting ==<br />
The system provides a set of out-of-the box reports. In just few clicks you can get printable list of active users, or find out user accounts or groups that were updated since yesterday. You can also use provided report formats to build your own reports. <br />
<br />
== Audit Trail ==<br />
One of the most important for account management features is audit capability. When you use User Administration Tool, you can always answer the following questions: who, when, and what. More advanced audit capabilities are based on [[ClearQuest_Email_Notification_Package | Email Notification package]], and can be turned on at any time, and in case if it is not enough, you can use Audit Trail package to enhance audit capabilities.<br />
<br />
== Email Notifications ==<br />
The system offers customizable and ultimately flexible notification rules based on [[ClearQuest_Email_Notification_Package | Email Notification package]] for IBM-Rational ClearQuest. Configurable email formats, recipients, and advanced conditions allows you to implement any possible notification scenario. <br />
<br />
== Additional Information==<br />
The following links could be useful<br />
* [[User_Admin_Tool_Installation | Installing User Administration Tool]]<br />
* [[User_Admin_Tool_Configuration | Configuring User Administration Tool]]<br />
* [[Managing_ClearQuest_Users | Managing ClearQuest Users]].<br />
* [[Download | Downloads]]<br />
* [http://forum.cqadmin.org/ Support forum]<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:User_Admin_Tool]]</div>Paulhttps://cqadmin.org/w/index.php?title=User_Admin_Tool&diff=253User Admin Tool2013-02-03T16:23:59Z<p>Paul: </p>
<hr />
<div><big>'''User Administration Tool for IBM-Rational ClearQuest'''</big><br />
<br />
== Overview ==<br />
IBM-Rational ClearQuest is one of the greatest tools available in the IBM portfolio. It became even more valuable with introduction of the enhanced ClearQuest Web interface. Having Web based user administrating tool was a dream of ClearQuest administrators for a long time.<br />
I would like to present a Web based user administration tool that was implemented on IBM-Rational ClearQuest platform and does not require ClearQuest installation on an administrator's desktop. It simplifies remote site management and adds other features that were missing in the standard User Administrator.<br />
<br />
== Ultimate Query and Search Capabilities ==<br />
The User Administration tool is based on ClearQuest and utilized its powerful query and search capabilities. Finding users or groups has never been easier. The basic search can be enhanced using full-text search engine.<br />
<br />
== Customizable Defaults ==<br />
The tool allows you to setup defaults for most of the User and Group record fields. For example, you can choose default authentication mechanism to be LDAP instead of ClearQuest, specify default list of User Privileges, Groups, and Database subscription to simplify your life and save your valuable time. Even new user password can be randomly generated when you use ClearQuest authentication. <br />
<br />
== Customizable Fields Validation ==<br />
In addition to defaults, the tool offers enhanced validation features, and there would be no need to change schema. Most of the conditions can be specified in the database on the fly. For instance, you can check that user email is specified as an Internet email address from your company domain; use advanced validation for login name, full name, phone, etc. <br />
<br />
== Managing Users Using Profiles and Templates ==<br />
Have you ever tried creating user account that has "the same rights" as another user account in the enterprise database containing thousands of users and hundreds of groups? In this case you will like this feature. Mirroring user or adding "somebody else" rights has never been easier. You need to specify other user, and the system will take care of the rest.<br />
Moreover, it allows to setup a set of template profiles or roles that can be used to expedite new users provisioning and guard you from mistakes. Setting up new "CM Manager" or "Project Admin" would take seconds. <br />
<br />
== Granular Access ==<br />
In addition to the ClearQuest defined user permissions, the tool allows you to define its own equivalents. If you set up the system this way, the tool user admins would have user administration access within the User Admin Tool, but they would not be able to run the same operations using the standard user admin utility. It prevents from mistakes and unnecessary synchronizations between the databases.<br /><br />
In addition, the tool allows you to setup group administrators, users, that are allowed to administer specific group(s) only. If you are using ClearQuest authentication, you can also safely delegate password reset rights to your first-tier helpdesk personal. <br />
<br />
== Reporting ==<br />
The system provides a set of out-of-the box reports. In just few clicks you can get printable list of active users, or find out user accounts or groups that were updated since yesterday. You can also use provided report formats to build your own reports. <br />
<br />
== Audit Trail ==<br />
One of the most important for account management features is audit capability. When you use User Administration Tool, you can always answer the following questions: who, when, and what. More advanced audit capabilities are based on [[ClearQuest_Email_Notification_Package | Email Notification package]], and can be turned on at any time, and in case if it is not enough, you can use Audit Trail package to enhance audit capabilities.<br />
<br />
== Email Notifications ==<br />
The system offers customizable and ultimately flexible notification rules based on [[ClearQuest_Email_Notification_Package | Email Notification package]] for IBM-Rational ClearQuest. Configurable email formats, recipients, and advanced conditions allows you to implement any possible notification scenario. <br />
<br />
== Additional Information==<br />
The following links could be useful<br />
* [[User_Admin_Tool_Installation | Installing User Administration Tool]]<br />
* [[User_Admin_Tool_Configuration | Configuring User Administration Tool]]<br />
* [[Managing_ClearQuest_Users | Managing ClearQuest Users]].<br />
* [[Download | Downloads]]<br />
* [http://forum.cqadmin.org/ Support forum]<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:User_Admin_Tool]]</div>Paulhttps://cqadmin.org/w/index.php?title=MediaWiki:Sidebar&diff=252MediaWiki:Sidebar2013-02-01T14:53:26Z<p>Paul: </p>
<hr />
<div>* navigation<br />
** mainpage|CQ Admin Home<br />
** ClearQuest_Email_Notification_Package | Email notification package<br />
** User_Admin_Tool | User Admin Tool<br />
** ClearQuest_Dynamic_List_Editor | Dynamic List Editor<br />
** Download | Downloads<br />
** http://forum.cqadmin.org | Forum<br />
** Category:Rational | Index<br />
* SEARCH<br />
* TOOLBOX<br />
* LANGUAGES</div>Paulhttps://cqadmin.org/w/index.php?title=MediaWiki:Sidebar&diff=251MediaWiki:Sidebar2013-02-01T14:52:50Z<p>Paul: </p>
<hr />
<div>* navigation<br />
** mainpage|CQ Admin Home<br />
** ClearQuest_Email_Notification_Package | Email notification package<br />
** User_Admin_Tool | User Admin Tool for ClearQuest<br />
** ClearQuest_Dynamic_List_Editor | Dynamic List Editor for ClearQuest<br />
** Download | Downloads<br />
** http://forum.cqadmin.org | Forum<br />
** Category:Rational | Index<br />
* SEARCH<br />
* TOOLBOX<br />
* LANGUAGES</div>Paulhttps://cqadmin.org/w/index.php?title=User_Admin_Tool&diff=250User Admin Tool2013-02-01T14:47:20Z<p>Paul: </p>
<hr />
<div><big>'''User Administration Tool for IBM-Rational ClearQuest'''</big><br />
<br />
== Overview ==<br />
IBM-Rational ClearQuest is one of the greatest tools available in the IBM portfolio. It became even more valuable with introduction of the enhanced ClearQuest Web interface. Having Web based user administrating tool was a dream of ClearQuest administrators for a long time.<br />
I would like to present a Web based user administration tool that was implemented on IBM-Rational ClearQuest platform and does not require ClearQuest installation on an administrator's desktop. It simplifies remote site management and adds other features that were missing in the standard User Administrator.<br />
<br />
== Ultimate Query and Search Capabilities ==<br />
The User Administration tool is based on ClearQuest and utilized its powerful query and search capabilities. Finding users or groups has never been easier. The basic search can be enhanced using full-text search engine.<br />
<br />
== Customizable Defaults ==<br />
The tool allows you to setup defaults for most of the User and Group record fields. For example, you can choose default authentication mechanism to be LDAP instead of ClearQuest, specify default list of User Privileges, Groups, and Database subscription to simplify your life and save your valuable time. Even new user password can be randomly generated when you use ClearQuest authentication. <br />
<br />
== Customizable Fields Validation ==<br />
In addition to defaults, the tool offers enhanced validation features, and there would be no need to change schema. Most of the conditions can be specified in the database on the fly. For instance, you can check that user email is specified as an Internet email address from your company domain; use advanced validation for login name, full name, phone, etc. <br />
<br />
== Managing Users Using Profiles and Templates ==<br />
Have you ever tried creating user account that has "the same rights" as another user account in the enterprise database containing thousands of users and hundreds of groups? In this case you will like this feature. Mirroring user or adding "somebody else" rights has never been easier. You need to specify other user, and the system will take care of the rest.<br />
Moreover, it allows to setup a set of template profiles or roles that can be used to expedite new users provisioning and guard you from mistakes. Setting up new "CM Manager" or "Project Admin" would take seconds. <br />
<br />
== Granular Access ==<br />
In addition to the ClearQuest defined user permissions, the tool allows you to define its own equivalents. If you set up the system this way, the tool user admins would have user administration access within the User Admin Tool, but they would not be able to run the same operations using the standard user admin utility. It prevents from mistakes and unnecessary synchronizations between the databases.<br /><br />
In addition, the tool allows you to setup group administrators, users, that are allowed to administer specific group(s) only. If you are using ClearQuest authentication, you can also safely delegate password reset rights to your first-tier helpdesk personal. <br />
<br />
== Reporting ==<br />
The system provides a set of out-of-the box reports. In just few clicks you can get printable list of active users, or find out user accounts or groups that were updated since yesterday. You can also use provided report formats to build your own reports. <br />
<br />
== Audit Trail ==<br />
One of the most important for account management features is audit capability. When you use User Administration Tool, you can always answer the following questions: who, when, and what. More advanced audit capabilities are based on [[ClearQuest_Email_Notification_Package | Email Notification package]], and can be turned on at any time, and in case if it is not enough, you can use Audit Trail package to enhance audit capabilities.<br />
<br />
== Email Notifications ==<br />
The system offers customizable and ultimately flexible notification rules based on [[ClearQuest_Email_Notification_Package | Email Notification package]] for IBM-Rational ClearQuest. Configurable email formats, recipients, and advanced conditions allows you to implement any possible notification scenario. <br />
<br />
== Additional Information==<br />
The following links could be useful<br />
* [[User_Admin_Tool_Installation | Installing User Administration Tool]]<br />
* [[User_Admin_Tool_Configuration | Configuring User Administration Tool]]<br />
* [[Managing_ClearQuest_Users | Managing ClearQuest Users]].<br />
* [[Download | Downloads]]<br />
* [http://forum.cqadmin.org/ Support forum]<br />
<br />
<br />
[[Category:Rational]] [[Category:User_Admin_Tool]]</div>Paulhttps://cqadmin.org/w/index.php?title=Package_configuration&diff=249Package configuration2013-02-01T14:47:02Z<p>Paul: </p>
<hr />
<div><big>'''Configuration guide'''</big><br />
<br />
__TOC__<br />
<br />
*The package is implemented in Perl and can be used with Perl-based as well as VBScript-based schemas. <br />
*The package does not require Perl modules deployment on clients; all code elements are stored in ClearQuest schema. <br />
*The packages use ClearQuest Security Context feature and require metaschema version 22 <br />
(ClearQuest repository that created with CQ 2001a and higher or upgraded to 2001A from previous releases).<br />
*The package works with ClearQuest clients 2001A, 2002, 2003, and v7 (as of 12/07/2008, 7.1 has not been tested yet). The following platforms are supported: Windows, old CQWeb (ASP-based version), CQWeb (Java Web), ClearQuest UNIX.<br />
<br />
<br />
= Installation =<br />
<br />
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 /><br />
EmailSubscription is an optional package delivering end-user self-subscription functionality.<br />
<br />
'''Note:''' Staring 1.4 release, the package can be installed on ClearQuest 7.0 Designer machine, but still can be used with older clients, if necessary.<br />
<br />
= Configuration =<br />
<br />
== Email Notification properties ==<br />
Email notification package properties are ClearQuest records of udb_property record type. Configure property usually means submitting record of that record type.<br />
<br />
The following properties can be configured for Email Notifications package:<br />
<br />
===email_host===<br />
It is your SMTP mail relay. If you need to specify non-default port, it can be done in ''host:port'' combination.<br />
<br />
Examples: ''mail.provider.net'', ''mail.provider.net:625''.<br />
<br />
===email_login (optional)===<br />
login name that is used for password authentication with SMTP relay. If you SMTP relay does not require password authentication, you do not need to use this property, and it shoul not exist.<br />
<br />
'''Note:''' If you would like, it can be a 'Secure' property.<br />
<br />
===email_password (optional)===<br />
password that is used for password authentication. If you SMTP relay does not require password authentication, you do not need this property, and it should not exist.<br />
<br />
'''Note:''' It is a good idea to use 'secure' property feature when storing it in a ClearQuest database.<br />
<br />
===email_address (optional)===<br />
Static "From:" email address for notification. Email address of current ClearQuest user is used if property does not exist.<br />
<br />
'''Note:''' This feature might be useful to bypass mail relaying restrictions: some SMTP relays may restrict mail relaying based on FROM email address. In case of password authentication, it might be also critical: FROM email address could be restricted to email address of the account used for authentication. Ask your SMTP relay admin for additional information.<br />
<br />
===email_reply_to (optional)===<br />
Static Reply-To address, if different from email_address can be specified. For example, you can configure mail replies to be sent to some distribution list.<br />
<br />
===email_enabled===<br />
It is the second mandatory property (besides email_host). It has to be set to '1' to enable email notification for user database. By setting it to '''0''' (or by deleting property), you can disable email notification on entire ClearQuest database<br />
<br />
===EN_DeliveryMode (optional)===<br />
The following delivery modes are available. Please check [[ClearQuest_Email_Notification_Package_Delivery_Mode | Email Notification delivery mode]] page for details.<br />
{| style="width: 60%; height: 88px; text-align: left" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top; width: 10%" | '''Light'''<br />
| style="vertical-align: top; width: 60%" | deliver notifications "on the fly" and log only error messages for re-delivery,<br />
|-<br />
| style="vertical-align: top; width: 10%" | '''Deferred'''<br />
| style="vertical-align: top; width: 60%" | (default) save all messages before attempting delivery, and deliver them in the same notification hook<br />
|-<br />
| style="vertical-align: top; width: 10%" | '''Queue'''<br />
| style="vertical-align: top; width: 60%" | save all messages in the message queue, and do not attempt to deliver them. Delivery will be done by a separate script running by scheduler on the server. You can find simple delivery script on [[Download]] page.<br />
|}<br />
<br />
<br />
===EN_DeliveryTimeout (optional)===<br />
Delivery timeout interval in seconds. If message in the message queue was not delivered it will be re-delivered (by other user, for example) after that.<br />
:Default value: 300 (5 minutes)<br />
<br />
===EN_DeliveryAttempt (optional)===<br />
Maximum number of delivery attempts performed for a message in the queue.<br />
:Default value: 5<br />
<br />
===EN_DeliveryScript (script only)===<br />
Should never be set in a ClearQuest database. To be used in Delivery script only.<br />
<br />
===EN_AdminGroup===<br />
Email administrators group. It is used in en_email_message action access control hooks If it is not set, only user with superuser can modify or delete email messages in the queue.<br />
<br />
===Debug (optional)===<br />
Debug level 1-9. Setting this property forces script to trace execution. Output could be captured by using dbwin32.exe utility<br />
:Default value: NONE<br />
<br />
===Notification_Default_Security_Group (optional)===<br />
Default visibility value. Existing udb_visibility record name that is used as a security context default value in Email_Notification_Rule submit action.<br />
<br />
===EN_Disable_Variable_Name_Validation (optional)===<br />
By default syntax of all parameterized fields and variable names are validated. You can turn off variable names check by setting this property to non-zero value.<br />
<br />
<br />
==Notification Rules==<br />
<br />
To create notification rule, Submit new Email_Notification_Rule record.<br />
Here are some important fields of this record type<br />
<br />
{| style="width: 80%; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top; width: 15%" | '''Name'''<br />
| style="vertical-align: top" | any unique name<br />
|-<br />
| style="vertical-align: top; width: 15%" | '''Record_Type'''<br />
| style="vertical-align: top" | desirable record type for which notification package is applied<br />
|-<br />
| style="vertical-align: top; width: 15%" | '''Order'''<br />
| style="vertical-align: top" | Notification Rules evaluation order, SHORT_STRING(10). The rules are sorted in ascending order.<br />
|-<br />
| style="vertical-align: top; width: 15%" | '''Actions'''<br />
| style="vertical-align: top" | notification can be restricted for set of actions. Notification is Triggered for any action if empty<br />
|-<br />
| style="vertical-align: top; width: 15%" | '''Field Change'''<br />
| style="vertical-align: top" | notification can be triggered by filed change. <br /> Triggered regardless any of fields change if empty. <br /> Fields changed in Action or Field initialization hooks are not counted.<br />
|-<br />
| style="vertical-align: top; width: 15%" | '''Condition'''<br />
| style="vertical-align: top" | Notification condition. Notification is triggered if notification condition evaluation result is TRUE. See section expression field syntax for reference. Assumed "TRUE" when the field is empty.<br />
|-<br />
| style="vertical-align: top" | '''Priority'''<br />
| style="vertical-align: top" | Message priority patameterized field, expression can be used. See expression field syntax section for reference. <br />
if evaluation result<br />
* < 0, message priority is Low.<br />
* == 0, message priority is Normal<br />
* > 0, message priority is High<br />
<br /> Condition result is assumed 0 when the field is empty ('Normal' priority).<br />
|-<br />
| style="vertical-align: top; width: 15%" | '''From'''<br />
| style="vertical-align: top" | "From:" addresses (parameterized). see parameter fields section for syntax reference. <br />
<br />
# when Notification Rule From field is not empty, it is expanded and used as from address on generated email<br />
# when From field is empty, and '''email_from''' database property exists, email_from content is evaluated to be used as from address<br />
# otherwise, email address of the user executing action triggering email is used as from email address<br />
<br />
<br /> One email address is expected as evaluation result.<br />
|-<br />
| style="vertical-align: top; width: 15%" | '''To'''<br />
| style="vertical-align: top" | "TO:" addresses (parameterized). see parameter fields section for syntax reference.<br />
<br />
<br /> One email address per line is expected as evaluation result.<br />
|-<br />
| style="vertical-align: top; width: 15%" | '''CC'''<br />
| style="vertical-align: top" | "CC:" addresses (parameterized). One email address per line is expected as evaluation result.<br />
|-<br />
| style="vertical-align: top" | '''BCC'''<br />
| style="vertical-align: top" | "BCC:" addresses (parameterized).<br /> One email address per line is expected as evaluation result.<br /><br />
|-<br />
| style="vertical-align: top" | '''Header Add-in'''<br />
| 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)<br />
|-<br />
| style="vertical-align: top; width: 15%" | '''Subject'''<br />
| style="vertical-align: top" | Subject - parameterized field. Can be multiline, converted to single line and included into the message header after evaluation.<br />
|-<br />
| style="vertical-align: top; width: 15%" | '''Body'''<br />
| style="vertical-align: top" | message body (parameterized).<br />
|-<br />
| style="vertical-align: top; width: 15%" | '''Active'''<br />
| style="vertical-align: top" | Notification rule can be deactivated by clearing "active" flag.<br />
|}<br />
<br />
<br />
'''Notes'''<br />
*Notification is triggered only if Action AND Field restrictions are satisfied AND Condition is true AND any of message recipients ("To:", "CC:", or "BCC") fields are not empty after evaluation. <br />
*You can create site specific properties in multisited environment as <SiteName>PropertyName. If you would like to disable a global property on specific site, you could do it by setting <SiteName>PropertyName value to "EN_NONE".<br />
<br />
=Parameterized Text and Condition fields Syntax=<br />
<br />
==Parameterized Text fields==<br />
Text field can contain plain text, variables that are expanded during rule evaluation, SQL statements, user-defined, pre-defined and Perl build-in functions.<br />
<br />
Any character in the field can be escaped with '''\''';<br />
<br />
===Variables===<br />
<br />
====Variable Syntax====<br />
<br />
{| style="width: 60%; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top; width: 20%" | '''${var_name}'''<br />
| style="vertical-align: top" | or<br />
|-<br />
| style="vertical-align: top; width: 20%" | '''$var_name'''<br />
| style="vertical-align: top" | <br />
|}<br />
<br />
Variables are evaluated (expanded) in the following order:<br />
* Check if property with the same name defined in CQ database and return value<br />
* Check predefined variable names and return value.<br />
* Check record field with the same name. <br /> (you can use dot, '''.''', in the name for reference field data type - $name1.name2.name3) <br /><br />
<br />
====Predefined variable names====<br />
<br />
{| style="width: 60%; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top; width: 20%" | '''$Action'''<br />
| style="vertical-align: top" | current action name<br />
|-<br />
| style="vertical-align: top; width: 20%" | '''$EntityDefName'''<br />
| style="vertical-align: top" | current entity definition.<br />
|-<br />
| style="vertical-align: top" | '''$SiteName'''<br />
| style="vertical-align: top" | Site name in multisited environment<br />
|-<br />
| style="vertical-align: top" | '''$UserLoginName'''<br />
| style="vertical-align: top" | Login name of user triggering email notification rule<br />
|-<br />
| style="vertical-align: top" | '''$EmailNotificationRuleName'''<br />
| style="vertical-align: top" | Email Rule name that is currently evaluated<br />
|}<br />
<br />
====Examples:====<br />
{| style="width: 60%; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top; width: 20%" | <source lang="perl">$State</source><br />
| style="vertical-align: top" | state field value<br />
|-<br />
| style="vertical-align: top; width: 20%" | <source lang="perl">$owner.email</source><br />
| style="vertical-align: top" | owner's email (REFERENCE field data type)<br />
|-<br />
| style="vertical-align: top; width: 20%" | <source lang="perl">${Property_Name}</source><br />
| style="vertical-align: top" | value of database property "Property_Name" (udb_property record)<br />
|}<br />
<br />
'''Notes:''' <br />
* Property names and Build-in Environment variables are case sensitive, while Field names are case insensitive!<br />
* Date_Time variables: format that is used for Date_Time variable type inside ClearQuest hooks is '''yyyy-mm-dd hh:mm:ss'''. <br /><br />
<br />
===SQL statements===<br />
SQL statement that will be passed to the backend database when variable is expanded.<br />
<br />
{| style="width: 60%; height: 60px; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top; width: 20%" | '''SQL(<statement>)'''<br />
| style="vertical-align: top" | SQL execution function<br /><br />
|}<br />
<br />
<br />
*Statement could be Double-Quoted string with variables, functions and SQL statements, single-quoted non-expandable string, or result of function that returns scalar value. *Statement string (SQL function parameter) is not limited to single line.<br />
*Statement is executed in run-time using BuildSQLQuery API call and inherited all restrictions related to the API call. Please check ClearQuest API documentation. <br />
<br />
'''Examples:'''<br />
* Get owner's email (the same result as $owner.email) <br /><br />
SQL("<br />
<source lang="sql"><br />
SELECT T1.email <br />
FROM users <br />
WHERE T1.login_name = '$owner'<br />
</source><br />
")<br /><br />
<br />
* Notify 'CHCD_Approvers' ClearQuest group members <br /><br />
SQL("<br />
<source lang="sql"><br />
SELECT T2.email <br />
FROM parent_child_links T1, groups T3, users T2<br />
WHERE T1.parent_dbid = T2.dbid<br />
AND T1.child_dbid = T3.dbid <br />
AND T3.name = 'CHCD_Approvers'<br />
AND T2.is_active = 1<br />
</source> ")<br /><br />
<br />
* Here is a little bit more complicated scenario: assume that we use AssignmentGroups stateless record type at our site. It has the following fields: <br />
{| style="width: 60%; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top; width: 15%" | '''Name '''<br />
| style="vertical-align: top; width: 25%" | SHORT_STRING<br /><br />
| style="vertical-align: top" | Unique group name<br />
|-<br />
| style="vertical-align: top; width: 15%" | '''Managers<br />'''<br />
| style="vertical-align: top; width: 25%" | REFERENCE to users<br /><br />
| style="vertical-align: top" | group managers<br />
|-<br />
| style="vertical-align: top; width: 15%" | '''Users<br />'''<br />
| style="vertical-align: top; width: 25%" | REFERENCE to users<br />
| style="vertical-align: top" | group members<br />
|-<br />
| style="vertical-align: top; width: 15%" | '''Active'''<br />
| style="vertical-align: top; width: 25%" | INT<br /><br />
| style="vertical-align: top" | obsolete groups marked as ‘0’, valid groups as ‘1’<br />
|}<br />
<br /> "Request" record type has AssignedToGroup field (reference to "AssignmentGroups"). <br /> Request assigned to a Group first, then the Group Manager will assign it to somebody in the team. <br /> If we would like to notify the Group Managers about new request that has been assigned to the Team, <br /> we could set Email Notification Rule's "To:" field to the following value: <br /><br />
SQL("<br />
<source lang="sql"><br />
SELECT T3.email<br />
FROM parent_child_links T1, fielddef T2, users T3, assignmentgroups T4<br />
WHERE T1.parent_dbid = T4.dbid<br />
AND T1.child_dbid = T3.dbid<br />
AND T1.parent_fielddef_id = T2.id<br />
AND T2.name = 'Managers'<br />
AND T4.name = '${AssignedToGroup}' <br />
</source> ")''<br /><br />
<br />
<br />
<br />
===Functions===<br />
'''function_name(parameter [, paramater1 …])'''<br /> <br />
Function name is a name of build-in, pre-defined or user-defined function. Spaces between function name and '''(''' symbol are not allowed. <br /> <br />
<br />
Parameter list is a comma-separated list of:<br /><br />
* variables,<br />
* functions or SQL queries,<br />
* single-quoted strings,<br />
* double quoted strings with variables, functions, etc.<br />
* expressions<br />
* numeric constants<br />
<br />
Scalar value expected as function's return value.<br />
<br />
====Function name lookup order====<br />
* check a database property with the same name. <br />
** If found, property value assumed to be a valid Perl-syntax code, that will be executed as function. <br />
** Function parameters are passed as "@_" array to the function. <br />
** $entity global variable available in function. <br /> Return value becomes function result.<br />
* check predefined functions<br />
* function name is assumed to be a Perl function.<br />
<br />
<br />
'''Examples:'''<br />
* Limit Subject line to 100 characters (Perl buld-in function "substr" is used):<br />
<source lang="perl"><br />
substr( "some subject line with $parameters", 0, 100)<br />
</source><br />
<br />
<br />
<br />
* Condition function:<br /><br />
<source lang="perl"><br />
IF($attempt > 0, 1, -1 )<br />
</source><br />
<br />
<br />
<br />
* Check whether "Description" field was updated during action and trigger a notification (an alternative way)<br />
<br />
:Notification Rule Condition filed:<br />
<source lang="perl"><br />
IsFieldUpdatedThisAction('Description') != 0<br />
</source> <br />
<br />
<br />
:Property "IsFieldUpdatedThisAction" contains the following code:<br />
<source lang="perl"><br />
my ($name) = @_;<br />
my $result = 0 ;<br />
eval {<br />
my $fields = $entity->GetFieldsUpdatedThisAction(); <br />
$result = 1 if defined( $fields->ItemByName($name) );<br />
};<br />
$@ = '';<br />
return $result;<br />
</source><br />
<br />
<br />
<br />
* Use original value of "Description" field in the mail body<br />
<br />
:Email Notification Rule "Msg_Body" field: <br /><br />
Original Description: <br />
"RT_GetFieldOriginalValue('Description')" <br />
was changed to: <br />
"$Description" <br />
<br />
:Property "RT_GetFieldOriginalValue" contains the following code:<br />
<source lang="perl"><br />
my ($name) = @_;<br />
my $value = '';<br />
<br />
eval {<br />
$value = $entity->GetFieldOriginalValue($name)->GetValue();<br />
};<br />
$@ = '';<br />
return $value;<br />
</source><br />
<br />
<br />
<br />
'''Note:''' variables of CQPerlExt module in user defined functions scope can cause 'false' execution errors, because CQPerlExt objects usually do not clear $@ variable on destruction. It would be safer to destroy private objects references before leaving the function and clean $@ variable to avoid the problem, for example: <br />
<source lang="perl"><br />
my $session = $entity->GetSession();<br />
# ... <some code> <br />
<br />
$session = undef;<br />
$@ = '';<br />
return $return_value;<br />
</source><br />
<br />
===Double-quoted string===<br />
Variables, functions, SQL statements are expanded within double-quoted strings. <br /> Escape symbols are: "\n", "\r","\t", "\f", "\b", "\a" <br /> "\" symbol by the end of new lines will escape new line symbol, i.e. <br /> "\" in front of any other symbol escapes that symbol, i.e. \$, \", etc<br />
"aaa\ <br />
bbb" <br />
is equal to <br />
"aaa bbb"''<br />
<br />
<br />
'''Examples:'''<br />
<source lang="text"><br />
"some string here with $variable and function f1($par1, $SQL{'Statement'}, 'string') and others"<br />
</source><br />
<br /><br />
<br />
===Single-quoted strings===<br />
Single quoted strings are not expanded. Escape symbols are \\ and \'. <br /><br /><br />
<br />
==Conditions==<br />
Conditions are implemented in perl-like style (please check Perl manual for detailed syntax documentation).<br /> They can contain variable, single- and double-quoted strings, function and other elements described in previous section. <br /> You can group expressions with brackets ( ). <br /><br />
<br />
<br /><br />
<br />
==='''Operators''' (in priority order)===<br />
<br />
{| style="width: 60%; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
! style="vertical-align: top; width: 30%; text-align: center" | Operator<br />
! style="vertical-align: top" | Comments<br />
|-<br />
| style="vertical-align: top; width: 30%; text-align: center" | '''<nowiki>!, ~, +, -</nowiki>'''<br />
| style="vertical-align: top" | Unary operators<br /><br />
|-<br />
| style="vertical-align: top; width: 30%; text-align: center" | '''<nowiki>=~, !~</nowiki>'''<br />
| style="vertical-align: top" | regular expression at the right side can include modifiers (/m/i/…/)<br />
|-<br />
| style="vertical-align: top" | '''<nowiki>*, /, %, x </nowiki>'''<br /><br />
| style="vertical-align: top" | mult, div, ... <br /><br />
|-<br />
| style="vertical-align: top" | '''+, -, .'''<br /><br />
| style="vertical-align: top" | plus, minus, string concatenation<br /><br />
|-<br />
| style="vertical-align: top; width: 30%; text-align: center" | '''gt, ge, lt, le, >, >=, <, <='''<br />
| style="vertical-align: top" | String and numeric comparison<br />
|-<br />
| style="vertical-align: top; width: 30%; text-align: center" | '''eq, ne, cmp, != , ==, <=>'''<br /><br />
| style="vertical-align: top" | String and numeric comparison<br />
|-<br />
| style="vertical-align: top; width: 30%; text-align: center" | '''&&'''<br /><br />
| style="vertical-align: top" | Logical AND<br />
|-<br />
| style="vertical-align: top; width: 30%; text-align: center" | '''<nowiki>||</nowiki>'''<br /><br />
| style="vertical-align: top" | Logical OR<br />
|}<br />
<br />
'''Note:''' it has to be a space between '/' operator and operand.<br /><br />
<br />
'''Examples:'''<br /><br />
<source lang="perl"><br />
($field =~ /something/i) && ($another_field > function($param1, $param2) || $another_value)<br />
</source><br />
<br /><br /><br />
<br />
==Build-in (Predefined) Functions==<br />
<br />
===IF( <expression>, <val1>, <val2) )===<br />
'''Parameters:'''<br />
{| style="width: 60%; height: 60px; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top; width: 30%" | '''<expression> '''<br />
| style="vertical-align: top; width: 80%" | logical expression<br /><br />
|-<br />
| style="vertical-align: top" | '''<val1>'''<br /><br />
| style="vertical-align: top" | parameter returned if expression is true<br /><br />
|-<br />
| style="vertical-align: top" | '''<val2>'''<br /><br />
| style="vertical-align: top" | parameter returned if expression is false<br /><br />
|}<br />
<br />
'''Returns:'''<br /> <br />
<val1> or <val2> depending on expression result.<br /><br /><br />
<br />
'''Examples:'''<br />
<source lang="perl"><br />
IF( $owner.email ne '' , $owner.email, 'administrator@email-address.net' )<br />
</source><br />
<br /><br />
<br />
===GetFieldOriginalValue(<fieldname>)===<br />
'''Parameters:'''<br />
{| style="width: 60%; height: 60px; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top; width: 30%" | '''<fieldname>'''<br />
| style="vertical-align: top; width: 80%" | ClearQuest field name <br />
|}<br />
<br />
'''Returns:'''<br /> <br />
ClearQuest field original value.<br /><br /><br />
<br />
'''Examples:'''<br />
<source lang="perl"><br />
IF( GetFieldOriginalValue('owner') ne $owner, GetFieldOriginalValue('owner.email'), $owner.email )<br />
</source><br />
<br /><br />
<br />
<br />
===GetGroupEmailAddresses(<group> [, <group2> [, ... ]])===<br />
'''Parameters:'''<br />
{| style="width: 60%; height: 60px; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top; width: 30%" | '''<group>'''<br />
| style="vertical-align: top; width: 80%" | ClearQuest groups list <br />
|}<br />
<br />
'''Returns:'''<br /> <br />
ClearQuest field original value.<br /><br /><br />
<br />
'''Examples:'''<br />
<source lang="perl"><br />
GetGroupEmailAddresses( 'Admins', 'Engineering' )<br />
</source><br />
<br /><br />
<br />
===GetDateTime( [ <offset> ] )===<br />
'''Parameters:'''<br />
{| style="width: 60%; height: 60px; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top; width: 30%" | '''<offset> '''<br />
| style="vertical-align: top; width: 80%" | offset from current date/time in the following format:<br />
|}<br />
<br />
<br />
General offset format: [+-]?[\d+][smhd]? <br /><br /><br />
{| style="width: 60%; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top; width: 30%" | none or ‘now’<br />
| style="vertical-align: top" | offset = 0<br />
|-<br />
| style="vertical-align: top; width: 30%" | +1<br /><br />
| style="vertical-align: top" | + 1 second<br /><br />
|-<br />
| style="vertical-align: top; width: 30%" | '+5s'<br /><br />
| style="vertical-align: top" | + 5 seconds<br /><br />
|-<br />
| style="vertical-align: top; width: 30%" | '-2m'<br /><br />
| style="vertical-align: top" | - 2 minutes<br /><br />
|-<br />
| style="vertical-align: top; width: 30%" | '+10h'<br /><br />
| style="vertical-align: top" | + 10 hours<br /><br />
|-<br />
| style="vertical-align: top; width: 30%" | '3d'<br /><br />
| style="vertical-align: top" | + 3 days<br /><br />
|}<br />
<br />
'''Returns:'''<br /> <br />
Current date/time plus offset as date_time string in 'yyyy-mm-dd hh:mm:ss' format<br />
<br />
'''Examples:'''<br />
{| style="width: 60%; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top; width: 20%" width="40%" | <source lang="perl">GetDateTime()</source><br />
| style="vertical-align: top" width="60%" | now<br />
|-<br />
| style="vertical-align: top; width: 20%" width="40%" | <source lang="perl">GetDateTime('-1d')</source><br />
| style="vertical-align: top" width="60%" | yesterday<br />
|-<br />
| style="vertical-align: top; width: 20%" width="40%" | <source lang="perl">GetDateTime( -300 )</source><br />
| style="vertical-align: top" width="60%" | five minutes before<br />
|}<br />
<br /><br />
<br />
===DateTimePlusOffset( <date_time> [, <offset> ] )===<br />
'''Parameters: '''<br />
{| style="width: 60%; height: 60px; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top" | '''<date_time>'''<br />
| style="vertical-align: top" | string in ''yyyy-mm-dd [hh:mm:ss]'' format<br />
|-<br />
| style="vertical-align: top; width: 30%" | '''<offset> '''<br />
| style="vertical-align: top; width: 80%" | offset from <date_time> in [+-]?[\d+][smhd]? format<br />
|}<br />
<br />
'''Returns:'''<br /> <br />
Given date plus offset as a date_time string in 'yyyy-mm-dd hh:mm:ss' format <br /><br /><br />
<br />
'''Examples:'''<br />
<source lang="perl">DateTimePlusOffset('2000-10-01 00:01:30', '+30m')</source><br />
Returns: ''2000-10-02 00:31:30'' <br /><br /><br />
<source lang="perl">DateTimePlusOffset( $Eneter_Date, '3d' )</source><br />
<br />
Returns: value of 'Enter_Date' field + 3 days.<br /><br />
<br />
===GetDateTimeFromTimestamp( <timestamp>)===<br />
'''Parameters:'''<br /><br />
{| style="width: 60%; height: 60px; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top; width: 30%" | '''<timestamp> '''<br />
| style="vertical-align: top; width: 80%" | long number of seconds since 01/01/1970 (result of time() function)<br />
|}<br />
<br />
Converts timestamp to local date/time.<br />
<br />
'''Returns:'''<br /> string in ''yyyy-mm-dd hh:mm:ss'' format<br />
<br />
'''Example:'''<br />
<source lang="perl">GateDateTimeFromTimestamp(time())</source><br />
Returns current date <br /><br />
<br />
===DateTimeToDate( <date_time> )===<br />
'''Parameters:'''<br /><br />
{| style="width: 60%; height: 60px; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top" | '''<date_time>'''<br />
| style="vertical-align: top" | string in ‘yyyy-mm-dd [hh:mm:ss]’ format<br />
|}<br />
<br />
Converts date/time string to date only string. <br /><br />
<br />
'''Returns:'''<br /> <br />
Date String in ''yyyy-mm-dd'' format. <br /><br />
<br />
<br />
===GetDate( [ <offset> ] )===<br />
'''Parameters: '''<br />
{| style="width: 60%; height: 60px; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top; width: 30%" | '''<offset> '''<br />
| style="vertical-align: top; width: 80%" | offset from current date/time in the following format:<br />
|}<br />
<br />
General offset format: [+-]?[\d+][smhd]? <br /><br /><br />
<br />
{| style="width: 60%; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top; width: 30%" | none or ''now''<br />
| style="vertical-align: top" | offset = 0<br />
|-<br />
| style="vertical-align: top; width: 30%" | +1<br /><br />
| style="vertical-align: top" | + 1 second<br /><br />
|-<br />
| style="vertical-align: top; width: 30%" | '+5s'<br /><br />
| style="vertical-align: top" | + 5 seconds<br /><br />
|-<br />
| style="vertical-align: top; width: 30%" | '-2m'<br /><br />
| style="vertical-align: top" | - 2 minutes<br /><br />
|-<br />
| style="vertical-align: top; width: 30%" | '+10h'<br /><br />
| style="vertical-align: top" | + 10 hours<br /><br />
|-<br />
| style="vertical-align: top; width: 30%" | '3d'<br /><br />
| style="vertical-align: top" | + 3 days<br /><br />
|}<br />
<br />
<br />
'''Returns:'''<br /> <br />
Current date/time plus <offset> as a date strings in ''yyyy-mm-dd'' format<br />
<br />
<br />
'''Examples:'''<br />
{| style="width: 60%; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top; width: 30%" | <source lang="perl">GetDate()</source><br />
| style="vertical-align: top" | today<br />
|-<br />
| style="vertical-align: top; width: 30%" | <source lang="perl">GetDate('-1d')</source><br />
| style="vertical-align: top" | yesterday<br />
|-<br />
| style="vertical-align: top; width: 30%" | <source lang="perl">GetDate('+1d' )</source><br />
| style="vertical-align: top" | tomorrow<br />
|}<br />
<br /><br />
<br />
===DateTimeDiff( <date_time1>, <date_time2> [ , <modifier>])===<br />
'''Parameters: '''<br />
{| style="width: 60%; height: 60px; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
| style="vertical-align: top" | '''<date_time1>'''<br />
| style="vertical-align: top" | string in ‘yyyy-mm-dd [hh:mm:ss]’ format<br />
|-<br />
| style="vertical-align: top" | '''<date_time2>'''<br />
| style="vertical-align: top" | string in ‘yyyy-mm-dd [hh:mm:ss]’ format<br />
|-<br />
| style="vertical-align: top; width: 30%" | '''<modifier>'''<br />
| style="vertical-align: top; width: 80%" | none/’s’/’m’/’h’/’d’<br />
|}<br />
<br />
Modifier changes returned result from difference in seconds, when it is ''s'' or absent, to minutes (''m''), hours (''h'') or days (''d'').<br />
{| style="width: 60%; text-align: left" border="1" cellspacing="2" cellpadding="5"<br />
! style="vertical-align: top; width: 30%; text-align: center" | Modifier<br /><br />
! style="vertical-align: top" | result in<br />
|-<br />
| style="vertical-align: top; width: 30%; text-align: center" | undef<br /><br />
| style="vertical-align: top" | seconds<br /><br />
|-<br />
| style="vertical-align: top; width: 30%; text-align: center" | 's'<br /><br />
| style="vertical-align: top" | seconds<br /><br />
|-<br />
| style="vertical-align: top; width: 30%; text-align: center" | 'm'<br /><br />
| style="vertical-align: top" | minutes<br /><br />
|-<br />
| style="vertical-align: top; width: 30%; text-align: center" | 'h'<br />
| style="vertical-align: top" | hours<br /><br />
|-<br />
| style="vertical-align: top; width: 30%; text-align: center" | 'd'<br />
| style="vertical-align: top" | days<br /><br />
|}<br />
<br />
'''Returns:'''<br /><br />
(<date_time1> - <date_time2>) in seconds or other metrics, according to modifier:<br />
<br />
<br />
'''Example:'''<br />
<source lang="perl">DateTimeDiff( $action_date, GetDateTime(), 'd')</source><br />
Returns a difference between $action_date field and current date/time in days.<br /><br /><br />
<br />
<br />
= Access control =<br />
'''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.<br />
<br />
{| border="1" width="100%" align="center"<br />
! Record Type<br />
! Action<br />
! Permissions<br />
|-<br />
|rowspan="3"|'''udb_visibility'''<br />
| Submit<br />
| <br />
* Superuser<br />
|-<br />
| Update<br />
| <br />
* Superuser<br />
* Security Administrator<br />
* Security context group member<br />
|-<br />
| Remove<br />
|<br />
* Superuser<br />
|-<br />
<br />
|rowspan="3"|'''udb_property'''<br />
| Submit<br />
| <br />
* Superuser<br />
* Security Administrator<br />
* Default Security context group member<br />
: (set by PropertyDefaultSecurityGroup database property)<br />
|-<br />
| Update<br />
| <br />
* Superuser<br />
* Security Administrator<br />
* Security context group member<br />
|-<br />
| Remove<br />
|<br />
* Superuser<br />
|-<br />
|rowspan="3"|'''Email_Notification_Rule'''<br />
| Submit<br />
| <br />
* Superuser<br />
* Security Administrator<br />
* Default Security context group member<br />
: (set by NotificationDefaultSecurityGroup database property)<br />
|-<br />
| Update<br />
| <br />
* Superuser<br />
* Security Administrator<br />
* Security context group member<br />
|-<br />
| Remove<br />
|<br />
* Superuser<br />
|-<br />
|rowspan="3"|'''en_email_message'''<br />
| Submit<br />
| <br />
* Superuser<br />
* A member of group specified by EN_AdminGroup database property<br />
|-<br />
| Update<br />
| <br />
* Superuser<br />
* A member of group specified by EN_AdminGroup database property<br />
|-<br />
| Remove<br />
|<br />
* Superuser<br />
* A member of group specified by EN_AdminGroup database property<br />
|-<br />
|rowspan="5"|'''Email_Subscription'''<br />
| Submit<br />
| <br />
* Superuser<br />
* Security Administrator<br />
* Default Security context group member<br />
: (set by NotificationDefaultSecurityGroup database property)<br />
|-<br />
| Update<br />
| <br />
* Superuser<br />
* Security Administrator<br />
* Security context group member<br />
|-<br />
| Remove<br />
|<br />
* Superuser<br />
|-<br />
| Subscribe_Me<br />
| <br />
* All users<br />
|-<br />
| Unsubscribe_Me<br />
| <br />
* All users<br />
|}<br />
<BR /><br />
Submit action can be enabled for all users by setting '''Notification_Bypass_Access_Control''' database property.<br />
<BR /><br />
<br />
<br />
<br />
= Examples =<br />
Additional examples can be found on [[Notification_Examples | Examples]] page.<br />
<br />
<br />
[[Category:Rational]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=Email_Notification_1.4_Release_Notes&diff=248Email Notification 1.4 Release Notes2013-02-01T14:46:41Z<p>Paul: </p>
<hr />
<div><big>'''Email Notification Package 1.4'''</big><br />
<big>'''Release Notes'''</big><br />
<br />
<br />
== Bug Fixed ==<br />
<br />
=== SMTP Header Line Length Limit ===<br />
A workaround was implemented preventing address lines with multiple recipients exceeding 1000 characters. It could break SMTP header in previous version.<br />
<br />
<br />
=== Creating Perl interpreter failed ===<br />
A fix for an intermittent issue was implemented. Thanks to Adam Skwersky.<br />
<br />
<br />
=== A dot after variable name ===<br />
In a parameterized text field, a dot placed immediately after variable name is no longer causing any issues.<br />
<br />
<br />
=== Multiline SQL queries and DB2 ===<br />
An issue was resolved that was causing issues with some releases of DB2 database. <br />
<br />
<br />
== Enhancements ==<br />
<br />
=== ClearQuest 7.1.x installation ===<br />
ClearQuest 7.1.x installation was improved<br />
<br />
<br />
=== Expressions in function list of parameters ===<br />
In list of parameters, there no need to use brackets around expressions. For example,<br />
<source lang="perl">IF( $a > $b, "a", "b" )</source><br />
<br />
<br />
=== $EmailNotificationRuleName built-in variable ===<br />
New built-in variable, $EmailNotificationRuleName, was introduced to carry evaluated rule name.<br />
<br />
<br />
=== Rules Evaluation Order ===<br />
You can change Notification Rules evaluation order. Sort key is a text field. All rules are sorted in ascending order by the Order field.<br />
<br />
<br />
=== FROM Email address ===<br />
A parameterized text field was added to Notification rule to customize From address.<br />
# when Notification Rule From field is not empty, it is expanded and used as from address on generated email<br />
# when From field is empty, and email_from database property exists, email_from content is evaluated to be used as from address<br />
# otherwise, email address of the user executing action triggering email is used as from email address<br />
<br />
<br />
=== Applying package to a stateless record ===<br />
Package can be applied to a stateless record type using package wizard (using command line was required in previous release).<br />
In order to apply to a record type that belongs to a package, package editing needs to be enabled.<br />
<br />
<br />
=== Email self-subscription ===<br />
Optional self-subscription functionality is available with optional EmailSubscription package.<br />
<br />
<br />
=== Access controls ===<br />
Unified access control was implemented.<br />
<br />
{| border="1" width="100%" align="center"<br />
! Record Type<br />
! Action<br />
! Permissions<br />
|-<br />
|rowspan="3"|'''udb_visibility'''<br />
| Submit<br />
| <br />
* Superuser<br />
|-<br />
| Update<br />
| <br />
* Superuser<br />
* Security Administrator<br />
* Security context group member<br />
|-<br />
| Remove<br />
|<br />
* Superuser<br />
|-<br />
<br />
|rowspan="3"|'''udb_property'''<br />
| Submit<br />
| <br />
* Superuser<br />
* Security Administrator<br />
* Default Security context group member<br />
: (set by PropertyDefaultSecurityGroup database property)<br />
|-<br />
| Update<br />
| <br />
* Superuser<br />
* Security Administrator<br />
* Security context group member<br />
|-<br />
| Remove<br />
|<br />
* Superuser<br />
|-<br />
|rowspan="3"|'''Email_Notification_Rule'''<br />
| Submit<br />
| <br />
* Superuser<br />
* Security Administrator<br />
* Default Security context group member<br />
: (set by NotificationDefaultSecurityGroup database property)<br />
|-<br />
| Update<br />
| <br />
* Superuser<br />
* Security Administrator<br />
* Security context group member<br />
|-<br />
| Remove<br />
|<br />
* Superuser<br />
|-<br />
|rowspan="3"|'''en_email_message'''<br />
| Submit<br />
| <br />
* Superuser<br />
* A member of group specified by EN_AdminGroup database property<br />
|-<br />
| Update<br />
| <br />
* Superuser<br />
* A member of group specified by EN_AdminGroup database property<br />
|-<br />
| Remove<br />
|<br />
* Superuser<br />
* A member of group specified by EN_AdminGroup database property<br />
|-<br />
|rowspan="5"|'''Email_Subscription'''<br />
| Submit<br />
| <br />
* Superuser<br />
* Security Administrator<br />
* Default Security context group member<br />
: (set by NotificationDefaultSecurityGroup database property)<br />
|-<br />
| Update<br />
| <br />
* Superuser<br />
* Security Administrator<br />
* Security context group member<br />
|-<br />
| Remove<br />
|<br />
* Superuser<br />
|-<br />
| Subscribe_Me<br />
| <br />
* All users<br />
|-<br />
| Unsubscribe_Me<br />
| <br />
* All users<br />
|}<br />
<BR /><br />
Submit action can be enabled for all users by setting '''Notification_Bypass_Access_Control''' database property.<br />
<BR /><br />
<br />
<br />
== Prerequisites ==<br />
=== ClearQuest client version ===<br />
The package can be '''installed''' using ClearQuest 7.0.0 or later. Nevertheless, it can be '''used''' with pre-7.0 clients as well.<br />
<br />
<br />
== Read More ==<br />
* [[ClearQuest_Email_Notification_Package | ClearQuest Email Notification Package]]<br />
* [[Package_configuration | Package configuration guide]]<br />
* [[ClearQuest_Email_Notification_Package_FAQ | Frequently Asked Questions ]]<br />
* [[Notification_Examples | Examples]]<br />
<br />
<br />
== Downloads ==<br />
[http://cqadmin.org/wiki/Download Download Package]<br />
<br />
<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=Download&diff=247Download2013-02-01T14:46:22Z<p>Paul: </p>
<hr />
<div><big>'''Downloads'''</big><br />
<br />
== ClearQuest Email Notification Package ==<br />
Please visit [[Package_installation | installation]] and [[Package_configuration | configuration]] pages for detailed instructions.<br /><br />
The package and supplementary scripts are available now at [http://store.cqadmin.com/index.php/clearquest/cq-email-notification.html CQAdmin store]<br />
<br /><br /><br />
<br />
== Dynamic List Editor for IBM-Rational ClearQuest ==<br />
Please check the [[ClearQuest_Dynamic_List_Editor | documentation]] page for details.<br /><br />
The distribution is available at [http://store.cqadmin.com/index.php/dynamic-list-editor-for-ibm-rational-clearquest.html CQAdmin store].<br />
<br /><br /><br />
<br />
== User Administration Tool for IBM-Rational ClearQuest ==<br />
Please check the [[User_Admin_Tool_Installation | installation]] and [[User_Admin_Tool_Configuration | configuration]] pages for details.<br /><br />
The distribution is available at [http://store.cqadmin.com/index.php/clearquest/user-administration-tool.html CQAdmin store].<br />
<br />
<br />
<br />
<br /><br />
== Download Instructions ==<br />
=== Download Links in Email ===<br />
In order to download products, you have to register at [http://store.cqadmin.com/index.php/ CQAdmin store] and place your order. In few minutes you will receive a confirmation email containing download links.<br />
<br />
[[File:email_links.png]]<br />
<br />
<br />
<br />
=== Downloading Products from the Store ===<br />
Alternatively, you could use "My Downloadable Products" section of your account. You would need to click on the download link right to the order title.<br />
<br />
[[File:store_links.png]]<br />
<br />
<br />
=== '''Microsoft Internet Explorer''' users === <br />
'''Microsoft Internet Explorer''' users might need to use "Save As" option to download file correctly:<br />
* Right click on the download link<br />
* Select "Save As" option from the context menu<br />
* Save downloaded file as "some_name.zip"<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]] [[Category:Dynamic_List_Editor]] [[Category:User_Admin_Tool]]</div>Paulhttps://cqadmin.org/w/index.php?title=ClearQuest_Email_Notification_Package_FAQ&diff=246ClearQuest Email Notification Package FAQ2013-02-01T14:45:52Z<p>Paul: </p>
<hr />
<div><big>'''ClearQuest Email Notification Package'''</big><br />
<p>Frequently asked questions<br />
<br />
== Installation ==<br />
=== What version of ClearQuest the package Can be used with? ===<br />
EmailNotification 1.5 can be installed using ClearQuest Designer 7.0 or later. No additional modifications are required.<br />
<br />
For older versions of the package, 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]]<br />
<br />
=== Do I need to deploy the package on each ClearQuest client? ===<br />
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.<br />
<br />
=== Can I use the package with VBScript-based schema? ===<br />
Yes, the package can be used with VBScript or Perl schema. Package extensions can be implemented with Perl.<br />
<br />
=== Can I apply package to a stateless record type? ===<br />
It is possible. This option is now available in wizard, but you can use command line as well. Please check [[Applying_Package_to_Stateless_Records | applying package to a stateless records]] page for details.<br />
<br />
<br />
== Configuration ==<br />
=== Can I create HTML emails? ===<br />
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.<br />
<br />
=== Can I send attachments with notifications? ===<br />
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.<br />
<br />
=== Where can I find notification rule examples? ===<br />
# [[Notification_Examples | Notification examples]]<br />
# [[Package_configuration | Package configuration guide]]<br />
# [http://cqadmin.org/data/CCMA43.pdf Extending IBM(R) Rational(R) ClearQuest(R) Email Notifications] presentation<br />
# [http://forum.cqadmin.org/ Support forum]<br />
<br />
=== In multisited environment, can I use different SMTP relays for different sites? ===<br />
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.<br />
<br />
You can also unset paticular property by using '''EN_NONE''' as a value.<br />
<br />
=== Can I call one User Defined function from another? ===<br />
Yes, you can use '''EN_CALL_UDF''' function and supply other function name and parameters, but it is not the only way to reuse functionality. You can also define "common block" in a database property and "include" it in other user defined functions. <br />
<br />
For example, you can defined property that contains common function definitions<br />
{| border="1" width="60%"<br />
! width="40%" | Property Name<br />
! Value<br />
|-<br />
| MY_COMMON_BLOCK<br />
| <source lang="perl">sub func1 { ... }<br />
sub func2 { ... }<br />
sub func3 { ... }<br />
</source><br />
|}<br />
<br />
and then re-use it in other user-defined functions<br />
{| border="1" width="60%"<br />
! width="40%" |Property Name<br />
! Value<br />
|-<br />
| MY_FUNCTION<br />
| <source lang="perl"> <br />
eval GetProperty('MY_COMMON_BLOCK');<br />
<br />
...<br />
</source><br />
|}<br />
<br />
<br />
<br />
=== Can I customize the package for my own needs? === <br />
You can enable package editing and add customization.<br />
# close ClearQuest designer and enable package editing from command line:<br />
#; <source lang="bash"> packageutil enableediting [-dbset <dbset>] <login_name> <password> -enable <login_name> </source><br />
#: 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. <br />
# 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)<br />
# test your changes<br />
# disable package editing from command line to prevent accidental modifications<br />
#; <source lang="bash"> packageutil enableediting [-dbset <dbset>] <login_name> <password> -disable <login_name> </source><br />
# check the schema in, and promote changes to production database<br />
<br />
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.<br />
<br />
<br />
== Troubleshooting ==<br />
What if the package is not doing something that you would expect it to do?<br />
* Verify that the package is applied to selected record type. <br />
: When package is applied, you should see "EN_NotifyHook" in the Perl Record Script section of the record.<br />
* Verify that '''email_enabled''' database property (udb_property record) is created and set to non-zero value<br />
* Check if en_email_message record is created. <br />
: en_email_message records are always created when Queue or Deferred (default) delivery mode is used. If you are using Light delivery mode, switch to Deferred until troubleshooting is completed. <br />
* Turn On Debugging<br />
: Create '''Debug''' database property (udb_property record), set it to desirable log level (up to 9), and capture debug output using '''dbwin32.exe''' utility.<br />
* You can always ask for help on [http://forum.cqadmin.org/ support forum].<br />
<br />
<br />
== Known Issues ==<br />
<br />
<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=ClearQuest_Dynamic_List_Editor&diff=245ClearQuest Dynamic List Editor2013-02-01T14:45:27Z<p>Paul: </p>
<hr />
<div><big>'''ClearQuest Dynamic List Editor'''</big><br />
<br />
Created by ClearQuest admin for ClearQuest admins.<br />
<br />
= Dynamic List Editor =<br />
This is NOT a solution that is provided and supported by IBM-Rational. <br />
The Dynamic List Editor is an add-on to your existing ClearQuest schema, VBScript or Perl based, that provides a unified interface to administer Dynamic Lists for Windows, Eclipse, UNIX clients, and (most importantly) the Web client. Additionally, it adds basic audit capabilities that can be enhanced using the Audit Trail package.<br />
The enhancement is distributed as a ClearQuest schema integration, and it can be easily removed from the schema when it is no longer required.<br />
<br />
In the Editor, all dynamic lists are represented by correspondent stateless records of the Dynamic_List record type.<br />
<br />
[[File:Dynamic_List_Editor.png|center]] <br />
<br />
Dynamic List administrators work with the stateless records, and when the update is completed and records are submitted to the database, the correspondent dynamic lists are updated automatically.<br />
<br />
== Installation Instruction ==<br />
'''Please create a backup of schema and user databases before the installation.'''<br /><br />
The package is an add-on to your existing ClearQuest schema. In order to install it, you will need ClearQuest administrative access and administrative tools (ClearQuest designer). When the configuration is completed, users with the "Dynamic List Admin" privilege or super users can modify the content of the Dynamic Lists using ClearQuest Web or other ClearQuest clients.<br />
<br />
=== Automatic Install ===<br />
* Unpack the distribution to your local or network drive (you cannot start the installation from a network share using UNC path)<br />
* Launch "install.bat" in the root of the distribution<br />
* Accept license agreement<br />
* Provide administrative user credentials, ClearQuest connection, database name, and click on "Connect"<br />
<br />
When installation is completed, login to the user database and run "Public Queries/Administration/Dynamic_Lists" query to verify Dynamic list data. You can start using the tool immediately.<br />
<br />
=== Manual Install ===<br />
If you prefer to install the Editor manually, please follow the steps below <br />
It is highly recommended to test the procedure in your development environment, and backup master and user databases before you start.<br />
<br />
==== Download and Unpack Schema Integration ====<br />
Save the downloaded archive to your administrative machine hard drive and unpack it. The integration is a text file that can be easily scanned or inspected.<br />
<br />
==== Apply Integration to ClearQuest Schema ====<br />
* Verify that the ClearQuest schema is checked in, and that there are no pending schema changes that have not been applied to the user database.<br />
* Open the command line tool, (Start->Run "cmd") and change the directory to the location where the integration package was extracted.<br />
* Import integration using the "cqload importintegration" command. For example:<br />
cqload importintegration -dbset <db_connection_name> <admin_user> <admin_password> <ClearQuest_Schema_Name> "" "Dynamic List Editor" 1.0 Dynamic_List_Editor.txt ""<br />
* Verify that the schema update was imported and no issues were detected.<br />
<br />
[[File:cqload_completed.png|center]]<br />
<br />
==== Upgrade User Database ====<br />
Now, you can apply changes to the user database using ClearQuest Designer. For Eclipse Designer, in the ClearQuest Database Admin section, right click on the user database that you are going to apply changes to, and select "Upgrade Database" from the context menu. (In legacy Windows Designer, select the "Upgrade Database..." option from the database menu and select your user database).<br />
<br />
[[File:upgrade_db.png|center]]<br />
<br />
Apply the change that you imported on the previous step by clicking the "OK" button. Verify that user database was upgraded successfully.<br />
<br />
[[File:upgrade_db_completed.png|center]]<br />
<br />
==== Import First Dynamic List ====<br />
The rest of the configuration can be completed from a ClearQuest client. You can use any client of your choice. The instructions are based on ClearQuest Web client, version 8.0.<br />
Login as an administrator (super user), and submit a new record of the "Dynamic_List" type:<br />
<br />
[[File:Submit_Dynamic_List_1.png|center]]<br />
<br />
Select one of the list names from the "Name" drop-down list.<br />
<br />
[[File:Submit_Dynamic_List_2.png|center]]<br />
<br />
Dynamic list values will be populated automatically.<br />
<br />
[[File:Submit_Dynamic_List_3.png|center]]<br />
<br />
click "Save" to commit the record to the database<br />
<br />
==== Creating Dynamic List Administration Query ====<br />
Now, you will need to create a simple query that will be used by Dynamic Lists administrators. Right click on the folder you are going to save the query to, and select "New Query" from the context menu.<br />
<br />
[[File:Dynamic_List_Query _1.png|center]] <br />
<br />
Select "Dynamic_Query" as a record type<br />
<br />
[[File:Dynamic_List_Query _2.png|center]]<br />
<br />
Provide a query name (for instance, "Dynamic Lists"), add the "Name" field to the presentation/display section, and specify the "Ascending" (A-Z) sort order. Save the query.<br />
<br />
[[File:Dynamic_List_Query _3.png|center]]<br />
<br />
==== Importing Dynamic Lists ====<br />
Run the "Dynamic Lists" query that we created on the previous step. You should see one Dynamic List record in the result set. Select the record, and in the "Utilities" section, chose the "SyncAllLists" action.<br />
<br />
[[File:Dynamic_List_Sync_1.png|center]]<br />
<br />
The action syncs ClearQuest records with the correspondent dynamic lists:<br />
* when the ClearQuest record already exists, its content is updated from the dynamic list<br />
* when the ClearQuest record does not exist, a new record is created<br />
* when a dynamic list for the existing ClearQuest record does not exist, the record is deleted.<br />
<br />
[[File:Dynamic_List_Sync_2.png|center]]<br />
<br />
If no error occurred, a confirmation is displayed. Otherwise, you would see an error message.<br />
Refresh the query to verify that all dynamic lists with their proper content are loaded.<br />
<br />
[[File:Dynamic_List_Sync_3.png|center]]<br />
<br />
<br />
== Administering Dynamic Lists ==<br />
When all the Dynamic_List records are populated, List Administrators can start using the query you created and Dynamic_Lists records to modify the content of the linked dynamic lists. Most of the time, the "Update" action is sufficient. In addition, the Editor offers the following actions to simplify administration:<br />
{| class="wikitable"<br />
! Action Name<br />
! Action Type<br />
! Access Control<br />
! Description<br />
|-<br />
| Submit<br />
| Submit<br />
| Super User<br />
| Submit allows the creation of new records when a new Dynamic List added to the ClearQuest schema. You can also use the "SyncAllLists" utility action to synchronize all the records at once.<br />
|-<br />
| Update<br />
| Modify<br />
| Super User, Dynamic List Admins<br />
| Update is the primary action for administering Dynamic Lists content. When an action is initialized, the record is refreshed with the latest content of the dynamic list (please check "Dynamic List Caching" section). When the updated record is saved, its content is saved in the correspondent dynamic list as well.<br />
|-<br />
| Delete<br />
| Utilities / Delete<br />
| Super User<br />
| This action allows you to delete existing Dynamic_List records, such as when a correspondent dynamic list is removed from the schema. Alternatively, you can use the "SyncAllLists" utility action to synchronize all records at once after a database upgrade.<br />
|-<br />
| LoadList<br />
| Utilities / Script<br />
| Super User, Dynamic List Admins<br />
| Load List action updates the current ClearQuest record with the content of the correspondent dynamic list. Please be aware that in order to see the update you might need to refresh the ClearQuest query or even to close and re-run it.<br />
|-<br />
| SaveList<br />
| Utilities / Script<br />
| Super User, Dynamic List Admins<br />
| Save List action saves the content of the current ClearQuest records into a correspondent dynamic list.<br />
|-<br />
| SaveAllLists<br />
| Utilities / Script<br />
| Super User, Dynamic List Admins<br />
| Save all lists saves the content of all ClearQuest Dynamic List records into correspondent dynamic lists. It might be useful when records are imported from an external source.<br />
|-<br />
| SyncAllLists<br />
| Utilities / Script<br />
| Super User<br />
| This action syncs ClearQuest records with their correspondent dynamic lists:<br />
* when the ClearQuest record already exists, its content is updated from the dynamic list<br />
* when the ClearQuest record does not exist, a new record is created<br />
* when a dynamic list for the existing ClearQuest record does not exist, the record is deleted.<br />
|}<br />
<br />
== Dynamic Lists Caching ==<br />
In order to improve performance, ClearQuest caches the content of dynamic lists. When you update the content of dynamic lists using native tools, the update is not available to all existing clients and sessions immediately. Your clients might need to re-login to the database in order to see the changes.<br />
Similarly, the dynamic list editor is using an actual dynamic list as a primary trusted source of data for the records. When you initiate a record update, the record content is loaded from the dynamic list first. In an environment where dynamic lists are actively updated from many clients simultaneously, it might cause overwriting, because the cached list values could be used by ClearQuest. In a so changing environment, it is recommended to re-login to the database before starting a dynamic list modification (the same issue exists when you use native tools in the legacy ClearQuest Windows Client). <br />
If you rarely use native tools to update dynamic lists (for instance, when a ClearQuest full client is not installed on the Dynamic List Admins' machines, and they use the Editor's Web Client capability to modify lists only), you can select the ClearQuest records as a trusted source of data for the dynamic lists. In order to do so, you need to remove the "Update" action initialization hook from the Dynamic_List record type, and upgrade the user database to apply changes. This would ensure that the most accurate data is used for list modification.<br />
<br />
== Support ==<br />
: ClearQuest Dynamic List Editor is supported by [http://cqadmin.com CQAdmin, inc]. Three levels or support agreement are currently offered, starting with '''free''' community support at [http://forum.cqadmin.org http://forum.cqadmin.org]. Consulting services are also available.<br />
<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Dynamic_List_Editor]]</div>Paulhttps://cqadmin.org/w/index.php?title=User_Admin_Tool_Installation&diff=244User Admin Tool Installation2013-02-01T14:45:05Z<p>Paul: </p>
<hr />
<div><big>'''User Administration Tool Installation'''</big><br />
<br />
== Planing the Installation ==<br />
User Administration Tool for IBM-Rational ClearQuest is a ClearQuest database. The installer will add a custom schema to your schema repository, create user database associated with the schema, and load all data. Before you proceed, you need to collect:<br />
* Physical Database information of empty database (DB vendor, server, database name, database user account, and connect options). The database needs to be created in advance (unless you are going to use Microsoft Access).<br />
* Email notification settings - SMTP server name and email user credentials (if password authentication is required with SMTP relay). You can check [[Package_configuration | Email Notification Package Configuration]] page for additional information.<br />
* Obtain local administrative rights on the machine where you are going to perform the installation.<br />
* Create (or use an existing) ClearQuest account with Super User right that will be used for user account management. It is recommended to use ClearQuest authentication for the account to avoid problems related to password expiration.<br />
<br />
== Backup Schema Repository Database ==<br />
It is always a good idea to create a backup before you making any change to the schema repository to roll back the change if necessary, and I strongly recommend to install the tool in your testing environment first: you would be able to validate that it is compatible with your environment and database vendor. It would minimize risks associated with deployment of the tool in your production environment later.<br />
<br />
<br />
== Installing User Admin Tool ==<br />
You can install the tool using any machine that has IBM-Rational ClearQuest installed and ClearQuest connection configured. <br />
First, unpack User Administration Tool distribution to local or network drive (you cannot start installation from network location referenced via UNC path), and launch '''install.bat''' located in the root of the distribution. <br />
[[File:user_admin_install.png|none]]<br />
<br />
<br />On Windows 7 and Windows 2008 machines you need to select "Run as Administrator" option explicitly, and allow making changes<br />
[[File:user_admin_install_2.png|none]]<br />
<br />
<br />Login to the ClearQuest using connection (dbset) that you would like to enable for user administration using Super User account you created on the "planning..." step.<br />
[[File:user_admin_install_login.png|none]]<br />
<br />
<br />Provide required information to create ClearQuest User Administration database. Depending on your database vendor and environment, you might need to provide additional connection options. Please check ClearQuest administration manual for details. If you aborted the installation for any reason after user database was created, you would be allowed to select user database created earlier instead of creating a new one.<br />
[[File:user_admin_db_settings.png|none]]<br />
<br />
<br />Verify that you entered all information and click on "Create DB" button. The installer will start creating user database and importing all user data. There is no progress indicator, please be patient. Depending on database server load and number of user accounts the initial load might take significant time. For example, in my local environment it takes about 15 minutes to load 3000 users and groups.<br />
<br />
When user database is created and data import is completed, the installer will offer you to configure email notification setting. Please provide required information and save settings. The installer will validate SMTP server connectivity.<br />
[[File:user_admin_en_config.png|none]]<br />
<br />
<br />It is the last step in the installation procedure, and no error occurred, you should receive the following confirmation. <br />
[[File:user_admin_install_completed.png|none]]<br />
<br />
<br />Congratulations! You have completed your installation. Log in to the ClearQuest database you created and you can start using it immediately.<br />
<br />
== Additional Information==<br />
The following links could be useful<br />
* [[User_Admin_Tool_Configuration | Configuring User Administration Tool]]<br />
* [[Managing_ClearQuest_Users | Managing ClearQuest Users]].<br />
* [http://forum.cqadmin.org/ Support forum]<br />
<br />
<br />
[[Category:Rational]] [[Category:User_Admin_Tool]]</div>Paulhttps://cqadmin.org/w/index.php?title=Timed_Notification&diff=243Timed Notification2013-02-01T14:44:47Z<p>Paul: </p>
<hr />
<div>=Timed Notification=<br />
<br />
<br />
== What does Timed Notification mean? == <br />
Sometimes we would like to implement notifications that are not triggered by particular action. You might need a reminder that defect approached a resolution deadline, or that a trouble ticket passed due date, was not implemented in time frame required by the Service Level Agreement, was not assigned for implementation in a reasonable time frame. I call such kind of requests Timed Notifications or Reminders.<br />
<br />
<br />
== How Timed Notifications / Reminders are implemented? ==<br />
There are two parts of the complicated task<br />
# find records that could be eligible for notification<br />
# trigger notifications based on information in selected records<br />
<br />
<br />
=== How to find records? ===<br />
To make it flexible and to avoid waste of resources, the selection process is implemented in two phases: <br />
# '''Initial records selection''' selects records that might be eligible, define notification scope. <br />
#: It would be too expensive to check evaluate every ClearQuest record to determine whether or not notification condition met. In order to improve performance and reduce load on the database, we need to reduce number or records for evaluation. For example, when implementing due date reminder, we could safely exclude closed or resolved defects. It could be different in other cases, but the main goal would always be defining potential notification scope, then <br />
# '''Final selection''' evaluates notification rules on selected at step (1) records and triggers notification if condition is met (for example, the record passed due date). <br />
<br />
<br />
==== Initial records selection ====<br />
It is limiting scope based on simple criteria that can be used in a SQL Query to retrieve records. For example, you can limit records based on record type, current state, severity, assignment, etc.<br />
Timed Notification script offers you two possibilities: <br />
# create a ClearQuest query, and save it in the public workspace <br />
# specify criteria to create the query dynamically during the execution<br />
<br />
<br />
==== Final selection ====<br />
In addition, records can be filtered based on Email Notification Rule ''Condition'' field.<br />
It is performed during evaluation of notification rules on the record set selected on the previous step. Rules evaluation is expensive process that is why it very is important to have good initial record selection.<br />
<br />
<br />
=== Triggering notifications ===<br />
Since we are using extremely customizable email notification rules for other actions, it makes sense to use the same functionality, and keep timed notification rules at the same place.<br />
Regular notifications are triggered by ''actions'', timed notifications - by ''pseudo-actions''. It means that in reality no action is executed, but the script evaluates email notification rules on selected records in the same way as it would be done if the real action would be invoked.<br />
<br />
<br />
If you noticed, selection of actions on Email Notification Rule record is not limited to actions defined for the record type, and it is done on purpose: you can specify there non-existent, '''pseudo-action''' name.<br />
<br />
<br />
To make all thins working, you just need to<br />
* create a notification rule, using ''pseudo-action''<br />
* run the script using the ''pseudo-action'' as a parameter<br />
* let script know the record types that it will be running on and the way to limit record set for notification rules evaluation.<br />
<br />
<br />
ClearQuest does not have any server based process like cron that can trigger actions. It can be changed in the future (the new ClearQuest Web Server includes request manager that does not have any public interface so far), but as of today, the only way to trigger timed email notification is to run timed notification script from UNIX cron or Windows scheduler on your ClearQuest server.<br />
<br />
<br />
You can download timed notification script [[Download | here]].<br />
<br />
== Configuration ==<br />
For example, we would like to notify assignees about defects that will pass due date in the next 24 hours. I will name pseudo action used in this example '''DailyNotification''' <br />
<br />
<br />
The following tasks need to be accomplished<br />
<br />
=== Configure Scheduler on a ClearQuest server ===<br />
CQ Web server could be a good candidate to run the script. The following script need to be configured to run daily, let's say at 4 AM<br />
<source lang="bash"><br />
cqperl TimedNotification.pl <cq_login> <password> <database> <dbset> "DailyNotification"<br />
</source><br />
<br />
<br />
=== Enable Notification for the record type ===<br />
In this example, we need to inform the script that it is running on ''Defect'' record type.<br />
In order to do it, '''TN_RecordTypes''' property need to be set to '''Defect'''<br />
(udb_property record type has to be submitted with "Defect" value)<br />
<br />
'''Note''': '''TN_RecordTypes''' property value can contain more then one record type. A list of enabled record types has to be specified as '''one-record-type-per-line'''.<br />
<br />
<br />
=== Create email notification rule ===<br />
Email Notification Rule for Defect record type (major fields)<br />
{| width="100%" border="1" cellspacing="2" cellpadding="5" valign="top" <br />
! Field<br />
! Value<br />
|-<br />
| Name<br />
| Defect_Reminder<br />
|-<br />
| Record Type<br />
| Defect<br />
|-<br />
| Actions<br />
| '''DailyNotification'''<br />
|-<br />
| Condition<br />
| <source lang="perl"> $Due_Date ne '' && DateTimeDiff( $Due_Date, GetDateTime('+1d') ) < 0 </source><br />
|-<br />
| To:<br />
| <source lang="perl"> ${owner.email} </source><br />
|-<br />
| Subject: <br />
| <source lang="text">Defect $ID will pass due date $Due_Date soon</source><br />
|-<br />
| Body:<br />
| <source lang="text">You need to do something with defect $ID</source><br />
|}<br />
<br />
<br />
=== Limit record set for notification rules evaluation ===<br />
It would be too expensive to evaluate the notification rule on each record. It is a good idea to limit an evaluation scope. As it was discussed above, there are 2 ways to do it.<br />
<br />
==== Create query in ClearQuest client ====<br />
For example, we can create query that will filter open defect, save as "Public Queries\Admin\DailyNotificationQuery" and set '''TN_Query-Defect-DailyNotification''' property to that value.<br />
<br />
When script is executed, it checks '''TN_Query-{record type}-{pseudo action name}''' or '''TN_Query-{record type}''' properties if the first one is not defined. <br />
<br />
<br />
'''Note:''' You could have both '''TN_Query-{record type}''' and '''TN_Query-{record type}-{pseudo action name}''' properties in your database. The first one would work as a default value for all action names, while '''TN_Query-{record type}-{pseudo action name}''' would overwrite default value if specified.<br />
<br />
<br />
==== OR provide filter criteria for dynamic query ====<br />
This way you can specify state names that have to be excluded from the notification. Based on information provided, script will create a query at run time. <br />
The states can be specified using '''TN_QueryExcludeStates-{record type}-{pseudo action name}''' or '''TN_QueryExcludeStates-{record type}''' property in one-state-per-line style.<br />
In our case, we can submit '''TN_QueryExcludeStates-Defect-DailyNotification''' property with the following values:<br />
Submit<br />
Closed<br />
<br />
<br />
If 'TN_Query-{record type}-{pseudo action name}' and 'TN_Query-{record type}' properties do not exist, the script checks for excluded state properties and uses them as a filter in run-time created query.<br />
<br />
<br />
'''Note:''' You could have both '''TN_QueryExcludeStates-{record type}''' and '''TN_QueryExcludeStates-{record type}-{pseudo action name}''' properties in your database. The first one would work as a default value for all action names, while '''TN_QueryExcludeStates-{record type}-{pseudo action name}''' would overwrite default value if specified.<br />
<br />
== Properties used in Timed Notification script ==<br />
{| width="100%" border="1" cellspacing="2" cellpadding="5" valign="top" <br />
! Property name<br />
! Description<br />
|-<br />
| valign="top" | '''''TN_RecordTypes'''''<br />
| list of record types enabled for the timed notification script<br /><br />
|-<br />
| valign="top" | '''''TN_Query-{record type}-{action name}'''''<br />
| Workspace path to a ClearQuest query that will be used to extract record for email notification rules evaluation for pseudo action {action name} (from the script command line)<br /> Overwrites TN_Query-{record type} property when exists.<br />
|-<br />
| valign="top" | '''''TN_Query-{record type}'''''<br />
| Workspace path to a ClearQuest query that will be used to extract record for email notification rules evaluation for any pseudo action name<br />
|-<br />
| valign="top" | '''''TN_QueryExcludeStates-{record type}-{action name}'''''<br />
| a set of record states, one per line, that will be filtered out in run-time query for pseudo action {action name}, when TN_Query-{record type}-{action name} or TN_Query-{record type} properties do not exist.<br /><br />
Overwrites TN_QueryExcludeStates-{record type} property when exists.<br /><br />
|-<br />
| valign="top" | '''''TN_QueryExcludeStates-{record type}'''''<br />
| a set of record states, one per line, that will be filtered out in run-time query for any pseudo action, when TN_Query-{record type}-{action name} or TN_Query-{record type} properties do not exist.<br />
|}<br />
<br /> <br /><br />
<br />
<br />
[[Category:Rational]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=Notification_Examples&diff=242Notification Examples2013-02-01T14:44:29Z<p>Paul: </p>
<hr />
<div><center><big>'''<big>Examples</big>'''</big><br /></center><br />
<br />
== '''Defect state updates''' ==<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 /> <br />
<br />
We will define two supplementary functions in database properties:<br />
<br /> udb_property records:<br /><br />
<br />
{| width="100%" border="1" cellspacing="2" cellpadding="2"<br />
! width="20%" valign="top" | Name<br /><br />
! valign="top" | nm_value<br /><br />
|-<br />
| width="20%" valign="top" | GetUserLoginName<br /><br />
| valign="top" | <source lang="perl"> return $session->GetUserLoginName();</source><br />
|-<br />
| width="20%" valign="top" | GetCurrentDatabaseName<br /><br />
| valign="top" | <source lang="perl"><br />
my $dbname = $session->GetSessionDatabase()->GetDatabaseName();<br />
return $dbname;</source><br />
|}<br />
<br />
<br /> Email_Notification_Rule fields:<br /><br />
<br />
{| width="100%" border="1" cellspacing="2" cellpadding="2"<br />
! width="20%" valign="top" | Form Field Name<br /> (CQ field name)<br /><br />
! valign="top" | Value<br /><br />
|-<br />
| width="20%" valign="top" | Name<br /> (name)<br /><br />
| valign="top" | State change submitter notification (any unique name)<br /><br />
|-<br />
| width="20%" valign="top" | Record Type<br /> (Entity_Def)<br /><br />
| valign="top" | Defect<br /><br />
|-<br />
| width="20%" valign="top" | Actions<br /> (actions)<br /><br />
| valign="top" | Postpone<br /> Reject<br /> Close<br /><br />
|-<br />
| width="20%" valign="top" | Condition<br /> (Msg_Condition)<br /><br />
| valign="top" | '''GetUserLoginName()''' ne '''$Submitter'''<br /><br />
|-<br />
| valign="top" | To<br /> (Msg_To_Users)<br /><br />
| valign="top" | '''$Submitter.email'''<br /><br />
|-<br />
| valign="top" | Subject<br /> (Msg_Subject)<br /><br />
| valign="top" | Your Defect ''''$ID'''' has been '''${state}'''.<br /><br />
|-<br />
| valign="top" | Body<br /> (Msg_Body)<br /><br />
| valign="top" | Your Defect ''''$ID'''' has been '''${state}'''.<br /> Defect title: ''''$Headline''''<br /><br /> <nowiki>http://newcqweb-server/cqweb/main?USE_CASE=GO&service=CQ&schema=DBSET&contextid=</nowiki>'''GetCurrentDatabaseName()'''&entityID='''${dbid}'''&entityDefName=Defect<br /><br /><br />
|}<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 /><br />
Starting version 1.5, '''$UserLoginName''' predefined package variable can be used instead of GetUserLoginName user-defined function<br /><br /><br /><br />
<br />
== '''Using SQL query''' ==<br />
Send notification to clearquest user group 'CCB_Approvers' and submitter when request been resolved<br /><br />
<br />
{| width="100%" border="1" cellspacing="2" cellpadding="2"<br />
! width="20%" valign="top" | Form Field Name<br /> (CQ field name)<br /><br />
! valign="top" | Value<br /><br />
|-<br />
| width="20%" valign="top" | Name<br /> (name)<br /><br />
| valign="top" | Resolution Notification (any unique name)<br /><br />
|-<br />
| width="20%" valign="top" | Record Type<br /> (Entity_Def)<br /><br />
| valign="top" | Defect<br /><br />
|-<br />
| width="20%" valign="top" | Actions<br /> (actions)<br /><br />
| valign="top" | Resolve<br /><br />
|-<br />
| valign="top" | To<br /> (Msg_To_Users)<br /><br />
| valign="top" | '''$Submitter.email<br /> SQL("SELECT T2.email <br /> FROM parent_child_links T1, groups T3, users T2 <br /> WHERE T1.parent_dbid = T2.dbid <br /> AND T1.child_dbid = T3.dbid <br /> AND T3.name = 'CCB_Approvers' <br /> AND T2.is_active = 1")<br />'''<br />
|-<br />
| valign="top" | Subject<br /> (Msg_Subject)<br /><br />
| valign="top" | Defect ''''$ID'''' has been resolved. Resolution ''''$Resolution''''<br /><br />
|-<br />
| valign="top" | Body<br /> (Msg_Body)<br /><br />
| valign="top" | Defect ''''$ID'''' has been resolved. <br /> Defect title: ''''$Headline''''<br /> Resolution: ''''$Resolution''''<br /> Description: <br />'''$Description'''<br /><br /> <nowiki>http://newcqweb-server/cqweb/main?USE_CASE=GO&service=CQ&schema=DBSET&contextid=</nowiki>'''GetCurrentDatabaseName()'''&entityID='''${dbid}'''&entityDefName=Defect<br /><br /><br />
|}<br />
<br />
<br /> You can also create reusable function and put it into properties <br /> udb_property record<br /><br />
<br />
{| width="100%" border="1" cellspacing="2" cellpadding="2"<br />
! width="20%" valign="top" | Name<br /><br />
! valign="top" | nm_value<br /><br />
|-<br />
| width="20%" valign="top" | GetGroupEmailAddresses<br /><br />
| valign="top" | <source lang="perl"> my ($groupname) = @_;<br />
my $return_string;<br />
<br />
# SQL statement<br />
my $result_set = $session->BuildSQLQuery(<br />
"SELECT T2.email<br />
FROM parent_child_links T1, groups T3, users T2<br />
WHERE T1.parent_dbid = T2.dbid<br />
AND T1.child_dbid = T3.dbid<br />
AND T3.name = '$groupname'<br />
AND T2.is_active = 1");<br />
<br />
$result_set->Execute();<br />
# fetch email addresses<br />
while( $result_set->MoveNext() == $CQPerlExt::CQ_SUCCESS ){<br />
my $tmp_str = $result_set->GetColumnValue(1);<br />
$return_string .= "$tmp_str\n";<br />
}<br />
# clear 'errors'<br />
$result_set = undef;<br />
$@ = '';<br />
<br />
return $return_string;</source><br />
|}<br />
<br />
<br /> In this case 'To' field in Notification rule could be changed to:<br /><br />
<br />
{| width="100%" border="1" cellspacing="2" cellpadding="2"<br />
! width="20%" valign="top" | Form Field Name<br /> (CQ field name)<br /><br />
! valign="top" | Value<br /><br />
|-<br />
| valign="top" | To<br /> (Msg_To_Users)<br /><br />
| valign="top" | '''$Submitter.email<br /> GetGroupEmailAddresses( 'CCB_Approvers' )<br />'''<br />
|}<br />
<br /><br /><br />
<br />
== '''SQL query and dynamically assigned message priority''' ==<br />
To simplify defect management, we use assignment or functional group idea.<br /> Defect submitters do not know who is responsible for particular feature, but can guess, what functional area is.<br /> Submitter needs to select Assignment group only.<br /> We need to notify Assignment group manager(s) about new defect assigned to group.<br /> If defect Severity is '1-Critical' or Priority is '1-Resolve Immediately', email message has to be flagged as 'High Priority'.<br /><br /> Possible AssignmentGroups stateless record type implementation: <br /><br />
<br />
{| style="width: 60%; text-align: left" border="1" cellspacing="2" cellpadding="2"<br />
| style="vertical-align: top; width: 15%" | '''Name '''<br />
| style="vertical-align: top; width: 25%" | SHORT_STRING<br /><br />
| style="vertical-align: top" | Unique group name<br />
|-<br />
| style="vertical-align: top; width: 15%" | '''Managers<br />'''<br />
| style="vertical-align: top; width: 25%" | REFERENCE to users<br /><br />
| style="vertical-align: top" | group managers<br />
|-<br />
| style="vertical-align: top; width: 15%" | '''Users<br />'''<br />
| style="vertical-align: top; width: 25%" | REFERENCE to users<br />
| style="vertical-align: top" | group members<br />
|-<br />
| style="vertical-align: top; width: 15%" | '''Active'''<br />
| style="vertical-align: top; width: 25%" | INT<br /><br />
| style="vertical-align: top" | obsolete groups marked as '0', valid groups as '1'<br />
|}<br />
<br />
<br /> ''Defect'' record type has Assigned_To_Group field (reference to ''AssignmentGroups''). <br /><br /><br />
<br />
{| width="100%" border="1" cellspacing="2" cellpadding="2"<br />
! width="20%" valign="top" | Form Field Name<br /> (CQ field name)<br /><br />
! valign="top" | Value<br /><br />
|-<br />
| width="20%" valign="top" | Name<br /> (name)<br /><br />
| valign="top" | Notify Group Managers (any unique name)<br /><br />
|-<br />
| width="20%" valign="top" | Record Type<br /> (Entity_Def)<br /><br />
| valign="top" | Defect<br /><br />
|-<br />
| width="20%" valign="top" | Field Change<br /> (Field_Change)<br /><br />
| valign="top" | Assigned_To_Group<br /><br />
|-<br />
| valign="top" | Priority<br /> (Msg_Priority)<br /><br />
| valign="top" | '''$Priority''' =~ /^1/ <nowiki>||</nowiki> '''$Severity''' =~ /^1/<br />
|-<br />
| valign="top" | To<br /> (Msg_To_Users)<br /><br />
| valign="top" | '''SQL("SELECT T3.email<br /> FROM parent_child_links T1, fielddef T2, users T3, assignmentgroups T4<br /> WHERE T1.parent_dbid = T4.dbid<br /> AND T1.child_dbid = T3.dbid<br /> AND T1.parent_fielddef_id = T2.id<br /> AND T2.name = 'Managers'<br /> AND T4.name = '${Assigned_To_Group}' ")<br />'''<br />
|-<br />
| valign="top" | Subject<br /> (Msg_Subject)<br /><br />
| valign="top" | Defect ''''$ID'''' with severity: ''''$Severity'''' and priority: ''''$Priority'''' has been assigned to your team. Please assign it to somebody in your team.<br /><br />
|-<br />
| valign="top" | Body<br /> (Msg_Body)<br /><br />
| valign="top" | Defect ''''$ID'''' has been assigned to your team. <br /> Please assign Defect to somebody in your team or re-assign it to another team if initial assignment was incorrect.<br /><br /> Defect title: ''''$Headline''''<br /> Severity: ''''$Severity''''<br /> Priority: ''''$Priority''''<br /> Description: <br />'''$Description'''<br /><br /> <nowiki>http://newcqweb-server/cqweb/main?USE_CASE=GO&service=CQ&schema=DBSET&contextid=</nowiki>'''GetCurrentDatabaseName()'''&entityID='''${dbid}'''&entityDefName=Defect<br /><br /><br />
|}<br />
<br /><br /><br />
<br />
<br />
== '''Using original field value''' ==<br />
Starting version 1.4, original value can be accessed using '''GetFieldOriginalValue''' package-defined function, but this example can be used in earlier versions of the package.<br />
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 /><br />
<br />
{| width="100%" border="1" cellspacing="2" cellpadding="2"<br />
! width="20%" valign="top" | Name<br /><br />
! valign="top" | nm_value<br /><br />
|-<br />
| width="20%" valign="top" | GetFieldOriginalValue<br /><br />
| valign="top" | <source lang="perl"><br />
my $name = shift;<br />
my $value = '' ;<br />
eval {<br />
$value = $entity->GetFieldOriginalValue($name)->GetValue();<br />
};<br />
$@ = '';<br />
return $value;</source><br />
|}<br />
<br />
<br /> Notification rule:<br /><br />
<br />
{| width="100%" border="1" cellspacing="2" cellpadding="2"<br />
! width="20%" valign="top" | Form Field Name<br /> (CQ field name)<br /><br />
! valign="top" | Value<br /><br />
|-<br />
| width="20%" valign="top" | Name<br /> (name)<br /><br />
| valign="top" | Priority has been raised - notify assignee<br /><br />
|-<br />
| width="20%" valign="top" | Record Type<br /> (Entity_Def)<br /><br />
| valign="top" | Defect<br /><br />
|-<br />
| width="20%" valign="top" | Field Change<br /> (Field_Change)<br /><br />
| valign="top" | Priority<br /><br />
|-<br />
| valign="top" | Condition<br /> (Msg_Condition)<br /><br />
| valign="top" | '''$Priority''' gt '''GetFieldOriginalValue('Priority')'''<br />
|-<br />
| valign="top" | To<br /> (Msg_To_Users)<br /><br />
| valign="top" | '''$owner.email<br />'''<br />
|-<br />
| valign="top" | Subject<br /> (Msg_Subject)<br />
| valign="top" | Priority has been raised for defect ''''$ID'''' from ''''GetFieldOriginalValue('Priority')' '''to ''''$Priority''''<br />
|-<br />
| valign="top" | Body<br /> (Msg_Body)<br /><br />
| valign="top" | Priority has been raised for defect ''''$ID'''' from ''''GetFieldOriginalValue('Priority')' '''to ''''$Priority''''<br /><br /> Defect title: ''''$Headline''''<br /> Severity: ''''$Severity''''<br /> Priority: ''''$Priority''''<br /> Description: <br />'''$Description'''<br /><br /> <nowiki>http://newcqweb-server/cqweb/main?USE_CASE=GO&service=CQ&schema=DBSET&contextid=</nowiki>'''GetCurrentDatabaseName()'''&entityID='''${dbid}'''&entityDefName=Defect<br /><br /><br />
|}<br />
<br />
<br /><br /><br />
<br />
== '''Sending HTML Emails''' ==<br />
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 />
<br />
<br /> Notification rule:<br /><br />
<br />
{| width="100%" border="1" cellspacing="2" cellpadding="2"<br />
! width="20%" valign="top" | Form Field Name<br /> (CQ field name)<br /><br />
! valign="top" | Value<br /><br />
|-<br />
| width="20%" valign="top" | Name<br /> (name)<br /><br />
| valign="top" | My first HTML email<br /><br />
|-<br />
| width="20%" valign="top" | Record Type<br /> (Entity_Def)<br /><br />
| valign="top" | Defect<br /><br />
|-<br />
| valign="top" | Header add-in<br /> (Msg_Header)<br /><br />
| valign="top" | '''Content-Type: text/html; charset=us-ascii'''<br />
|-<br />
| valign="top" | To<br /> (Msg_To_Users)<br /><br />
| valign="top" | '''$owner.email<br />'''<br />
|-<br />
| valign="top" | Subject<br /> (Msg_Subject)<br />
| valign="top" | HTML test message for defect ''''$ID''''<br />
|-<br />
| valign="top" | Body<br /> (Msg_Body)<br /><br />
| valign="top" | <source lang="xml"><br />
<HTML> <BODY><br />
<H2 ALIGN="left">$EntityDefName $ID</H2><br />
<TABLE ALIGN="left" BORDER="1"><br />
<TR><TD><b>ID</b> </TD> <TD>$id </TD></TR><br />
<TR><TD><b>headline</b></TD> <TD>$Headline</TD></TR><br />
<TR><TD><b>Priority</b></TD> <TD>$Priority</TD></TR><br />
<TR><TD><b>Severity</b></TD> <TD>$Severity</TD></TR><br />
<TR><TD><b>Description</b></TD><br />
<TD><PRE>$Description</PRE> </TD></TR><br />
</TABLE> </BODY> </HTML> </source><br />
|}<br />
<br /><br /><br />
<br />
== '''Sending Emails with Attachments''' ==<br />
<br />
Fist of all, it is not recommended to attach large files to email messages. It might significantly impact your application performance.<br />
It would work better if you could send an URL to the record, or the file, but sometimes, attaching files to emails is the only solution.<br />
<br />
In this case, we will define two supplementary functions: one to check for attachments, and another to add attachments to email.<br />
<br /> udb_property records:<br /><br />
<br />
{| width="100%" border="1" cellspacing="2" cellpadding="2"<br />
! width="20%" valign="top" | Name<br /><br />
! valign="top" | nm_value<br /><br />
|-<br />
| width="20%" valign="top" | RT_HasAttachments<br /><br />
| valign="top" | <source lang="perl"> <br />
# checks for attachment on current entity<br />
# returns true or false respectively<br />
my ($result, $i);<br />
my $att_fields = $entity->GetAttachmentFields();<br />
# check for attachments in all Attachment type fields<br />
for($i = 0; $i < $att_fields->Count(); $i++ ){<br />
my $att_field = $att_fields->Item($i);<br />
if($att_field->GetAttachments()->Count() > 0 ){<br />
$result = 1; # attachment exists<br />
last;<br />
}<br />
}<br />
# TRUE if current record has attachment<br />
return $result; </source><br />
|-<br />
| width="20%" valign="top" | RT_InsertAttachments<br /><br />
| valign="top" | <source lang="perl"><br />
# add attachments to email<br />
require MIME::Base64;<br />
my ($result, $tmp, $attachments, $attachment, $file, $tmpfile, $nload, $i, $k, $num);<br />
<br />
# get all fields of attachment type<br />
my $att_fields = $entity->GetAttachmentFields();<br />
my $dbid = $entity->GetFieldValue('dbid')->GetValue();<br />
<br />
# create unique boundary separator<br />
my $boundary = "Boundary_($dbid)";<br />
<br />
# get temporary directory location where to extract attachments<br />
$tmp .= '/' if (($tmp = $ENV{TMP}) ne '' || ($tmp = $ENV{TEMP}) ne '');<br />
$tmp = '/tmp/' if ( $tmp eq '' && $^O ne 'MSWin32' );<br />
<br />
for($i = 0; $i < $att_fields->Count(); $i++ ){<br />
# for all attachment fields:<br />
my $att_field = $att_fields->Item($i);<br />
if( ($num = ($attachments = $att_field->GetAttachments())->Count()) > 0 ){<br />
for($k=0; $k < $num; $k++){<br />
# for all attachments in the field<br />
# get attachment<br />
$attachment = $attachments->Item($k);<br />
# get the file name<br />
$file = $attachment->GetFileName(); <br />
if( $file =~ /[\\\/]/ ){<br />
# if the file has path delimiters – it has not been loaded yet<br />
# (file attached in current action?)<br />
# we can use its original location<br />
$tmpfile = $file;<br />
# remove path delimiters<br />
# and set ‘do not load’ flag<br />
$file =~ s/.*[\\\/]//; <br />
$nload = 1;<br />
}else{<br />
# otherwise - create a temporary file name<br />
$tmpfile = "$tmp$dbid.$k.txt";<br />
# unset ‘do not load’ flag<br />
$nload = 0;<br />
}<br />
# load attachment from record into temporary file<br />
if( $nload || $attachment->Load($tmpfile) ){<br />
# open the attachment file<br />
open(TMPFILE, $tmpfile) or die "Cannot open file '$tmpfile'\n";<br />
# set file handle to binary mode<br />
binmode TMPFILE;<br />
# unset record delimiter<br />
local $/ = undef;<br />
# encode content of the file with Base64 encoding<br />
my $content = MIME::Base64::encode_base64(<TMPFILE>);<br />
# close the file<br />
close(TMPFILE);<br />
# and delete it, if it was a temporary file<br />
# created to save the attachment<br />
unlink($tmpfile) unless $nload;<br />
<br />
# add header and encoded attachment to the message<br />
$result .= "<br />
--$boundary<br />
Content-type: application/octet-stream<br />
Content-transfer-encoding: base64<br />
Content-disposition: attachment; filename=$file<br />
<br />
$content\n";<br />
}<br />
}<br />
}<br />
}<br />
# return encoded attachment<br />
return $result;<br />
</source><br />
|}<br />
<br />
<br /> Email_Notification_Rule fields:<br /><br />
<br />
{| width="100%" border="1" cellspacing="2" cellpadding="2"<br />
! width="20%" valign="top" | Form Field Name<br /> (CQ field name)<br /><br />
! valign="top" | Value<br /><br />
|-<br />
| width="20%" valign="top" | Name<br /> (name)<br /><br />
| valign="top" | Sample notification with attachments<br /><br />
|-<br />
| width="20%" valign="top" | Record Type<br /> (Entity_Def)<br /><br />
| valign="top" | Defect<br /><br />
|-<br />
| width="20%" valign="top" | Header Add-in<br /> (Msg_Header)<br /><br />
| valign="top" | <source lang="text">IF( RT_HasAttachments(), "MIME-Version: 1.0<br />
Content-type: multipart/mixed;<br />
boundary=\"Boundary_\($dbid)\"")</source><br />
|-<br />
| valign="top" | To<br /> (Msg_To_Users)<br /><br />
| valign="top" | '''$Submitter.email'''<br /><br />
|-<br />
| valign="top" | Subject<br /> (Msg_Subject)<br /><br />
| valign="top" | Defect ''''$ID'''' has been '''${state}'''.<br /><br />
|-<br />
| valign="top" | Body<br /> (Msg_Body)<br /><br />
| valign="top" | <source lang="text">IF( RT_HasAttachments(), "--Boundary_\($dbid)<br />
Content-type: text/plain; charset=us-ascii")<br />
<br />
Defect $ID<br />
Headline: $Headline<br />
Description: $Description<br />
<br />
RT_InsertAttachments() </source><br /><br /><br />
|}<br />
<br />
<br />
<br /><br /><br />
<br />
<br />
== '''Sending Consolidated Queries or Reports Using Timed Notification''' ==<br />
Timed notification was created to trigger alerts for individual records, but can it be used to send consolidated reports? <br />
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.<br />
Another way would be to create scheduled notification to run some queries (or reports) and send results to the users.<br />
First of all, I would like to create new record type, scheduled_queries, that might look like this<br />
<br />
{| width="100%" border="1" cellspacing="2" cellpadding="2"<br />
! width="20%" valign="top" | Field Name<br />
! width="20%" valign="top" | Field Type<br />
! valign="top" | Description<br />
|-<br />
| width="20%" valign="top" | '''Name'''<br />
| valign="top" | SHORT_STRING<br />
| valign="top" | unique identifier of the scheduled query<br />
|-<br />
| width="20%" valign="top" | '''Frequency'''<br />
| valign="top" | SHORT_STRING<br />
| valign="top" | choice list: daily, weekly, monthly, etc<br />
|-<br />
| width="20%" valign="top" | '''Active'''<br />
| valign="top" | INT<br />
| valign="top" | active/inactive 1/0 checkbox to deactivate entry without removing it from the database<br />
|-<br />
| width="20%" valign="top" | '''Path'''<br />
| valign="top" | MULTILINE_STRING<br />
| valign="top" | path to the query in the workspace. Multiline type is preferred to avoid 254 symbols limitation<br />
|}<br />
<br />
<br /><br />
After creating the record type, applying Email Notification package to the record, and upgrading user database, you can configure timed notifications for the new record type. The scope can include all active records of the new record type. No condition is required. The following user-defined function can be used to execute query and extract query result in the form of HTML table (we can call it "RETURN_QUERY_RESULTS_AS_HTML_TABLE"):<br />
{| width="100%" border="1" cellspacing="2" cellpadding="2"<br />
! width="20%" valign="top" | Name<br /><br />
! valign="top" | nm_value<br /><br />
|-<br />
| width="20%" valign="top" | RETURN_QUERY_RESULTS_AS_HTML_TABLE<br /><br />
| valign="top" | <source lang="perl"><br />
my $query_path = shift;<br />
<br />
# change path to UNIX style<br />
$query_path =~ s/\\+/\//g;<br />
# resulting HTML table<br />
my $table = "<TABLE BORDER=\"1\" CELLPADDING=\"10\">\n";<br />
# query fields<br />
my @fields = ();<br />
# get workspace<br />
my $ws = $session->GetWorkSpace();<br />
# get query definition<br />
my $qdef = $ws->GetQueryDef($query_path);<br />
my $field_defs = $qdef->GetQueryFieldDefs();<br />
my $count = $field_defs->Count();<br />
for( my $i = 1; $i < $count; $i++ ){<br />
my $field_def = $field_defs->Item($i);<br />
my $name = $field_def->GetLabel();<br />
my $type = $field_def->GetFieldType();<br />
push(@fields, { name => $name, type => $type });<br />
}<br />
<br />
# Create Table Header row<br />
$table .= '<TR>';<br />
foreach my $field (@fields){<br />
$table .= "<TH><b>$field->{name}</b></TH>";<br />
}<br />
$table .= "</TR>\n";<br />
<br />
# execute query<br />
my $resultset = $session->BuildResultSet($qdef);<br />
$resultset->Execute();<br />
<br />
# create data rows<br />
while( $resultset->MoveNext() == $CQPerlExt::CQ_SUCCESS ){<br />
$table .= '<TR>';<br />
for( my $i = 2; $i <= $count; $i++ ){<br />
my $value = $resultset->GetColumnValue($i);<br />
$table .= "<TD>$value</TD>";<br />
}<br />
$table .= "</TR>\n";<br />
}<br />
<br />
$table .= "</TABLE>\n";<br />
#return HTML table<br />
$@ = '';<br />
return $table;</source><br />
|}<br />
<br />
<br /><br />
Then we can use it in the timed notification rule body field, something like:<br />
{| width="100%" border="1" cellspacing="2" cellpadding="2"<br />
! width="20%" valign="top" | Form Field Name<br /> (CQ field name)<br /><br />
! valign="top" | Value<br /><br />
|-<br />
| width="20%" valign="top" | Header Add-in<br /> (Msg_Header)<br /><br />
| valign="top" | <source lang="text">Content-type: text/plain; charset=us-ascii</source><br />
|-<br />
| valign="top" | Body<br /> (Msg_Body)<br /><br />
| valign="top" | <source lang="text"><br />
<HTML><BODY><br />
something you would like to to say about scheduled query $Name<br />
RETURN_QUERY_RESULTS_AS_HTML_TABLE($Path)<br />
</BODY></HTML><br />
</source><br /><br /><br />
|}<br />
<br />
Timed Notification triggers the rule, all query records are selected, query executed and formatted as HTML table, and email is sent to the users.<br />
From that moment, it is easy to maintain: you can add new scheduled queries just by submitting new records of the "scheduled queries" record type and specifying new query path, and you can update content of the emails by editing queries in the workspace.<br />
<br />
<br /><br />
<br />
<br />
[[Category:Rational]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=Email_Notification_1.6_Release_Notes&diff=241Email Notification 1.6 Release Notes2013-02-01T14:44:05Z<p>Paul: </p>
<hr />
<div><big>'''Email Notification Package 1.5'''</big><br />
<big>'''Release Notes'''</big><br />
<br />
<br />
== Enhancements ==<br />
<br />
=== Support for Non-ASCII code pages ===<br />
Safe support of non-ascii code pages was added, with few limitations.<br />
<br />
==== Using non-ascii field names ====<br />
Currently, the parser does not provide full support non-ascii characters in field names using variable-like notation. For instance, the following field name would not be recognized: '''${моё_самое_любимое_имя}'''. One of the possible workarounds is to use '''GetFieldValue''' function to access such fields in email notification rules. For instance, in my example, I could use the following syntax: '''GetFieldValue('моё_самое_любимое_имя')'''<br />
<br />
==== Using non-ascii characters in message envelope ====<br />
Using non-ascii characters email envelope is permitted. Nevertheless, you might hit some limitations in your environment. Please check the following page for details: [[Email_Envelope_and_UTF-8 | Non-ASCII Characters in Email]].<br />
<br />
<br /><br />
<br />
== Prerequisites ==<br />
=== ClearQuest client version ===<br />
The package can be used with ClearQuest 7.0.0 or later. Earlier versions are supported in version 1.5 only.<br />
<br />
<br /><br />
<br />
== Other Notes ==<br />
=== Supplementary scripts ===<br />
Supplementary script, such as Delivery Script for Queue delivery mode and Timed Notification script for reminders, need to be updated in order to support non-ascii databases. New versions are available for download from [http://store.cqadmin.com/index.php/clearquest.html CQAdmin store].<br />
<br />
<br />
== Read More ==<br />
* [[Email_Notification_1.5_Release_Notes | Email Notification Package Release 1.5 Notes]]<br />
* [[ClearQuest_Email_Notification_Package | ClearQuest Email Notification Package]]<br />
* [[Package_configuration | Package configuration guide]]<br />
* [[ClearQuest_Email_Notification_Package_FAQ | Frequently Asked Questions ]]<br />
* [[Notification_Examples | Examples]]<br />
<br />
<br />
== Downloads ==<br />
[http://cqadmin.org/wiki/Download Download Package]<br />
<br />
<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=Email_Envelope_and_UTF-8&diff=240Email Envelope and UTF-82013-02-01T14:43:41Z<p>Paul: </p>
<hr />
<div><big>'''Support of National Charsets'''</big><br />
<br />
== International Characters in Email Messages ==<br />
Most of the modern email clients support national character in the email body. Encoding can be specified in the message envelope using '''Content-Type''' header. For instance, the following line added to the message header would inform email client that email body should be treated as HTML using UTF-8 character set.<br />
Content-Type: text/html; charset=utf-8<br />
<br />
Nevertheless, what do we suppose to do with international characters in the message envelope, such as email subject or "From" email address? Depending on your environment, there are few options.<br />
<br />
=== Transfer unicode characters in UTF-8 ===<br />
While it was not originally supported in SMTP protocol, using UTF-8 encoding in message envelopes became standard de facto, and eventually was documented in RFCs extending SMTP protocol. <br />
In most of the environments, and for most of the modern email clients it is safe to assume that UTF-8 content can be transferred as-is, and it is default behavior for the Email Notification package. Nevertheless, you still need to specify character set using '''Content-Type''' header as described above.<br />
<br />
=== Transcoding unicode characters ===<br />
In some rare cases when email client or email server cannot handle UTF-8 encoded characters in the message envelope, a workaround documented in the [http://tools.ietf.org/html/rfc2047|RFC 2047] can be used.<br />
The following is an example of user-defined function that can be used to encode UTF-8 strings using Base64 encoding and presenting it in the format specified in the RFC.<br />
<br /><br />
{| width="100%" border="1" cellspacing="2" cellpadding="2"<br />
! width="20%" valign="top" | Name<br /><br />
! valign="top" | nm_value<br /><br />
|-<br />
| width="20%" valign="top" | RT_Encode_Envelope<br /><br />
| valign="top" | <source lang="perl">my $string = shift;<br />
<br />
require utf8;<br />
require MIME::Base64;<br />
<br />
utf8::encode($string);<br />
$string = MIME::Base64::encode($string);<br />
<br />
return "=?UTF-8?B?$string?=";<br />
</source><br />
|}<br />
<br /><br />
When udb_property record is submitted, this user-defined function can be used to safely encode envelope fields that can contain unicode characters, for instance message subject:<br />
RT_Encode_Envelope("Defect $ID - $headline")<br />
<br />
<br /><br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paulhttps://cqadmin.org/w/index.php?title=ClearQuest_Email_Subscription&diff=239ClearQuest Email Subscription2013-02-01T14:42:30Z<p>Paul: </p>
<hr />
<div><big>'''ClearQuest Email Subscription'''</big><br />
<br />
You can allow users to manage their email notification rules subscription preferences. This functionality is delivered with optional EmailSubscription package. It can be used as-is, enhanced, or taken as an example to implement your own, more sophisticated end-user subscription solution.<br />
For example, you have constant request from users to be notified about new defects. In order to avoid excessive administrative task, you can open Email Notification rule for self-subscription. <br />
<br />
<br />
=== Email Notification Rule ===<br />
In our example, Email notification rule record would trigger a notification when new defect is created, by "Submit" action. We can either leave recipients list empty, or specify emails where the notification would be sent regardless of subscription. <br />
<br />
<br />
=== Create Email Subscription Record ===<br />
When Email Notification Rule exists, it can be opened for end-users self-subscription by creating Email Subscription record. You can give the record descriptive name, for example, "New Defects Subscription" and specify email notification rule. When record is committed, '''ES_GetSubscribersEmails()''' function will be added in the '''To:''' field of Email Notification Rule. You can update Email Notification Rule to move ES_GetSubscribersEmails() to CC or BCC fields if necessary.<br />
<br />
End users can manage their subscription by using '''Subscribe_Me''' or '''Unsubscribe_Me''' actions on the correspondent Email_Subscription record.<br />
<br />
More than one Notification Rule can be associated with Email Subscription record.<br />
<br />
In multisited environment, Email Subscription record needs to be created for each site where subscription is enabled: end users would be able to update subscription records that are mastered on their local site only.<br />
<br />
<br />
[[ClearQuest_Email_Notification_Package | Back to the package page]]<br />
<br />
<br />
[[Category:Rational]] [[Category:ClearQuest]] [[Category:Email_Notification_Package]]</div>Paul