Notification Definition

Definition

Notification Definition allows to configure the Notification (content, recipients…) that will be sent by Memority.

Configuration

🎯

You can access the Notification configuration :

by clicking on "Notifications" → “Emails” or Notifications" → “SMS”
by clicking on "System" → "Configurations" → "Notification Service" and perform an import/export.

Global Properties

Domain	Code
Version and encoding : Each Email Definitions starts by announcing the version and the encoding.	XML <?xml version="1.0" encoding="UTF-8"?> <kit:DataSet xmlns:ctd="http://www.memority.com/citadel/1_0" xmlns:ctdcore="http://www.memority.com/citadel/core/1_0" xmlns:ctdtnt="http://www.memority.com/citadel/tnt/1_0" xmlns:kit="http://www.memority.com/toolkit/1_0" xmlns:notify="http://www.memority.com/toolkit/addons/notify/1_0" xmlns:rule="http://www.memority.com/toolkit/rule/1_0" xmlns:search="http://www.memority.com/toolkit/search-expression/1_0" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <notify:EmailNotificationDefinition id="citadel_password_set_email"> </notify:EmailNotificationDefinition> </kit:DataSet>
DataSet: Each Email Definitions starts by announcing the DataSet.
Notify

Domain

Code

Version and encoding : Each Email Definitions starts by announcing the version and the encoding.

XML

<?xml version="1.0" encoding="UTF-8"?>
<kit:DataSet xmlns:ctd="http://www.memority.com/citadel/1_0" 
xmlns:ctdcore="http://www.memority.com/citadel/core/1_0" 
xmlns:ctdtnt="http://www.memority.com/citadel/tnt/1_0" 
xmlns:kit="http://www.memority.com/toolkit/1_0" 
xmlns:notify="http://www.memority.com/toolkit/addons/notify/1_0" 
xmlns:rule="http://www.memority.com/toolkit/rule/1_0" 
xmlns:search="http://www.memority.com/toolkit/search-expression/1_0" 
xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<notify:EmailNotificationDefinition id="citadel_password_set_email">
</notify:EmailNotificationDefinition>
</kit:DataSet>

DataSet: Each Email Definitions starts by announcing the DataSet.

Notify

Notification Definition Properties - Common to Email & SMS

Property name	Type	Mandatory	Description	Values (default value in bold)
id	`String`	YES	The id is the unique identifier of the Notification. It is case sensitive and no special characters (except - or _) are allowed.	-
name	`String`	YES	The Notification name. The name may be different from the identifier. Must be at least 4 characters long.	-
defaultLanguage	`String`	NO	Used to define a default language
description	`String`	NO	Used to describe the Notification that will be configured.	-
eventType	`Enum`	YES	Allows to define a Notification type which corresponds to a specific business use case. Only one event type on each Notification.	All events types are listed below.
recipients	`List <String>`	YES	Allows to list all recipients.	-
sender	`String`	YES	Allows to determine who send the notification.	-
textBodyTemplateId	`String`	NO	Allows to provide a Notification Template Id for a text message
contents	`List <NotificationContent>`	YES	Allows to define different contents.	-

Recipients

Property name	Type	Mandatory	Description	Values (default value in bold)
recipient	`Enum`	YES	Allows to determine actors of the notification. The value can be an : email address - email only phone number - SMS only or a specific actor’s role (e.g. requester, system, identity…) - ALL Notifications	requester, system, beneficiary, identity, subject

Property name

Type

Mandatory

Description

Values (default value in bold)

recipient

Enum

YES

Allows to determine actors of the notification.

The value can be an :

email address - email only
phone number - SMS only
or a specific actor’s role (e.g. requester, system, identity…) - ALL Notifications

requester, system, beneficiary, identity, subject

Property name	Type	Mandatory	Description	Values (default value in bold)
content	`NotificationContent`	YES	Allows to define a specific content in French and/or in English.	-

Content

Each content will have the following configuration:

