From ICIHelp8.1
Jump to: navigation, search
 
(68 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
= Notification Settings =
 
= Notification Settings =
  
−
As an administrator, you can create various notification categories. These categories are then visible to the respective users under the Notifications page that appears on clicking the notification bell icon on the top right.
+
As an administrator, you can create various notification categories and subscriptions under "Notification Settings". You can place your subscription in the appropriate notification category. 
−
<div class="image-green-border">[[File:Bell icon1.PNG|320px]]</div>
+
−
When&nbsp;creating a subscription, you can place your subscription in the appropriate notification category.&nbsp;
+
−
 
+
−
The "Notification Settings" can be administered from the "Admin" navigation menu on the top.
+
−
<div class="image-green-border">[[File:8.0-Notification Settings-Menu.PNG|520px]]</div>
+
−
&nbsp;
+
−
 
+
−
 
+
  
 
== Notification Category ==
 
== Notification Category ==
  
−
The Notification Category is the one under which the notifications triggered for various actions will be listed&nbsp;on the Notifications page.
+
The Notification Category is the one under which the notifications are triggered for various actions on UI or backend.
  
−
The Notifications page appears on clicking the bell icon.
+
The&nbsp;categories are then visible to the respective users&nbsp;on the Notifications page, "Notifications Dashboard", by clicking the notification bell icon on the top right.&nbsp;A red dot will be displayed along with the notification bell icon which indicates that there are unread notifications for the user to go over.
 +
<div class="image-green-border">[[File:Bell icon1.PNG|320px|Bell icon1.PNG]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:8.0-Notification Dashboard.PNG|720px|8.0-Notification Dashboard.PNG]]</div>
 +
&nbsp;Please refer to "Notifications Dashboard" for more detials.
  
 
&nbsp;
 
&nbsp;
  
−
&nbsp;
+
=== Creating&nbsp;Notification Category ===
  
−
&nbsp;
+
To create a notifications category:
  
−
== Creating&nbsp;Notification Categories ==
+
1. '''Click''' the "Notification Settings"&nbsp;menu&nbsp;under the "Admin" navigation menu on the top.
 +
<div class="image-green-border">[[File:8.0-Notification Settings-Menu1.PNG|420px|8.0-Notification Settings-Menu1.PNG]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">2.&nbsp;'''Click '''"Category".&nbsp;The "Notification Category" index page opens. The existing categories are listed in a grid. The grid has sort and filter&nbsp;functionalities&nbsp;at the right of each column heading with arrow and filter icon respectively. The page also has pagination displayed at the bottom-right.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:8.0-Notification Settings-Category-Grid3.PNG|720px|8.0-Notification Settings-Category-Grid3.PNG]]</div>
 +
3'''. Click&nbsp;'''"Create"''&nbsp;''on the far right in&nbsp;the title bar on top. The "Create Category" page opens with the "Details" tab.''&nbsp;''
 +
<div class="image-green-border">4. '''Enter''' the&nbsp;appropriate "Category Name" and '''click&nbsp;'''"Create".&nbsp;The user is redirected to the "Notification Category" page with the created&nbsp;category listed on the top row.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:8.0-Notification Settings-Category-Cerate.PNG|520px|8.0-Notification Settings-Category-Cerate.PNG]]</div> <div class="image-green-border">&nbsp;</div>
 +
=== Editing&nbsp;Notification Category ===
  
−
To create a notifications category:
+
As an administrator, you can create as well as edit various notification categories.
  
−
1. '''Click''' the ''Notification Settings'' tile On the ''User Administration'' page. The ''Notification Settings'' page opens.
+
To edit a notification category:
  
−
2. '''Click'''&nbsp;the&nbsp;''Create Notification Category ''button.''&nbsp;''
+
1.&nbsp;C'''lick'''&nbsp;"Edit" on the three dots of the actions column in the last on the "Notification Category" index page.&nbsp;
−
<div class="image-green-border"><br/> &nbsp;</div> <div class="image-green-border">3. The ''Details'' tab opens.</div>
+
<div class="image-green-border">[[File:8.0-Notification Settings-Category-Index-page-Edit.PNG|720px|8.0-Notification Settings-Category-Index-page-Edit.PNG]]</div>  
−
4. The created category appears on the ''All Notifications Category'' page.
+
2. Update the existing category name in the "Category Name" field, and '''click'''&nbsp;"Update".&nbsp;The updated notification category name appears on the "&nbsp;Notifications Category" page.
−
<div class="image-green-border">[[File:Create Notification Category Details tab 7.8.PNG|360px|RTENOTITLE]]<br/> &nbsp;</div>  
+
<div class="image-green-border">[[File:8.0-Notification Settings-Category-Edit.PNG|520px|8.0-Notification Settings-Category-Edit.PNG]]</div>  
−
5.&nbsp;'''Type''' an appropriate category name in the ''Category Name'' box, and '''click''' ''Save''.
+
&nbsp;
  
