Notification - the start of identity's contract
The LRT ContractStartNotificationTask can sends an email notification to holders of a specified role, manager, owner of starting contract. The recipients of the notification can be modified in the LRT setup and the notification template can be modified as well.
There are three different notifications this LRT can send:
notification sent a specified number of days before the start of identity's contract
notification sent the day that identity's contract starts
notification sent a specific number of days after the start of identity's contract
Each notification can use a different notification template (and must use a different topic).
Template
You can create your own template by modifying the stubs. You have these objects available:
userIdentity - full IdmIdentityDto
user - full name as String
department - department from tree node as String
manager - full IdmIdentityDto of user's manager
identityUrl -
URL to user's dashboard
identityEav - user's EAV as list of IdmFormInstanceDto
identityEavMap - user's EAV as Map of name of EAV and it's value as String
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
rolesDirectNames - list of directly assigned user's roles as names
rolesAutoNames - list of automaticly assigned user's roles as names
accounts - list of users accounts on end system
daysBefore - number of days which is set in configuration of LRT
ppvStart - start of contract as String
Configuration of LRT
The LRT can be configred in multiple ways, so it can be used for example
Notification before some user will start working
In the day when the user is starting as welcome email
Number of days after the user starded so the manager can check his roles
Notes
Behavior for module version < 3.5.0
The task sends notifications exactly according to the number of days before/after the start of identity's contract. Therefore, the task must be scheduled to run every day. Also, the contracts must be created in IdM soon enough. If a new contract was created and its start was already set to e.g. a week ago, then the notification e.g. 3 days before the start of the contract would not be sent. The same holds for filtering by the accounts on systems - if a user doesn't have an account on the day of the start of the contract, then the notification wouldn't be sent that day and never afterwards.
Behaviour for >= 3.5.0
For all use cases below the notification will be send
The notification is set to "number of days before start" = 3 and runs every day after HR synchronization
Contract A starts on 1.4. and it exists in IdM for several weeks.
Contract B starts on 1.4., but it's created in IdM on 31.3.
Contract C starts on 1.4., but it's created in IdM on 2.4.
All three contracts comply with the additional filters of the notification since their beginning.
Contract D starts on 1.4., it exists in IdM long before that, but it complies with the additional filter later (e.g.: System=AD and the AD account for the user is not created until 5.4.)
First run will process all valid contracts, be carefull with the first run
New LRT ContractStartNotificationWithLookBackTask
Extrass version 4.8.0 you need IdM version 13.1.1 and 5.2.0 you need IdM 14.2.0 version. Extras contains recreated LRT ContractStartNotificationTask.
This new task send notifications to users with a specified role and optionally their contract manager or owner. ContractStartNotificationTask have same variables like this new task and same behaviour like it is described above. But different handling of historic contracts.
The notification will inform them of their upcoming start date, which is a specified number of days away.
In initial run notifications will only be sent for contracts with a start date exact as specified (today + daysBefore).
In subsequent runs notifications will be sent for all contracts with start date less than or equal to today + datsBefore that have not yet been notified and are active. This ensures coverage for contracts created with past start dates or contracts that were missed due to task outages.
Swithching old LRT with new LRT. You need to replace the scheduled task ContractStartNotificationTask with the scheduled task ContractStartNotificationWithLookBackTask, using the same parameters. Make sure not to do this on the same day the original task was already executed, to prevent duplicate notifications from being sent.