Configuration Guide
Configuration Guide
Breadcrumbs

Notification Template

Definition

The Email Templates are useful to be reused in the configuration of Notification Definition (for example: greeting).

Configuration

🎯

You can access the Notification Template configuration :

  • by clicking on "Notifications" â†’ “Templates”

  • 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 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

Template properties

Property name

Type

Mandatory

Description

Values

id

String

YES

The id is the unique identifier of the Notification Template.

It is case sensitive and no special characters (except - or _) are allowed.

-

name

String

YES

The Notification Template name.

The name may be different from the identifier.
Must be at least 4 characters long.

-

description

String

NO

Used to describe the Notification that will be configured.

-

contents

-

YES

Allows to define different contents.

-

content

-

YES

Allows to define a specific content in French and/or in English.

-

type

Enum

YES

Type of template.

  • SNIPPET : template used in the content of the Notification.

  • BODY : template used to replace the whole body.

SNIPPET, BODY

Example 

<notify:NotificationTemplate id="INC1-internal-html-emailTemplate">
      <name>INC1-internal-html-emailTemplate</name>
      <description></description>
      <contents>
         <content locale="fr"><![CDATA[<div style="margin: 20px;font-size:13px">
                <hr>Notification pour information</br><hr>
                <p>Bonjour,</p>
                <p>La ressource {{OBJECT.lastName}} {{OBJECT.firstName}} ({{OBJECT.login}}) vient d'arriver dans votre Ă©quipe dans la BU {{OBJECT.bu}} de l'Ă©tablissement {{OBJECT.establishment}}.</p>
                <p>Veuillez vous connecter à sof'IAM pour compléter les informations (PC, email, accès lecteur réseau, applications,..) de la ressource en cliquant 
                <a href='{{featureUrl("identity-" + OBJECT.identityTypeNtf + "-hub", OBJECT.id, "identity-" + OBJECT.identityTypeNtf + "-read")}}'>ici</a></p>
            </div>]]></content>
      </contents>
      <type>SNIPPET</type>
   </notify:NotificationTemplate>