−
== Editing&nbsp;Notification Categories ==
+
=== Deleting&nbsp;Notification Category ===
  
−
As an administrator, you can create as well as edit various notification categories.
+
To delete the Notification Category:
  
−
To edit a notification category:
+
1. '''Navigate''' to the "Notification category" page.
  
−
1. '''Click''' the ''Notification Settings'' tile on the ''User Administration'' page. The ''Notification Settings'' page opens.
+
2. '''Select '''the categories you want to delete.
  
−
2. '''Select''' the desired entity check box in the ''Notification Category Name'' panel&nbsp;and '''click'''&nbsp;the&nbsp;''Edit ''button.&nbsp;The ''Details'' tab opens.
+
3. '''Click '''"Delete" on the right above the grid.
 +
<div class="image-green-border">[[File:8.0-Notification Settings-Category-Delete.PNG|720px|8.0-Notification Settings-Category-Delete.PNG]]</div>
 +
&nbsp;
  
−
3. '''Type''' or '''update''' the category name In the ''Category Name'' box, and '''click''' ''Update''.
 
−
<div class="image-green-border">[[File:Edit notification category 7.8.PNG|360px|RTENOTITLE]]</div>
 
−
4. The updated notification category name appears on the ''All Notifications Category'' page.
 
  
−
== Creating&nbsp;a Subscription ==
+
== Subscription ==
  
−
Using Subscriptions, you can create user notifications and assign appropriate recipients. When&nbsp;creating a subscription:
+
=== Creating&nbsp;a Subscription ===
  
−
*Define the entity or a task for which the notification to be sent.
+
Using Subscriptions, you can create user notifications and assign appropriate recipients.
−
*Define the event for which it will be sent.  
+
  
−
'''To create a subscription''':
+
When&nbsp;creating a subscription:
  
−
'''1. Click '''the ''Notification Settings'' tile on the ''User Administration'' page. The ''All Notifications Category'' page opens.&nbsp;All the existing notification categories are displayed on this page such as Agreement Notifications, Clause Notifications. Each notification category groups various notification templates of various events that fit into the respective category. You can also edit or delete the displayed categories.
+
*Define the entity or a task for which the notification is to be sent.  
−
<div class="image-green-border">[[File:Creating Subscription All Notification Category 7.8.png|360px|All Notification Category page]]</div>
+
*Define the event for which it will be sent.  
−
2.'''&nbsp;Click''' the ''Subscription'' tile. The ''Subscriptions'' page opens.&nbsp;On this page you can see a list of all the existing Notification Templates and their details such as Template Name, Entity Name, Event and Category Name etc. You can also edit, delete, create, enable or disable a subscription using the respective buttons.
+
 
−
<div class="image-green-border">[[File:Creating Subscription Subscriptions page 7.8.png|720px|Subscriptions page]]</div>  
+
To create a subscription:
−
3.&nbsp;'''Click '''the&nbsp;''Create Subscription ''button''. ''The&nbsp;''Create Subscription&nbsp;''page opens.&nbsp;&nbsp;
+
<div class="image-green-border">1.'''&nbsp;Click'''&nbsp;the "Subscription" menu of "Notification Settings". The "Subscriptions" page opens.&nbsp;On this page, you can see a list of all the existing Notification Templates and their details.&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:8.0-Notification Settings-Sub-Create.PNG|720px|8.0-Notification Settings-Sub-Create.PNG]]</div> <div class="image-green-border">&nbsp;</div>  
 +
2.&nbsp;'''Click '''"Create" on the top at&nbsp;the far right''. ''The&nbsp;Create Subscription''&nbsp;''page opens.&nbsp;&nbsp;
  
−
There are four tabs on this page:
+
There are following tabs on this page:
  
 
*Details  
 
*Details  
Line 71: Line 68:
 
*Recipient  
 
*Recipient  
 
*Verify  
 
*Verify  
−
<div class="note-box">'''Note''':&nbsp;When creating or editing a subscription, the Administrator&nbsp;must make sure that he set his language preferences to English (United States). Otherwise an information message is displayed. Subscriptions can be created in English only. If you need your subscription in various languages, you can provide the localized content to the ICI configuration team to add it to the database through scripts.&nbsp;</div>  
+
<div class="note-box">'''Note''':&nbsp;When creating or editing a subscription, the Administrator&nbsp;must make sure that he set his language preferences to English (United States). Otherwise, an information message is displayed. Subscriptions can be created in English only. If you need your subscription in various languages, you can provide the localized content to the ICI configuration team to add it to the database through scripts.&nbsp;</div>  
 
