This is an old revision of the document!


Status task - How to prepare the task

CzechIdMStatusNotificationTask is a task which checks some major areas of CzechIdM and then sends to users or others (via email).

This task is part of the module extras. You need to have this module.

1) Enable module extras

  • SettingsModules
  • Activate the module by clicking on the green button in the right side of the page in extras row.

2) Later in this tutorial, you will choose identities to notify. Make sure, that they have email filled out if you want them to be notified by email.

  • Usersselect user → fill the email column

3) Set up emails which will be notified too

  • Go to NotificationsConfiguration
  • Here find extras:status as topic

  • Edit in left (a sign of magnifying glass)
  • Add your emails to the Recipients field as shown in the picture and save

Now we are prepared, let's create the task.

1) Go to settingTask Scheduler → Scheduled tasks

2) As shown in the picture, click to the green Add button in the right corner of the screen.

3) Type in CzechIdMStatusNotificationTask and other attributes of the form will pop up.

4) Here is a quick reminder, what each of the attributes means.

  • Send provisioning status - check and send failed provisioning operations
  • Send contract status - check and send all new contracts
  • Send event status - check and send failed events
  • Send LRT status - check and send failed long-running tasks
  • Send sync status - check and send failed sync operations
  • Recipient identities - list of usernames of identities, to which notification will be sent - need to be divided by comma

5) Click save and then in the right of this row click Play button.

And it is done. Now you can check if you received the email.

Template of this task's notification has been modified in version 2.1.0 and in LTS version of module extras. You should redeploy notification template statusNotification.
If there are multiple errors during CzechIdMStatusNotificationTask, just the last one is send to notification template. The rest can be found in application log

In status notification there are information about state of processes in CzechIdM. In CzechIdM there are asynchronous processes on many places. Advantage is that users do not have to wait for events, which are executed on the background. But on the other side users does not know the result of processes. This notification contains state of some vital agendas.

  1. First of all there is provisioning status. This status is importatnt because of end systems. If some entity will be provisioned to end system and this process ends with failure, every other continuous provisioning to this system will be added to an queue. So it is important know, that some identity has not have failed provisioning and it's attributes are updated in end system.
  2. Some scheduled tasks are not that important, but all of them has its purpose, so it is better if all of them did their job. Scheduled tasks are used as synchroinzation of data from HR or recalculation of states of identities (throught the night) or for sending email like this notification.
  3. Events basically means asynchronous save process. In IdM almost every entity has asynchronnous save. So if during save process there is some failure, it means some data has been lost. So if someone or synchronization edited an entity and it failed, notification will tell you, you should check this agenda.
  4. In synchronization status part there is list of failed synchronizations by system. It only write if there is some failures and not how many. It could be for example mistake or incomplete HR data or some mistake in workflow.
  5. In the last part there is list of users, whoose state has been changed. So it is kinda report. It will show you who of the employees has left, who is new employee and changes of exclusion.

Example of notification:

  • by stloukalp