Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
tutorial:adm:notification_-_identity_s_last_contract_is_ending [2019/10/30 13:44] cirkval [Set up the Long runnig task (LRT)] |
tutorial:adm:notification_-_identity_s_last_contract_is_ending [2021/11/09 12:51] kucerar new params |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Notification - the end of identity' | ====== Notification - the end of identity' | ||
- | <note tip>This notification is a part of the [[devel: | + | <note tip>This notification is a part of the [[:devel: |
The LRT LastContractEndNotificationTask sends an email notification to holders of a specified role and optionally the manager of a contract that a user's last contract is ending, i. e., the user is leaving. The recipients of the notification can be modified in the LRT setup and the notification template can be modified as well. | The LRT LastContractEndNotificationTask sends an email notification to holders of a specified role and optionally the manager of a contract that a user's last contract is ending, i. e., the user is leaving. The recipients of the notification can be modified in the LRT setup and the notification template can be modified as well. | ||
There are two different notifications this LRT can send: | There are two different notifications this LRT can send: | ||
+ | |||
- notification sent a specified number of days before the end of identity' | - notification sent a specified number of days before the end of identity' | ||
- notification sent the day that identity' | - notification sent the day that identity' | ||
+ | |||
Each notification can use a different notification template (and must use a different topic). | Each notification can use a different notification template (and must use a different topic). | ||
Line 16: | Line 18: | ||
The visual part of the notification can be configured since standard templates are used. Extras comes with two basic stub templates which can be used here. | The visual part of the notification can be configured since standard templates are used. Extras comes with two basic stub templates which can be used here. | ||
- | To set it up, go the left panel, choose Notifications> | + | To set it up, go the left panel, choose Notifications> |
- | {{ : | + | {{ .: |
If you don't see them, you will have to create them from the xml files with corresponding names. They can easily be found [[https:// | If you don't see them, you will have to create them from the xml files with corresponding names. They can easily be found [[https:// | ||
- | {{ : | + | {{ .: |
- | {{ : | + | {{ .: |
You can create your own template by modifying the stubs. You have these objects available: | You can create your own template by modifying the stubs. You have these objects available: | ||
+ | |||
* user's full name (first name, last name, login, e. g., "Petra Šťastná, pstasna", | * user's full name (first name, last name, login, e. g., "Petra Šťastná, pstasna", | ||
* user's department from tree node (String only) | * user's department from tree node (String only) | ||
* the date of the end of the user's contract (String only) | * the date of the end of the user's contract (String only) | ||
* user's manager (full IdmIdentityDto) | * user's manager (full IdmIdentityDto) | ||
+ | * user (full IdmIdentityDto), | ||
+ | |||
+ | since version 3.2.3 | ||
+ | |||
+ | * userIdentity - full IdmIdentityDto | ||
+ | * user - full name as String | ||
+ | * department - department from tree node as String | ||
+ | * ppvEnd - date of contract end as String | ||
+ | * manager - full IdmIdentityDto of user's manager | ||
+ | * identityUrl - URL to user's dashboard | ||
+ | * identityEav - user's EAV as list of IdmFormInstanceDto | ||
+ | * identityContract - user's contract as IdmIdentitycontractDto | ||
+ | * rolesAllNames - list of all user's roles as names, sorted alphabeticaly | ||
+ | * rolesAllDto - list of all user's roles as IdmRoleDto | ||
+ | * rolesDirectDto - list of directly assigned user's roles as IdmRoleDto | ||
+ | * rolesAutoDto - list of automaticly assigned user's roles as IdmRoleDto | ||
===== Configure topics ===== | ===== Configure topics ===== | ||
- | Next, we have to define the topics for the notification. In the left panel, click Notifications> | + | Next, we have to define the topics for the notification. In the left panel, click Notifications> |
- | {{ : | + | {{ .: |
If you don't find them, click the green button Add and fill them out as shown below: | If you don't find them, click the green button Add and fill them out as shown below: | ||
- | {{ : | + | {{ .: |
- | {{ : | + | |
You can specify additional recipients of the notification in the topic description. | You can specify additional recipients of the notification in the topic description. | ||
Line 49: | Line 67: | ||
Finally, we can set up the LRT. In the left menu, go to Settings> | Finally, we can set up the LRT. In the left menu, go to Settings> | ||
- | {{ : | + | {{ .: |
- | You can specify how many days before the contract' | + | You can specify how many days before the contract' |
<note tip>The notification is sent x days before the end of the contract or sooner. This is useful if for some reason the LRT did not run one day, it will simply be sent the next day.</ | <note tip>The notification is sent x days before the end of the contract or sooner. This is useful if for some reason the LRT did not run one day, it will simply be sent the next day.</ | ||
Line 57: | Line 75: | ||
You can select the role that the recipients of the notification will have assigned. You can only select one so if you need multiple ones, you have define multiple LRTs. | You can select the role that the recipients of the notification will have assigned. You can only select one so if you need multiple ones, you have define multiple LRTs. | ||
- | And finally, you can check the box and select whether the user's manager | + | Since 3.2.0, you can also select whether |
- | ===== Run the LRT ===== | + | And finally, you can check the box and select whether the user's manager is to be notified as well. Only one manager will receive the notification! |
+ | |||
+ | ===== Set up the Long running task (LRT) with technical identities ===== | ||
+ | |||
+ | <note important> | ||
+ | |||
+ | Finally, we can set up the LRT. In the left menu, go to Settings> | ||
+ | |||
+ | {{ .: | ||
+ | |||
+ | You can specify how many days before the contract' | ||
+ | |||
+ | <note tip>The notification is sent x days before the end of the contract or sooner. This is useful if for some reason the LRT did not run one day, it will simply be sent the next day.</ | ||
+ | |||
+ | * You can select the role that the recipients of the notification will have assigned. You can only select one so if you need multiple ones, you have defined multiple LRTs. * You can also check the box and select whether the user's manager is to be notified as well. Only one manager will receive the notification! | ||
+ | |||
+ | **There is also support for technical identities. There are two options: | ||
+ | |||
+ | * If you provide prefix, then the task will look for username with this prefix (for identity whose contract is going to end). If some are found, then it sends the notification. * If you select a role in "Code of the role used for technical identities" | ||
+ | |||
+ | <note important> | ||
+ | |||
+ | The last option (Send invalid contracts) is if you want to send only valid users or all. The reason for putting this option to this setting is this case: Task did not run a couple of days and some users are already not valid. So it admin can decide if those identities will be sent too. | ||
+ | |||
+ | ===== Set up the Long running task (LRT) to notify owner of the contract ===== | ||
+ | |||
+ | <note important> | ||
+ | |||
+ | IE. you can use this setup for sending extra notification directly to identity via sms (selected in notification topic). | ||
+ | |||
+ | {{ .: | ||
+ | |||
+ | You check " | ||
+ | |||
+ | Notification is set in the left panel, click Notifications> | ||
+ | |||
+ | {{ .: | ||
+ | |||
+ | Notification is set for sending via SMS channel. | ||
+ | |||
+ | ===== LRT setting from version 3.2.3 ===== | ||
+ | |||
+ | From version 3.2.3 there are additional options for this LRT. | ||
+ | |||
+ | * User type - You can select user type (projection). Only users of selected type will be processed. Leave it empty to process all users | ||
+ | * Account on system - If you want process only users with account on some system you can select one. Leave empty to process all users | ||
+ | * Tree node - Process users only in selected node (no recursion!) | ||
+ | |||
+ | {{ .: | ||
+ | |||
+ | ===== Run the long running task (LRT) ===== | ||
The last thing remaining is to run the LRT using the green arrow button. You can user CRON to plan when the LRT should be run. | The last thing remaining is to run the LRT using the green arrow button. You can user CRON to plan when the LRT should be run. | ||
- | <note important> | + | <note important> |
+ | |||
+ | <note important> | ||
- | <note important> |