'''Details'''
 
'''Details'''
  
−
Enter the mandatory fields:
+
3. Enter the mandatory fields:
  
−
*'''Type'''&nbsp;an appropriate Template Name for the subscription.  
+
*'''Type'''&nbsp;an appropriate "Template Name" for the subscription.  
−
*'''Select'''&nbsp;an Entity Name such as ''Agreement''.  
+
*'''Select'''&nbsp;an "Entity Name" such as "Agreement".  
−
*'''Select'''&nbsp;an Event Name, such as ''Agreement Approved.''
+
*'''Select'''&nbsp;an "Event Name", such as "Agreement Approved".  
−
*'''Select''' a Category Name such as ''Agreement Notifications''.  
+
*'''Select''' a "Category Name" such as "Agreement Notifications".  
−
*'''Click'''&nbsp;''Next''. The&nbsp;''Template''&nbsp;tab opens.  
+
*'''Click'''&nbsp;"Next". The "Template"&nbsp;tab opens.  
−
<div class="image-green-border">[[File:Creating Subscription Create Subscription page 7.8.png|560px|Create Subscription]]</div>  
+
<div class="image-green-border">[[File:8.0-Notification Settings-Subscription-create-detail.PNG|520px|8.0-Notification Settings-Subscription-create-detail.PNG]]</div>  
 
'''Template'''
 
'''Template'''
  
−
On the ''Template'' tab, define a template for user notifications and email notifications:
+
4. On the "Template" tab, define a template for user notifications and email notifications:
  
−
*'''Type '''appropriate subject in the ''Template Subject''&nbsp;box. All the notification emails using this template would have this content in the subject line.  
+
*'''Type '''appropriate subject in the "Template Subject" textbox. All the notification emails using this template would have this content in the subject line.  
−
*'''Type''' an appropriate message in the T''emplate Body.'' '''Click''' the ''Attributes'' list to tag respective attributes in the template body. You can also format the selected attributes by using menu options.  
+
*'''Type''' an appropriate message in the "Template Body"''.'' '''Click''' the "Attributes" list to tag respective attributes in the template body. You can also format the selected attributes by using menu options.  
−
*'''Click''' ''Next''. The ''Recipient'' tab open.  
+
*'''Click'''&nbsp;"Next". The "Recipient" tab opens.  
−
<div class="image-green-border">[[File:Creating Subscription templates tab 7.8.png|720px|Templates tab]]</div>  
+
<div class="image-green-border">[[File:8.0-Notification Settings-Subscription-create-Template1.PNG|720px|8.0-Notification Settings-Subscription-create-Template1.PNG]]</div>  
 
'''Recipient'''
 
'''Recipient'''
  
−
To add recipients:
+
5. To add recipients:
  
−
1. '''Click '''the ''Add Recipients ''icon. The ''Add Recipients'' window opens.
+
*'''Click '''"Add Recipients". The "Add Recipients"&nbsp;drawer slides from the right.
 +
*'''Select'''&nbsp;"Select&nbsp;Roles" such as Approver, Internal Reviewer, etc.  
 +
*'''Select "'''Select&nbsp;Attributes" such as Created By, Modified by, etc.&nbsp;For more details see the "Configuring Email Type for Notification" below.&nbsp;
 +
*'''Select''' "Email Type" such as To, From, CC, BCC. For more details see the "Configuring Email Type for Notification" below.&nbsp;
 +
*'''Check&nbsp;'''the "Action User" if necessary.
 +
