Access Certification Notifications

Last modified 18 Aug 2025 13:29 +02:00
Table of Contents

This page describes how midPoint sends email alerts at key moments during certification campaigns, such as when a campaign starts, when it is about to close, or as reminders to reviewers who have not responded yet.

This page also demonstrates how midPoint uses notificationConfiguration blocks for certification notifications, and provides examples of how to define notification subject, body, and recipients.

This helps administrators set up automated communications tailored for certification lifecycle events.

Available notifications

Certification module provides the following notifications:

Event Default recipient(s) Comment

Campaign start

campaign owner

Emitted when stage 1 is started. (Along with campaign stage start.)

Campaign stage start

campaign owner

Sent when a new review or remediation stage is opened.

Campaign review stage end approaching

campaign owner

Sent when a deadline for a review stage is approaching, i.e. X hours before the deadline. X is a number set by the notifyBeforeDeadline parameter. It is interpreted as a number of hours. This parameter is multi-valued, so a notification can be sent e.g. 48 and 6 hours before the deadline occurs.

Campaign review stage end

campaign owner

Sent when a review stage is closed.

Campaign end

campaign owner

Sent when a campaign as such is closed. (Not if it is deleted before being actually closed!)

Review request

reviewer

Emitted when a review is requested for a set of cases. (Currently, this is done at the same time as campaign review stage start event is created. This means that when a campaign stage is started, one notification is sent to the campaign owner and one to each of the reviewers.)

Review deadline approaching

reviewer

Planned events (i.e. not implemented yet):

Event Default recipient(s) Comment

Case final decision

campaign owner and perhaps case owner

This event is generated when a certification case is decided, i.e. when we do not expect any changes in the state of this case as part of the approval processes. (Either when it is finally rejected or when the last stage is closed.)

Case remediation

campaign owner and perhaps case owner

This event is generated when a certification case is remedied.

You can customize the following parts of certification notifications:

  • Recipients - This is done by using the recipientExpression element in which you can define other recipients. The default recipients for individual events are listed above.

  • Message subject

  • Message body

Examples

You can use the following system configuration object snippet as a template to configure certification notifications:

<notificationConfiguration>
    <handler>
        <simpleReviewerNotifier>
            <transport>mail</transport>
        </simpleReviewerNotifier>
        <simpleCampaignNotifier>
            <transport>mail</transport>
        </simpleCampaignNotifier>
        <simpleCampaignStageNotifier>
            <transport>mail</transport>
        </simpleCampaignStageNotifier>
    </handler>
    <mail>
        <server>
            <host>smtp.gmail.com</host>
            <port>587</port>
            <username>...</username>
            <password>...</password>
            <transportSecurity>starttlsEnabled</transportSecurity>
         </server>
         <redirectToFile>d:\midpoint\home\mail-notifications.txt</redirectToFile>		<!-- just for debugging -->
      </mail>
</notificationConfiguration>

In the following example, we create a certification definition "Test" with two stages:

<accessCertificationDefinition xmlns="http://midpoint.evolveum.com/xml/ns/public/common/common-3"
                               xmlns:c="http://midpoint.evolveum.com/xml/ns/public/common/common-3"
                               xmlns:q="http://prism.evolveum.com/xml/ns/public/query-3">
   <name>Test</name>
   <description>test certification</description>
   <handlerUri>http://midpoint.evolveum.com/xml/ns/public/certification/handlers-3#direct-assignment</handlerUri>
   <scopeDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                    xsi:type="c:AccessCertificationAssignmentReviewScopeType">
      <objectType>UserType</objectType>
      <includeAssignments>true</includeAssignments>
      <includeInducements>false</includeInducements>
      <includeResources>true</includeResources>
      <includeOrgs>true</includeOrgs>
      <enabledItemsOnly>true</enabledItemsOnly>
   </scopeDefinition>
   <ownerRef oid="00000000-0000-0000-0000-000000000002" type="c:UserType"><!-- administrator --></ownerRef>
   <remediationDefinition>
      <style>automated</style>
   </remediationDefinition>
   <stageDefinition>
      <number>1</number>
      <name>Stage 1</name>
      <duration>P3D</duration> <!-- 3 days -->
      <notifyBeforeDeadline>6</notifyBeforeDeadline>
      <notifyOnlyWhenNoDecision>false</notifyOnlyWhenNoDecision>
      <reviewerSpecification>
         <defaultReviewerRef oid="00000000-0000-0000-0000-000000000002" type="c:UserType"><!-- administrator --></defaultReviewerRef>
      </reviewerSpecification>
   </stageDefinition>
   <stageDefinition>
      <number>2</number>
      <name>Stage 2</name>
      <duration>P5D</duration> <!-- 5 days -->
      <notifyBeforeDeadline>6</notifyBeforeDeadline>
      <notifyOnlyWhenNoDecision>true</notifyOnlyWhenNoDecision>
      <reviewerSpecification>
         <defaultReviewerRef oid="75f2806d-e31b-40c9-8133-85ed4d9e6252" type="c:UserType"><!-- boss1 --></defaultReviewerRef>
      </reviewerSpecification>
   </stageDefinition>
</accessCertificationDefinition>

Campaign start

When a campaign starts, three email notifications are sent:

Campaign started notification

To: campaign owner (i.e. administrator)
Subject: Campaign Test 1 started

Campaign Test 1 (oid c8df2447-4f03-4d9c-94a6-2452b5ded4aa) was STARTED.

Time: Wed Feb 03 19:24:05 CET 2016
Requester: administrator (midPoint Administrator)
Operation status: SUCCESS

Current state: In review stage 1/2 (Stage 1)

Number of cases:       8
Marked as ACCEPT:      0
Marked as REVOKE:      0 (remedied: 0)
Marked as REDUCE:      0 (remedied: 0)
Marked as NOT DECIDED: 0
Marked as DELEGATE:    0
No response:           8

Requester: midPoint Administrator (administrator)
Channel: http://midpoint.evolveum.com/xml/ns/public/gui/channels-3#user

Campaign stage started notification

To: campaign owner (i.e. administrator)
Subject: Campaign Test 1 stage 1/2 started

A certification campaign stage has been started.

Campaign: Test 1 (oid c8df2447-4f03-4d9c-94a6-2452b5ded4aa)
State: In review stage 1/2 (Stage 1)

Time: Wed Feb 03 19:24:05 CET 2016

Stage start time: Wed Feb 03 19:24:04 CET 2016
Stage end time: Sat Feb 06 23:59:59 CET 2016

Requester: administrator (midPoint Administrator)
Operation status: SUCCESS

Number of cases:       8
Marked as ACCEPT:      0
Marked as REVOKE:      0 (remedied: 0)
Marked as REDUCE:      0 (remedied: 0)
Marked as NOT DECIDED: 0
Marked as DELEGATE:    0
No response:           8

Requester: midPoint Administrator (administrator)
Channel: http://midpoint.evolveum.com/xml/ns/public/gui/channels-3#user

Review requested notification

To: reviewer (i.e. administrator)
Subject: Your review is requested in campaign Test 1

You have been requested to provide a review in a certification campaign.

Campaign: Test 1 (oid c8df2447-4f03-4d9c-94a6-2452b5ded4aa)
State: In review stage 1/2 (Stage 1)

Stage start time: Wed Feb 03 19:24:04 CET 2016
Stage end time: Sat Feb 06 23:59:59 CET 2016

The stage ends in 3 days 4 hours 35 minutes 54 seconds

There are 8 cases assigned to you. Out of them, 8 have no response from you yet.

Campaign stage end is approaching

Six hours before a stage ends, the following notifications are sent:

Campaign review stage end approaching

To: campaign owner (i.e. administrator)
Subject: Campaign Test 1 stage 1/2 about to be closed

A certification campaign stage is about to be closed.

Campaign: Test 1 (oid c8df2447-4f03-4d9c-94a6-2452b5ded4aa)
State: In review stage 1/2 (Stage 1)