Property name	Type	Mandatory	Notification Type	Description	Values (default value in bold)
locale	`String`	YES	ALL Notifications	Allows to define the language of the email.	-
htmlBody	`String`	YES	email only	Allows to define the body of the email.	-
subject	`String`	YES	email only	Allows to define a subject for the email.	-
textBody	`String`	YES	ALL Notifications	Allows to define the text of the email.	-

Notification Definition Properties - Email

Property name	Type	Mandatory	Description	Values (default value in bold)
id	`String`	YES	The id is the unique identifier of the Notification. It is case sensitive and no special characters (except - or _) are allowed.	-
name	`String`	YES	The Notification name. The name may be different from the identifier. Must be at least 4 characters long.	-
defaultLanguage	`String`	NO	Used to define a default language
description	`String`	NO	Used to describe the Notification that will be configured.	-
eventType	`Enum`	YES	Allows to define a Notification type which corresponds to a specific business use case. Only one event type on each Notification.	All events types are listed below.
recipients	`List <String>`	YES	Allows to list all recipients.	-
sender	`String`	YES	Allows to determine who send the notification.	-
reply	`String`	NO	Allows to provide a reply email address.
textBodyTemplateId	`String`	NO	Allows to provide a Notification Template Id for a text message
htmlBodyTemplateId	`String`	NO	Allows to provide a Notification Template Id for an HTML message
attachments	`List <String>`	NO	Allows to add one or more attachments.	-
ccs	`List <String>`	NO	Allows to add one or more actors in copy.	-
ccis	`List <String>`	NO	Allows to add one or more actors in hidden copy.	-
contents	`List <NotificationContent>`	YES	Allows to define different contents.	-

Notification Definition Properties - SMS

Property name	Type	Mandatory	Description	Values (default value in bold)
id	`String`	YES	The id is the unique identifier of the Notification. It is case sensitive and no special characters (except - or _) are allowed.	-
name	`String`	YES	The Notification name. The name may be different from the identifier. Must be at least 4 characters long.	-
defaultLanguage	`String`	NO	Used to define a default language
description	`String`	NO	Used to describe the Notification that will be configured.	-
eventType	`Enum`	YES	Allows to define a Notification type which corresponds to a specific business use case. Only one event type on each Notification.	All events types are listed below.
recipients	`List <String>`	YES	Allows to list all recipients.	-
sender	`String`	YES	Allows to determine who send the notification.	-
textBodyTemplateId	`String`	NO	Allows to provide a Notification Template Id for a text message
contents	`List <NotificationContent>`	YES	Allows to define different contents.	-

Example

Email Notification Definition Example

XML

<notify:EmailNotificationDefinition id="notification_1">
	<name>notification to sent a new password</name>
	<description>Sent when a new password is set</description>
	<eventType>CITADEL_PASSWORD_SET</eventType>
	<recipients>
		<recipient>requester</recipient>
		<recipient>system</recipient>
		<recipient>beneficiary</recipient>
		<recipient>identity</recipient>
		<recipient>subject</recipient>
	</recipients>
	<sender>requester</sender>
	<attachments/>
	<ccs/>
	<ccis/>
	<contents>
		<content locale="en">
			<htmlBody><![CDATA[@@standard_salutations_txt@@<br><br> Your password is : <strong>{{ password }}</strong>]]></htmlBody>
            <subject>Password set</subject>
            <textBody><![CDATA[@@standard_salutations_txt@@
Your password is : {{ password }}]]></textBody>
         </content>
         <content locale="fr">
            <htmlBody><![CDATA[@@standard_salutations_txt@@<br><br> Votre mot de passe : <strong>{{ password }}</strong>]]></htmlBody>
            <subject>Initialisation du mot de passe</subject>
            <textBody><![CDATA[@@standard_salutations_txt@@
Votre mot de passe : {{ password }}]]></textBody>
         </content>
      </contents>
</notify:EmailNotificationDefinition>

SMS Notification Definition Example

XML