*'''Select '''a desired user from the displayed grid or search a user using the "Refine View" filter left pane ('''Note:''' If "Refine View is collapsed, then expand to view it).
 +
*'''Click'''&nbsp;"Add". The user name and role get added to the list.
 +
<div class="image-green-border">[[File:8.0-Notification Settings-Add-Recipients.PNG|720px|8.0-Notification Settings-Add-Recipients.PNG]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">For example, two recipients are added, "First Approver" with Role "Approver" and "Vijay Soni" as role "Reviewer.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:8.0-Notification Settings-Subscription-create-Recipient.PNG|720px|8.0-Notification Settings-Subscription-create-Recipient.PNG]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''': You can tag users in the Notifications Template using their usernames or Email IDs.</div>
 +
*&nbsp;'''Click'''&nbsp;"Next". The "Verify" tab opens.  
  
−
2. '''Select'''&nbsp;''User Roles ''such as Approver, Internal Reviewer etc.
+
'''Verify'''
  
−
3. '''Select '''''User Attributes'' such as Created By, Modified by etc.
+
6. On this tab, verify all the information you entered for the Subscription. You can use the Collapse/Expand All icon on the top right to expand the data in all tabs or can expand or collapse individual tab data.
  
−
4. '''Check&nbsp;'''the ''Action User'' box if necessary.
+
'''Click'''&nbsp;"Create" to create the Subscription. Notifications will be sent as and when the respective event occurs.
 +
<div class="image-green-border">[[File:8.0-Notification Settings-Subscription-create-Verify.PNG|720px|8.0-Notification Settings-Subscription-create-Verify.PNG]]</div>
 +
Notification can be sent in multiple languages. If there are multiple recipients with different language preferences for the respective event. The language is identified from the language set by the Internal User and External user with login privileges in their "Preferences". One single email is sent to all the selected recipients with the content in different languages. The recipients can simply scroll through the email and read the content drafted in their preferred language.
  
−
5. '''Select '''a desired user from the displayed list or search a user using the search bar.
+
Refer "Create a Subscription" page for more details.
  
−
6.&nbsp;'''Click''' ''Add''. The user name and role get added in the list.
+
=== Editing a Subscription ===
−
<div class="image-green-border">[[File:Create Subscription Add reciepient 7.8.PNG|720px|RTENOTITLE]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''': You can tag users in the Notifications Template using their usernames or Email IDs.</div>
+
−
&nbsp;7.&nbsp;'''Click''' ''Next''. The ''Verify'' tab opens.
+
  
−
'''Verify'''
+
To edit a subscription:
  
−
On this tab, verify all the information you entered for the Subscription.
+
1. '''Click '''the three dots in the actions column in the far right of the "Subscriptions" grid.2. '''Click '''"Edit".
 +
<div class="image-green-border">[[File:8.0-Notification Settings-Subscription-Edit0.PNG|720px|8.0-Notification Settings-Subscription-Edit0.PNG]]</div> <div class="image-green-border">The "Edit Subscription" page opens.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:8.0-Notification Settings-Subscription-Edit.PNG|420px|8.0-Notification Settings-Subscription-Edit.PNG]]</div> <div class="image-green-border">&nbsp;</div>
 +
=== Deleting a Subscription ===
  
−
'''Click'''&nbsp;''Save'' to create the Subscription. Notifications will be sent as and when the respective event occurs.
+
To delete a Subscription:
−
<div class="image-green-border">[[File:Create Subscrption veriffy page 7.8.PNG|560px|RTENOTITLE]]</div>
+
−
Notification can be sent in multiple languages. If there are multiple recipients with different language preferences for the respective event. The language is identified from the language set by the Internal User and External user with login privileges in their ''Preferences''. One single email is sent to all the selected recipients with the content in different languages. The recipients can simply scroll through the email and read the content drafted in their preferred language.
+
  
−
&nbsp;
+
1. '''Select '''the one or more subscriptions you want to delete.
  
−
== Configuring Email Type for Notification ==
+
2. '''Click '''"Delete Subscription" on the top right below the title bar. A confirmation popup appears.
  
−
Users can configure the notifications to be sent to email addresses captured in the agreement instance and also set the recipients email type (''To, Cc ''and ''Bcc'') and sender email type (''Reply To ''and ''From'') for the received emails.
+
3. '''Click '''"Yes" to proceed.
  
−
To configure the subscription:
+
Subscription successfully deleted toast message flashes.
 +
<div class="image-green-border">[[File:8.0-Notification Settings-Delete-Subscription .PNG|720px|8.0-Notification Settings-Delete-Subscription .PNG]]</div> <div class="image-green-border">&nbsp;</div>
 +
&nbsp;
  
−
1.&nbsp;'''Click '''''User Administration > Notification Settings > Subscription'' on the ''Home ''page. The ''Subscriptions ''index page opens.
+
=== Enabling/Disabling Subscription ===
  
−
2.&nbsp;'''Click '''''Create Subscriptions''. The ''Create Subscription'' page opens.
+
You can enable and disable a subscription in two ways:
−
<div class="image-green-border">[[File:Configuring email type for notification subscriptions.png|720px|Configuring email type for notification subscriptions.png]]</div>
+
−
3.&nbsp;'''Enter '''a name in ''Template ''name. For example, ''Email Type configuration''.
+
  