Time: ....

Stage start time: Wed Feb 03 19:24:04 CET 2016
Stage end time: Sat Feb 06 23:59:59 CET 2016

Stage ends in 0 days 5 hours 59 minutes 8 seconds

Number of cases:       8
Marked as ACCEPT:      3
Marked as REVOKE:      0 (remedied: 0)
Marked as REDUCE:      0 (remedied: 0)
Marked as NOT DECIDED: 0
Marked as DELEGATE:    0
No response:           5

Requester: midPoint Administrator (administrator)
Channel: null

Review deadline approaching

To: reviewer (i.e. administrator)
Subject: Deadline for your review in campaign Test 1 is approaching

You have been requested to provide a review in a certification campaign.

Campaign: Test 1 (oid c8df2447-4f03-4d9c-94a6-2452b5ded4aa)
State: In review stage 1/2 (Stage 1)

Stage start time: Wed Feb 03 19:24:04 CET 2016
Stage end time: Sat Feb 06 23:59:59 CET 2016

This is to notify you that the stage ends in 0 days 5 hours 59 minutes 8 seconds

There are 8 cases assigned to you. Out of them, 5 have no response from you yet.

Campaign stage is closed

Campaign stages can be closed automatically or manually. In this example, when a stage is manually closed, the following notification is sent:

To: campaign owner (i.e. administrator)
Subject: Campaign Test 1 stage 1/2 closed

A certification campaign stage has been closed.

Campaign: Test 1 (oid c8df2447-4f03-4d9c-94a6-2452b5ded4aa)
State: Done review stage 1/2 (Stage 1)

Time: Wed Feb 03 21:35:32 CET 2016

Stage start time: Wed Feb 03 19:24:04 CET 2016
Stage end time: Sat Feb 06 23:59:59 CET 2016

Requester: administrator (midPoint Administrator)
Operation status: SUCCESS

Number of cases:       8
Marked as ACCEPT:      3
Marked as REVOKE:      0 (remedied: 0)
Marked as REDUCE:      0 (remedied: 0)
Marked as NOT DECIDED: 0
Marked as DELEGATE:    0
No response:           5

Requester: midPoint Administrator (administrator)
Channel: http://midpoint.evolveum.com/xml/ns/public/gui/channels-3#user

Second stage is opened and closed

You can use definitions similar to the previous example to define notifications for subsequent stages.

Remediation is started

When a remediation is started, the following notification is sent:

To: campaign owner (i.e. administrator)
Subject: Campaign Test 1 remediation stage started

A certification campaign stage has been started.

Campaign: Test 1 (oid c8df2447-4f03-4d9c-94a6-2452b5ded4aa)
State: Remediation in progress

Time: Wed Feb 03 21:49:04 CET 2016

Requester: administrator (midPoint Administrator)
Operation status: SUCCESS

Number of cases:       8
Marked as ACCEPT:      1
Marked as REVOKE:      1 (remedied: 0)
Marked as REDUCE:      0 (remedied: 0)
Marked as NOT DECIDED: 0
Marked as DELEGATE:    0
No response:           6

Requester: midPoint Administrator (administrator)
Channel: http://midpoint.evolveum.com/xml/ns/public/gui/channels-3#user

Campaign is closed

When a campaign is closed, the following notification is produced:

To: campaign owner (i.e. administrator)
Subject: Campaign Test 1 closed

Campaign Test 1 (oid c8df2447-4f03-4d9c-94a6-2452b5ded4aa) was CLOSED.

Time: Wed Feb 03 21:49:04 CET 2016
Requester: administrator (midPoint Administrator)
Operation status: SUCCESS

Current state: Closed

Number of cases:       8
Marked as ACCEPT:      1
Marked as REVOKE:      1 (remedied: 1)
Marked as REDUCE:      0 (remedied: 0)
Marked as NOT DECIDED: 0
Marked as DELEGATE:    0
No response:           6

Requester: midPoint Administrator (administrator)
Channel: null
Was this page helpful?
YES NO
Thanks for your feedback