<notify:SmsNotificationDefinition id="sms-welcome">
      <name>SMS Welcome</name>
      <description>Sent upon creation of a new Identity, as a welcome message</description>
      <eventType>CITADEL_IDENTITY</eventType>
      <recipients>
         <recipient>identity</recipient>
      </recipients>
      <sender>MEMORITY.FR</sender>
      <contents>
         <content locale="fr">
            <textBody><![CDATA[Bienvenue à Acme!]]></textBody>
         </content>
         <content locale="en">
            <textBody><![CDATA[Welcome to Acme!]]></textBody>
         </content>
      </contents>
      <textBodyTemplateId>layout-text</textBodyTemplateId>
   </notify:SmsNotificationDefinition>

Notification Events Type

Objects

Objects Events Type

Notification Events Type	Description	Recipients	Senders	Available variables
CITADEL_IDENTITY_CREATION	When a new identity is created.	`requester, identity`	`system, requester`	OBJECT
CITADEL_IDENTITY_PATCH	When an identity is patched.	`requester, identity`	`system, requester`	OBJECT
CITADEL_IDENTITY_DELETE	When an identity is deleted.	`requester, identity`	`system, requester`	OBJECT
CITADEL_ORGANIZATION_CREATION	When a new organization is created.	`requester`	`system, requester`	OBJECT
CITADEL_ORGANIZATION_PATCH	When an organization is patched.	`requester`	`system, requester`	OBJECT
CITADEL_ORGANIZATION_DELETE	When an organization is deleted.	`requester`	`system, requester`	OBJECT
CITADEL_RESOURCE_CREATION	When a new resource is created.	`requester`	`system, requester`	OBJECT
CITADEL_RESOURCE_PATCH	When an resource is patched.	`requester`	`system, requester`	OBJECT
CITADEL_RESOURCE_DELETE	When an resource is deleted.	`requester`	`system, requester`	OBJECT
CITADEL_ROLE_CREATION	When a new role is created.	`requester`	`system, requester`	OBJECT
CITADEL_ROLE_PATCH	When an role is patched.	`requester`	`system, requester`	OBJECT
CITADEL_ROLE_DELETE	When an role is deleted.	`requester`	`system, requester`	OBJECT
CITADEL_ROLE_PUBLICATION_CREATION	When a new role publication is created.	`requester`	`system, requester`	OBJECT
CITADEL_ROLE_PUBLICATION_PATCH	When a role publication is patched.	`requester`	`system, requester`	OBJECT
CITADEL_ROLE_PUBLICATION_DELETE	When a role publication is deleted.	`requester`	`system, requester`	OBJECT

MyMfa

MyMfa Events Type

Notification Events Type	Description	Recipients	Senders	Available variables
CITADEL_MYMFA_DEVICE_ENROLLMENT_LINK	When an enrollment link need to be sent to the identity.	`requester, identity`	`system, requester`	OBJECT, enrollmentLink, overriddenDestination
CITADEL_MYMFA_UNLOCK_PIN_CREATION	When an myMfa device unlock request has been generated (with unlock pin generation).	`requester, identity`	`system, requester`	OBJECT, unlockPin

Notification Events Type

Description

Recipients

Senders

Available variables

CITADEL_MYMFA_DEVICE_ENROLLMENT_LINK

When an enrollment link need to be sent to the identity.

requester, identity

system, requester

OBJECT, enrollmentLink,

overriddenDestination

CITADEL_MYMFA_UNLOCK_PIN_CREATION

When an myMfa device unlock request has been generated (with unlock pin generation).

requester, identity

system, requester

OBJECT, unlockPin

Password

Password Events Type