−
4.&nbsp;'''Select '''the contract type in the ''Entity Name''. For example, ''ICI&nbsp;Master Service Agreement''.
+
*'''Click''' "Enable/Disable Subscription" on the top right in the bar below the title bar.
 +
*'''Click''' Enable/Disable under the three dots menu in the actions column depending on the subscription is in enable or disable state.  
  
−
5.&nbsp;'''Select '''the ''Event Name'' which you want to send the notification for. For example, ''Agreement Created''.
+
Note: The state of the Subscription is shown by the check green icon and red icon for "Enable" and "Disable" states respectively.
 +
<div class="image-green-border">[[File:8.0-Notification Settings-Sub-enable.PNG|720px|8.0-Notification Settings-Sub-enable.PNG]]</div> <div class="image-green-border">&nbsp;</div>
 +
=== Configuring Email Type for Notification ===
  
−
6.&nbsp;'''Select''' the ''Category Name''. For example, ''Agreement Notifications''.
+
Users can configure the notifications to be sent to email addresses captured in the agreement instance and also set the recipient's email type (To, Cc and Bcc) and sender email type (Reply-To and From) for the received emails.
−
<div class="image-green-border">[[File:Configuring email type for notification subscriptions2.png|720px|Configuring email type for notification subscriptions2.png]]</div>
+
 
−
7.&nbsp;'''Click '''''Next''.
+
To configure the subscription:
  
−
8.&nbsp;'''Enter '''the ''Template Subject'' and the ''Template Body''.
+
1. '''Navigate '''to the "Recipients" tab as explained in the "Creating a&nbsp;Subscription" section.
−
<div class="image-green-border">[[File:Configuring email type for notification subscriptions3.png|720px|Configuring email type for notification subscriptions3.png]]</div>
+
−
9.&nbsp;'''Click '''''Next''. The ''Sender/Recipient'' tab opens.
+
  
−
10.&nbsp;'''Click '''''Add Sender/Recipients'' (plus) action icon. The ''Add Sender/Recipients ''window opens.&nbsp;
+
2.&nbsp;'''Click '''"Add Recipients". The "Add Recipients"''&nbsp;''window opens.&nbsp;
−
<div class="image-green-border">[[File:Configuring email type for notification subscriptions4.png|720px|Configuring email type for notification subscriptions4.png]]</div>  
+
<div class="image-green-border">[[File:8.0-Notification Settings-Subscription-create-recipent1.PNG|420px|8.0-Notification Settings-Subscription-create-recipent1.PNG]]</div>  
 
To add users provisioned in the system:
 
To add users provisioned in the system:
  
−
11.&nbsp;'''Search''' for the user using ''Refine Search'' ''here'' search bar.
+
1.&nbsp;'''Search''' for the user using the "Refine Search here" search bar in the left collapsible pane of the "Refine View".
  
−
12.&nbsp;'''Select '''the checkbox corresponding to the user. For example, ''Jill Water''.
+
2.&nbsp;'''Select '''the checkbox corresponding to the user. For example, "Vijay".
  
−
13.&nbsp;'''Select''' ''Email Type''. For example, ''To''.
+
3.&nbsp;'''Select'''&nbsp;"Email" Type. For example, "To".
  
−
14.&nbsp;'''Click''' ''Add''. The user will be added to the subscription.
+
4.&nbsp;'''Click'''&nbsp;"Add". The user will be added to the subscription.
−
<div class="image-green-border">[[File:Configuring email type for notification subscriptions5.png|720px|Configuring email type for notification subscriptions5.png]]</div>
+
<div class="image-green-border">To add user emails captured during runtime while creating the agreement instance:</div>
−
To add user emails captured during runtime while creating the agreement instance:
+
5.&nbsp;'''Choose '''the attribute in which you captured email addresses during agreement instance creation in the "Select Attributes" field. For example, "Created By"
 +
<div class="note-box">'''Note''': The "Select Attributes" dropdown will show all attributes with data types as User and Email.</div>
 +
6.&nbsp;'''Select '''"Email Type". For example, "Reply-To". When users reply to the email notifications, they will be sent to these configured email addresses.&nbsp;
 +
<div class="note-box">'''Note''': When users choose the "Reply All" option while replying to the email, the reply will be sent to all the recipients in To, Cc and the user emails configured with the "Reply-To" email type.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">7.&nbsp;'''Click '''"Add". The&nbsp;details will be added to the subscription with the selected properties.</div>
 +
8.&nbsp;'''Add '''more users as recipients to the subscription with other email types following the same process. For example, attribute "Customer Email" with email type as "CC".
  
