This is an old revision of the document!
This extension allow to trigger notification when an expiration date is about to be reached.
iTop 2.3.0 or above
|2019-01-10||1.0.0||First official version|
Use the Standard installation process for this extension.
Once the new module has been installed, edit the configuration file config-itop.php and look for the following new section:
'combodo-notify-on-expiration' => array ( 'time' => '03:00', 'enabled' => true, 'debug' => false, ),
The following settings are available to configure the module:
|time||hour:minute||Time of the day, when the process should start.||03:00|
|enable||boolean||Should the process run?||true|
|debug||boolean||Should the CRON log be enrich with debug information?||false|
The Notification on Expiration is handled by the service cron.php once a day. Make sure this one is scheduled to run on your system. More information in the chapter about Background tasks.
To check the status of this service, use the command:
php webservices/cron.php --auth_user=admin --auth_pwd=admin --status_only=1
Example: Setup a notification 20 days before a Licence expires
The extension brings a new Menu entry Expiration rules
To create a new one:
Activeto enable the cron to execute this Expiration rule in the Background task.
Date to check=end_date and
Term of notice=20 the resulting OQL will be:
SELECT Licence WHERE end_date = DATE_ADD(CURRENT_DATE(), INTERVAL 20 DAY)
Expiration Ruleas you want, for Licence, Customer Contract and even multiple for the same class but with a different
term of notice
Create a Trigger using the extension added: Trigger (on expiration)
filter it further, with an OQL:
SELECT Licence WHERE perpetual='no'
Create a Notification, defining who should receive it and the body of the message
On top of the standard placeholders, this extension brings also:
|$rule->name$||The name of the Expiration rule which has trigger this notification|
|$rule->description$||The Description of the Expiration rule which has trigger this notification|
|$rule->term_of_notice$||The Term of notice in days defined in the Expiration rule which has trigger this notification|
Link the Notification to the above created Trigger.