Notification Events Type	Description	Recipients	Senders	Available variables
CITADEL_PASSWORD_EXPIRATION_ALERT	When the identity password is about to expire.	`identity`	`system`	OBJECT, days (the number of days before expiration)
CITADEL_PASSWORD_SET	Only used on auto-generation. If you want send a notification when the password is set externally, you can either: use an Action on a Feature use an Action on a Business Policy	`requester, identity`	`system, requester`	OBJECT, password
CITADEL_PASSWORD_RECOVERY		`requester, identity`	`system, requester`	link
CITADEL_PASSWORD_UNSET		`requester, identity`	`system, requester`	reason (the reason of why password was unset)
CITADEL_PASSWORD_CHANGED		`requester, identity`	`system, requester`
CITADEL_RESET_PASSWORD	When a password is reset.	`requester, identity`	`system, requester`	OBJECT, password, overriddenDestination
CITADEL_RESET_PASSWORD_LINK	When a reset password link is requested.	`requester, identity`	`system, requester`	OBJECT, resetLink, overriddenDestination

Public Access

Public Access Events type

Notification Events Type	Description	Recipients	Senders	Available variables
CITADEL_PUBLIC_ACCESS_SUCCESS	When a user identifies himself on a public page.	`identity`	`system, identity`	OBJECT, link
CITADEL_PUBLIC_ACCESS_FAILURE	When a user fails to identify himself on a public page (user doesn't exist or bad credentials).	`identity`	`system, identity`	OBJECT = identity (if user exists)

Workflow

Workflow events Type

Notification Events Type	Description	Recipients	Senders	Available variables
CITADEL_WORKFLOW_USER_TASK__ROLE_ASSIGNMENT_OPERATION_EXECUTION	When a workflow is launched by a role assignment and when an action is performed on the user task.	`identity, userTaskActor (the actor who claims, unclaims, cancels, delegates, approves or rejects), requester, previousApprover, candidate, secondaryCandidate, assignee`	`system`	userTaskId, bpmnTaskId, workflowId, userTaskLink, requester, beneficiary, role, roleAssignmentChanges, operation, currentRoleAssignment, operationComment
CITADEL_WORKFLOW_USER_TASK__FEATURE_EXECUTION	When a workflow is launched by a feature and when an action is performed on the user task.	`identity, userTaskActor, requester, previousApprover, candidate, secondaryCandidate, assignee`	`system`	userTaskId, aboutMeLink, submittedByMeLink, adminLink, bpmnTaskId, featureId, workflowId, userTaskLink, fields, attributes, originalAttributes, requester, beneficiary, operation, operationComment
CITADEL_WORKFLOW_SCRIPT_TASK__FEATURE_EXECUTION	When a workflow is launched by a feature and when a notification is sent from a script task.	`identity, requester, previousApprover`	`system`	bpmnTaskId, featureId, workflowId, fields, attributes, originalAttributes, requester, beneficiary, operation
CITADEL_WORKFLOW_SCRIPT_TASK__ROLE_ASSIGNMENT_OPERATION_EXECUTION	When a workflow is launched by a role assignment and when a notification is sent from a script task.	`identity, requester, previousApprover`	`system`	bpmnTaskId, workflowId, requester, beneficiary, role, roleAssignmentChanges, operation, currentRoleAssignment

Synchronization

Synchronization Events Type

Notification Events Type	Description	Recipients	Senders	Available variables
DOMINO_SYNC_REPORT_PUBLICATION		`domino_task_report_recipient, domino_task_report_replyto`	`domino_task_report_sender`	numberOfGeneratedWarnings, numberOfEntriesToProcess, numberOfProcessedEntries, numberOfIgnoredEntries, numberOfCreatedIdmObjects, numberOfUpdatedIdmObjects, numberOfDeletedIdmObjects, numberOfInactivatedApplicationObjects, startDate, processingTimeMillis, endDate, tenant, numberOfSoftDeletedIdmObjects, numberOfDeactivatedIdmObjects, taskId
DOMINO_PROV_REPORT_PUBLICATION		`domino_task_report_recipient, domino_task_report_replyto`	`domino_task_report_sender`	numberOfGeneratedWarnings, numberOfEntriesToProcess, numberOfProcessedEntries, numberOfIgnoredEntries, numberOfCreatedIdmObjects, numberOfUpdatedIdmObjects, numberOfDeletedIdmObjects, startDate, processingTimeMillis, endDate, tenant, taskId

Roles

Roles Events type

Notification Events Type	Description	Recipients	Senders	Available variables
CITADEL_ROLE_ASSIGNMENT_MANUAL_PROVISIONING_POLICY_CANCEL_OPERATION_EXECUTION	When a Workflow for Manual Provisioning Policy is cancelled (only if a new one is launched).	`identity, userTaskActor, requester, previousApprover, candidate, secondaryCandidate, assignee`	`system`	userTaskId, bpmnTaskId, workflowId, userTaskLink, requester, beneficiary, role, roleAssignmentChanges
CITADEL_WORKFLOW_USER_TASK__ROLE_ASSIGNMENT_OPERATION_EXECUTION	Used to send a notification with a Role Assignment Dimension and Role Assignment Action.	`userTaskActor, all identity link types, previousApprover, requester and identity`		userTaskId, bpmnTaskId, workflowId, userTaskLink, requester, beneficiary, role, roleAssignmentChanges, operation (CREATE, UPDATE, DELETE, PROVISIONING, PROVISIONING_UPDATE, DEPROVISIONING), currentRoleAssignment

AM

Others Events Type

Notification Events Type	Description	Recipients	Senders	Available variables
AM_OTP	When a otp is generated for authentication Available in mail & sms notification	`identity`	`system`	`otp`

Notification Events Type

Description

Recipients

Senders

Available variables

AM_OTP

When a otp is generated for authentication

Available in mail & sms notification

identity

system

otp

Others

Others Events Type

Notification Events Type	Description	Recipients	Senders	Available variables
CITADEL_ACCESS_CODE_CREATION	When a new access code is sent by a groovy script.	`requester, identity`	`system, requester`	OBJECT, link
CITADEL_AUTH_METHOD_DEACTIVATED	When password authentication method is deactivated.	`requester, identity`	`system, requester`	OBJECT
CITADEL_FEATURE_EXECUTION	When sending a notification through a Feature Operation Action.	`requester, identity`	`system, requester`	OBJECT, fields, featureId, objectPatch, operation
CITADEL_ROLE_ASSIGNMENT_MANUAL_PROVISIONING_POLICY_CANCEL_OPERATION_EXECUTION	When a Workflow for Manual Provisioning Policy is cancelled (only if a new one is launched).	`identity, userTaskActor, requester, previousApprover, candidate, secondaryCandidate, assignee`	`system`	userTaskId, bpmnTaskId, workflowId, userTaskLink, requester, beneficiary, role, roleAssignmentChanges

Example

Domino_with_Simulation_tag.xml Orga_Patch.xml Role_Assignment.xml

Reuse an Email Templates

An Email Template can be reused in the html Body and/or in the text Body by using this syntax:

Property name	Code
htmlBody	XML `<htmlBody><![CDATA[@@standard_salutations_txt@@ <br><br> Your password is : <strong>{{ password }}</strong>]]> </htmlBody> <subject>Password set</subject> <textBody><![CDATA[@@standard_salutations_txt@@ Your password is : {{ password }}]]></textBody>`
textBody

Property name

Code

htmlBody

XML

<htmlBody><![CDATA[@@standard_salutations_txt@@
<br><br> Your password is : <strong>{{ password }}</strong>]]>
</htmlBody>
<subject>Password set</subject>
<textBody><![CDATA[@@standard_salutations_txt@@
 Your password is : {{ password }}]]></textBody>

textBody

Definition

Configuration

Global Properties

Notification Definition Properties - Common to Email & SMS

Recipients

Contents

Content

Notification Definition Properties - Email

Notification Definition Properties - SMS

Example

Notification Events Type

Objects

MyMfa

Password

Public Access

Workflow

Synchronization

Roles

AM

Others

Example

Reuse an Email Templates

Read Next