−
15.&nbsp;'''Choose '''the attribute &nbsp;in which you captured email addresses during agreement instance creation in the ''Select Attributes'' field. For example, ''Observer Emails''.
+
9.&nbsp;'''Add '''a user with email type as "From".
−
<div class="note-box">'''Note''': The ''Select Attributes'' dropdown will show all attributes with data types as ''User ''and ''Email''.</div>
+
−
16.&nbsp;'''Select '''''Email Type''. For example, ''Reply To''. When users reply to the email notifications, it will be sent to these configured email addresses.&nbsp;
+
−
<div class="note-box">'''Note''': When users chooses ''Reply All'' option while replying to the email, the reply will be sent to all the recipients in ''To, Cc'' and the user emails configured with the ''Reply To'' email type .</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:Configuring email type for notification subscriptions6.png|720px|Configuring email type for notification subscriptions6.png]]</div>
+
−
17.&nbsp;'''Click '''''Add''. The&nbsp;details will be added to the subscription with the selected properties.
+
  
−
18.&nbsp;'''Add '''more users as recipients to the subscription with other email types following the same process. For example, attribute&nbsp;''Customer Email'' with email type as ''CC''.
+
The recipients will receive notifications from the user whose email address is set with the email type as From.
 +
<div class="image-green-border">&nbsp;</div> <div class="note-box">'''Notes''':&nbsp;
 +
*The sender email type "From"''&nbsp;''will, by default, be unavailable.&nbsp;
 +
*The "From"&nbsp;email type is configured through the technical configuration.&nbsp;
 +
*Users can not add more than one user with the "From"''&nbsp;''email Type to the subscription. If the role/attribute with multiple users is configured with the "From"''&nbsp;''email Type, the system will pick any one user randomly. Therefore, it is recommended to use a single user or user role/attribute that has a single user associated with it.
 +
</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:8.0-Notification Settings-Add-Recipients1.PNG|720px|8.0-Notification Settings-Add-Recipients1.PNG]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">10.&nbsp;'''Click "'''Next". The "Verify" page opens. </div>
 +
11.&nbsp;'''Verify '''the details and '''click'''&nbsp;"Create". The subscription is created.
 +
<div class="image-green-border">&nbsp;</div>
  
−
19.&nbsp;'''Add '''a user with email type as ''From''.
 
  
−
The recipients will receive notifications from the user whose email address is set with the email type as From.
+
== Trigger Notification ==
−
<div class="image-green-border">[[File:Configuring email type for notification subscriptions7.png|720px|Configuring email type for notification subscriptions7.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Notes''':&nbsp;
+
 
−
*The sender email type ''From ''will, by default, be unavailable.&nbsp;
+
Please refer to "Trigger Notification" for more details.
−
*The ''From ''email type is configured through the technical configuration.&nbsp;  
+
 
−
*Users can not add more than one user with ''From ''email Type to the subscription. If the role/attribute with multiple users is configured with ''From ''email Type, system will pick any one user randomly. Therefore, it is recommended to use single user or user role/attribute that has single user associated with it.
+
&nbsp;
−
</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:Configuring email type for notification subscriptions8.png|720px|Configuring email type for notification subscriptions8.png]]</div>
+
 
−
20.&nbsp;'''Click '''''Next''. The ''Verify ''page opens. 
+
&nbsp;
  
−
21.&nbsp;'''Verify '''the details and '''click''' ''Create''. The subscription is created.
 
−
<div class="image-green-border">[[File:Configuring email type for notification subscriptions9.png|720px|Configuring email type for notification subscriptions9.png]]</div>
 
 
&nbsp;
 
&nbsp;
  
Line 182: Line 192:
 
&nbsp;
 
&nbsp;
  
−
'''Related Topics: '''[[Agreement_Management|Agreement Management]] |&nbsp;[[Managing_Organization|Managing Organization]] | [[Managing_Users|Managing Users]] | [[Managing_User_Groups|Managing User Groups]] | [[Managing_Security_Groups|Managing Security Groups]] | [[Application_Settings|Application Settings]] | [[Currencies|Currencies]] | [[Reasons|Reasons]] | [[Deleting_an_Agreement|Deleting an Agreement]] | [[Search_Sync|Search Sync]] | [[Legacy_Upload|Legacy Upload]]&nbsp;
+
'''Related Topics: '''[[Trigger_Notification|Trigger Notification]]&nbsp;'''|&nbsp;'''[[Create_a_Subscription|Create a Subscription]]&nbsp;|'''&nbsp;'''[[Notifications_Dashboard|Notifications Dashboard]]'''|&nbsp;'''[[Agreement_Management|Agreement Management]] |&nbsp;[[Application_Settings|Application Settings]] &nbsp;&nbsp;

