User Tools

Site Tools


extensions:combodo-notify-on-expiration

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
extensions:combodo-notify-on-expiration [2019/01/21 15:48]
vdumas
extensions:combodo-notify-on-expiration [2019/04/26 10:35] (current)
vdumas
Line 4: Line 4:
 description_wiki : Get a notification when a date is about to be reached description_wiki : Get a notification when a date is about to be reached
 index_hidden ​    : yes index_hidden ​    : yes
-version ​         : 1.0.0 +version ​         : 1.0.1 
-release_dt ​      : 2019-01-10+release_dt ​      : 2019-02-18
 itop-version-min : 2.3.0 itop-version-min : 2.3.0
-download_url ​    ​https://www.itophub.io/wiki/page?​id=extensions:​coming-soon+download_url ​ http://www.combodo.com/itop-extensions/
 code             : combodo-notify-on-expiration code             : combodo-notify-on-expiration
 state            : stable state            : stable
 product_hidden ​  : not-included product_hidden ​  : not-included
-module-lists_hidden : combodo-notify-on-expiration/​1.0.0+module-lists_hidden : combodo-notify-on-expiration/​1.0.1
 ---- ----
  
Line 19: Line 19:
 This extension allow to trigger notification when an expiration date is about to be reached. This extension allow to trigger notification when an expiration date is about to be reached.
  
-  * You can define various Expiration rules, for different usage. Targeted for **Contract & Licence** expiration, it can be used with any class having a date attribute. +  * You can define various Expiration rules, for different usage. Targeted for **Contract & License** expiration, it can be used with any class having a date attribute. 
-  * You can set multiple rules for the same class with different term of notice, for example one '3 months ahead' and another 'one month before'​ the deadline.+  * You can set multiple rules for the same class with different term of notice, for example one '3 months ahead' and another 'one month before'​ the deadline. You can even create a third one '5 days after' the deadline if you want.
  
   * Notification for a particular object reaching Expiration, unless configured differently,​ will occur only once.   * Notification for a particular object reaching Expiration, unless configured differently,​ will occur only once.
Line 37: Line 37:
  
 ^ Date ^ Version ^ Description ^ ^ Date ^ Version ^ Description ^
-|  2019-01-10 ​ |  1.0.0  | First official version | +|  2019-02-18 ​ |  1.0.1  | Fix missing menu and improve robustness on time format ​ | 
-| 2018-03-28 | 0.1.0 | First release |+|  2019-01-10 ​ |  1.0.0  | First official version ​- deprecated ​
 + 2018-03-28 ​  0.1.0  | First release |
  
 ===== Installation ===== ===== Installation =====
Line 61: Line 62:
 ^ Parameter ​ ^  Type  ^  Description ​ ^  Default Value  ^ ^ Parameter ​ ^  Type  ^  Description ​ ^  Default Value  ^
 | time | hour:​minute| Time of the day, when the process should start. | 03:00 | | time | hour:​minute| Time of the day, when the process should start. | 03:00 |
-enable ​| boolean | Should the process run? | true |+enabled ​| boolean | Should the process run? | true |
 | debug | boolean | Should the CRON log be enrich with debug information?​ | false | | debug | boolean | Should the CRON log be enrich with debug information?​ | false |
  
Line 75: Line 76:
 ===== Usage ===== ===== Usage =====
  
-Example: Setup a notification 20 days before a Licence ​expires+Example: Setup a notification 20 days before a License ​expires
   * Create a Expiration Rule   * Create a Expiration Rule
   * Create a Trigger   * Create a Trigger
Line 83: Line 84:
 ==== Expiration Rule ==== ==== Expiration Rule ====
  
-The extension brings a new Menu entry **Expiration rules** \\+The extension brings a new Menu entry **Expiration rules** ​in the "​Service Management"​ category ​\\
  
 To create a new one: To create a new one:
Line 92: Line 93:
 === Simple === === Simple ===
     * Define the **Date to check**, which must be the code of a date attribute, //not the label//.     * Define the **Date to check**, which must be the code of a date attribute, //not the label//.
-    * **Term of notice** is configurable and says when to trigger the notification,​ by specifying a number of days before the deadline, ​+    * **Term of notice** is configurable and says when to trigger the notification,​ by specifying a number of days **before** the deadline, ​
 {{ :​extensions:​expirationrulesimple.png?​nolink |}} {{ :​extensions:​expirationrulesimple.png?​nolink |}}
  
Line 102: Line 103:
 === Advanced === === Advanced ===
     * Define the **OQL scope** with an OQL query returning the objects on which to apply the trigger. //As soon as an OQL is entered, the advanced option is used, even if the simple one is also documented.//​     * Define the **OQL scope** with an OQL query returning the objects on which to apply the trigger. //As soon as an OQL is entered, the advanced option is used, even if the simple one is also documented.//​
 +    * With the advanced mode, you can trigger notification after a date, which is not possible in simple mode.
  
 {{ :​extensions:​expirationruledetails.png?​nolink |}} {{ :​extensions:​expirationruledetails.png?​nolink |}}
  
-<note tip>You can create as many ''​Expiration Rule''​ as you want, for Licence, Customer Contract and even multiple for the same class but with a different ''​term of notice''</​note>​+<note tip>You can create as many ''​Expiration Rule''​ as you want, for License, Customer Contract and even multiple for the same class but with a different ''​term of notice''</​note>​
  
 === Preview === === Preview ===
Line 140: Line 142:
 Link the Notification to the above created Trigger. Link the Notification to the above created Trigger.
  
 +===== Troubleshooting / Q&A =====
  
 +**Q: The sub-Menu ''​Expiration rules''​ does not appear under ''​Service Management''​ **\\
 +A: Also the root cause of this issue is not understood yet, there are many possibilities to create Expiration rules without that Menu. 
 +
 +   - Add to one of your Dashboards, a Dashlet Badge on class ''​ExpirationRule'':​ it provides a mean to create a new rule and list existing.
 +   - Use under Menu ''​Admin tools'',​ the sub-menu ''​Run queries'':​ ''​SELECT ExpirationRule''​ it should propose you a link to create a new one.
 +   - Use under Menu ''​Admin tools'',​ the sub-menu ''​Universal Search''​ and search for class ''​ExpirationRule'',​ it will list the existing rules and offer to create one with the ''​New''​ menu
extensions/combodo-notify-on-expiration.1548082126.txt.gz · Last modified: 2019/01/21 15:48 by vdumas

";