Latest revision as of 10:21, 9 June 2022

Notification Settings

As an administrator, you can create various notification categories and subscriptions under "Notification Settings". You can place your subscription in the appropriate notification category. 

Notification Category

The Notification Category is the one under which the notifications are triggered for various actions on UI or backend.

The categories are then visible to the respective users on the Notifications page, "Notifications Dashboard", by clicking the notification bell icon on the top right. A red dot will be displayed along with the notification bell icon which indicates that there are unread notifications for the user to go over.

Bell icon1.PNG
 
8.0-Notification Dashboard.PNG

 Please refer to "Notifications Dashboard" for more detials.

 

Creating Notification Category

To create a notifications category:

1. Click the "Notification Settings" menu under the "Admin" navigation menu on the top.

8.0-Notification Settings-Menu1.PNG
 
2. Click "Category". The "Notification Category" index page opens. The existing categories are listed in a grid. The grid has sort and filter functionalities at the right of each column heading with arrow and filter icon respectively. The page also has pagination displayed at the bottom-right.
 
8.0-Notification Settings-Category-Grid3.PNG

3. Click "Create" on the far right in the title bar on top. The "Create Category" page opens with the "Details" tab. 

4. Enter the appropriate "Category Name" and click "Create". The user is redirected to the "Notification Category" page with the created category listed on the top row.
 
8.0-Notification Settings-Category-Cerate.PNG
 

Editing Notification Category

As an administrator, you can create as well as edit various notification categories.

To edit a notification category:

1. Click "Edit" on the three dots of the actions column in the last on the "Notification Category" index page. 

8.0-Notification Settings-Category-Index-page-Edit.PNG

2. Update the existing category name in the "Category Name" field, and click "Update". The updated notification category name appears on the " Notifications Category" page.

8.0-Notification Settings-Category-Edit.PNG

 

Deleting Notification Category

To delete the Notification Category:

1. Navigate to the "Notification category" page.

2. Select the categories you want to delete.

3. Click "Delete" on the right above the grid.

8.0-Notification Settings-Category-Delete.PNG

 


Subscription

Creating a Subscription

Using Subscriptions, you can create user notifications and assign appropriate recipients.

When creating a subscription:

  • Define the entity or a task for which the notification is to be sent.
  • Define the event for which it will be sent.

To create a subscription:

1. Click the "Subscription" menu of "Notification Settings". The "Subscriptions" page opens. On this page, you can see a list of all the existing Notification Templates and their details. 
 
8.0-Notification Settings-Sub-Create.PNG
 

2. Click "Create" on the top at the far right. The Create Subscription page opens.  

There are following tabs on this page:

  • Details
  • Template
  • Recipient
  • Verify
Note: When creating or editing a subscription, the Administrator must make sure that he set his language preferences to English (United States). Otherwise, an information message is displayed. Subscriptions can be created in English only. If you need your subscription in various languages, you can provide the localized content to the ICI configuration team to add it to the database through scripts. 

Details

3. Enter the mandatory fields:

  • Type an appropriate "Template Name" for the subscription.
  • Select an "Entity Name" such as "Agreement".
  • Select an "Event Name", such as "Agreement Approved".
  • Select a "Category Name" such as "Agreement Notifications".
  • Click "Next". The "Template" tab opens.
8.0-Notification Settings-Subscription-create-detail.PNG

Template

4. On the "Template" tab, define a template for user notifications and email notifications:

  • Type appropriate subject in the "Template Subject" textbox. All the notification emails using this template would have this content in the subject line.
  • Type an appropriate message in the "Template Body". Click the "Attributes" list to tag respective attributes in the template body. You can also format the selected attributes by using menu options.
  • Click "Next". The "Recipient" tab opens.
8.0-Notification Settings-Subscription-create-Template1.PNG

Recipient

5. To add recipients:

  • Click "Add Recipients". The "Add Recipients" drawer slides from the right.
  • Select "Select Roles" such as Approver, Internal Reviewer, etc.
  • Select "Select Attributes" such as Created By, Modified by, etc. For more details see the "Configuring Email Type for Notification" below. 
  • Select "Email Type" such as To, From, CC, BCC. For more details see the "Configuring Email Type for Notification" below. 
  • Check the "Action User" if necessary.
  • Select a desired user from the displayed grid or search a user using the "Refine View" filter left pane (Note: If "Refine View is collapsed, then expand to view it).
  • Click "Add". The user name and role get added to the list.
8.0-Notification Settings-Add-Recipients.PNG
 
For example, two recipients are added, "First Approver" with Role "Approver" and "Vijay Soni" as role "Reviewer.
 
8.0-Notification Settings-Subscription-create-Recipient.PNG
 
Note: You can tag users in the Notifications Template using their usernames or Email IDs.
  •  Click "Next". The "Verify" tab opens.

Verify

6. On this tab, verify all the information you entered for the Subscription. You can use the Collapse/Expand All icon on the top right to expand the data in all tabs or can expand or collapse individual tab data.

Click "Create" to create the Subscription. Notifications will be sent as and when the respective event occurs.

8.0-Notification Settings-Subscription-create-Verify.PNG

Notification can be sent in multiple languages. If there are multiple recipients with different language preferences for the respective event. The language is identified from the language set by the Internal User and External user with login privileges in their "Preferences". One single email is sent to all the selected recipients with the content in different languages. The recipients can simply scroll through the email and read the content drafted in their preferred language.

Refer "Create a Subscription" page for more details.

Editing a Subscription

To edit a subscription:

1. Click the three dots in the actions column in the far right of the "Subscriptions" grid.2. Click "Edit".

8.0-Notification Settings-Subscription-Edit0.PNG
The "Edit Subscription" page opens.
 
8.0-Notification Settings-Subscription-Edit.PNG
 

Deleting a Subscription

To delete a Subscription:

1. Select the one or more subscriptions you want to delete.

2. Click "Delete Subscription" on the top right below the title bar. A confirmation popup appears.

3. Click "Yes" to proceed.

Subscription successfully deleted toast message flashes.

8.0-Notification Settings-Delete-Subscription .PNG
 

 

Enabling/Disabling Subscription

You can enable and disable a subscription in two ways:

  • Click "Enable/Disable Subscription" on the top right in the bar below the title bar.
  • Click Enable/Disable under the three dots menu in the actions column depending on the subscription is in enable or disable state.

Note: The state of the Subscription is shown by the check green icon and red icon for "Enable" and "Disable" states respectively.

8.0-Notification Settings-Sub-enable.PNG
 

Configuring Email Type for Notification

Users can configure the notifications to be sent to email addresses captured in the agreement instance and also set the recipient's email type (To, Cc and Bcc) and sender email type (Reply-To and From) for the received emails.

To configure the subscription:

1. Navigate to the "Recipients" tab as explained in the "Creating a Subscription" section.

2. Click "Add Recipients". The "Add Recipients" window opens. 

8.0-Notification Settings-Subscription-create-recipent1.PNG

To add users provisioned in the system:

1. Search for the user using the "Refine Search here" search bar in the left collapsible pane of the "Refine View".

2. Select the checkbox corresponding to the user. For example, "Vijay".

3. Select "Email" Type. For example, "To".

4. Click "Add". The user will be added to the subscription.

To add user emails captured during runtime while creating the agreement instance:

5. Choose the attribute in which you captured email addresses during agreement instance creation in the "Select Attributes" field. For example, "Created By"

Note: The "Select Attributes" dropdown will show all attributes with data types as User and Email.

6. Select "Email Type". For example, "Reply-To". When users reply to the email notifications, they will be sent to these configured email addresses. 

Note: When users choose the "Reply All" option while replying to the email, the reply will be sent to all the recipients in To, Cc and the user emails configured with the "Reply-To" email type.
 
7. Click "Add". The details will be added to the subscription with the selected properties.

8. Add more users as recipients to the subscription with other email types following the same process. For example, attribute "Customer Email" with email type as "CC".

9. Add a user with email type as "From".

The recipients will receive notifications from the user whose email address is set with the email type as From.

 
Notes: 
  • The sender email type "From" will, by default, be unavailable. 
  • The "From" email type is configured through the technical configuration. 
  • Users can not add more than one user with the "From" email Type to the subscription. If the role/attribute with multiple users is configured with the "From" email Type, the system will pick any one user randomly. Therefore, it is recommended to use a single user or user role/attribute that has a single user associated with it.
 
8.0-Notification Settings-Add-Recipients1.PNG
 
10. Click "Next". The "Verify" page opens. 

11. Verify the details and click "Create". The subscription is created.

 


Trigger Notification

Please refer to "Trigger Notification" for more details.

 

 

 

 

 

Related Topics: Trigger Notification | Create a Subscription | Notifications Dashboard| Agreement Management | Application Settings   

Retrieved from "https://iciwikiapac.icertis.com:443/ICIHelp8.1/index.php?title=Notification_Settings&oldid=24860"