From ICIHelp7.17
Jump to: navigation, search
 
(16 intermediate revisions by 4 users not shown)
Line 2: Line 2:
 
= Notification Settings =
 
= Notification Settings =
  
== Create Notification Categories ==
+
== Creating Notification Categories ==
  
 
As an administrator, you can create various notification categories. These categories are then visible to the respective users under the Notifications tile. When creating a subscription, you can place your subscription in the appropriate notification category. 
 
As an administrator, you can create various notification categories. These categories are then visible to the respective users under the Notifications tile. When creating a subscription, you can place your subscription in the appropriate notification category. 
Line 8: Line 8:
 
To create a notifications category:
 
To create a notifications category:
  
1. '''Click''' the ''Notification Settings'' tile On the ''User Administration'' page. The ''Notification Settings'' page appears.
+
1. '''Click''' the ''Notification Settings'' tile On the ''User Administration'' page. The ''Notification Settings'' page opens.
<div class="image-green-border">[[File:Admin- Notification Settings.png|RTENOTITLE]]</div> <div class="image-green-border">[[File:Create Notification Categoy New.png|RTENOTITLE]]</div>
+
2. '''Click''' ''Create Notification Category'' at the bottom of the page.<br/> &nbsp;
+
<div class="image-green-border">[[File:Create Notification Category-bottom.png|RTENOTITLE]]<br/> &nbsp;</div>
+
3. The ''Details'' tab appears.
+
  
4. The created category appears on the ''All Notifications Category'' page.<br/> &nbsp;
+
2. '''Click'''&nbsp;the&nbsp;''Create Notification Category ''button.''&nbsp;''
<div class="image-green-border">[[File:Create New Notification category 3.png|RTENOTITLE]]<br/> &nbsp;</div>  
+
<div class="image-green-border">[[File:Notifications Settings all notification categories 7.8.PNG|720px|RTENOTITLE]]<br/> &nbsp;</div> <div class="image-green-border">3. The ''Details'' tab opens.</div>
'''Type''' an appropriate category name in the ''Category Name'' box, and '''click''' ''Save''.
+
4. The created category appears on the ''All Notifications Category'' page.
 +
<div class="image-green-border">[[File:Create Notification Category Details tab 7.8.PNG|360px|RTENOTITLE]]<br/> &nbsp;</div>  
 +
5.&nbsp;'''Type''' an appropriate category name in the ''Category Name'' box, and '''click''' ''Save''.
  
= Edit Notification Categories =
+
== Editing&nbsp;Notification Categories ==
  
 
As an administrator, you can create as well as edit various notification categories.
 
As an administrator, you can create as well as edit various notification categories.
Line 24: Line 22:
 
To edit a notification category:
 
To edit a notification category:
  
1. '''Click''' the ''Notification Settings'' tile on the ''User Administration'' page. The ''Notification Settings'' page appears.
+
1. '''Click''' the ''Notification Settings'' tile on the ''User Administration'' page. The ''Notification Settings'' page opens.
<div class="image-green-border">[[File:Admin- Notification Settings.png|RTENOTITLE]]<br/> &nbsp;</div>
+
2. '''Select''' the desired entity check box in the ''Notification Category Name'' panel&nbsp;and '''click''' ''Edit''.
+
<div class="image-green-border">[[File:Edit Notification Category.png|RTENOTITLE]]<br/> &nbsp;</div>
+
The ''Details'' tab appears.
+
  
3. '''Type''' or '''update''' the category name In the ''Category Name'' box, and '''click''' ''Update''.
+
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. '''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.
 
4. The updated notification category name appears on the ''All Notifications Category'' page.
  
Line 44: Line 40:
  
 
'''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.
 
'''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.
<div class="image-green-border">[[File:Creating Subscription All Notification Category 7.8.png|All Notification Category page]]</div>  
+
<div class="image-green-border">[[File:Creating Subscription All Notification Category 7.8.png|360px|All Notification Category page]]</div>  
 
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.
 
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|1000px|Subscriptions page]]</div>  
+
<div class="image-green-border">[[File:Creating Subscription Subscriptions page 7.8.png|720px|Subscriptions page]]</div>  
 
3.&nbsp;'''Click '''the&nbsp;''Create Subscription ''button''. ''The&nbsp;''Create Subscription&nbsp;''page opens.&nbsp;&nbsp;
 
3.&nbsp;'''Click '''the&nbsp;''Create Subscription ''button''. ''The&nbsp;''Create Subscription&nbsp;''page opens.&nbsp;&nbsp;
  
Line 55: Line 51:
 
*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 ICM 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>  
&nbsp;
+
 
+
 
'''Details'''
 
'''Details'''
  
Fill in the mandatory fields:
+
Enter the mandatory fields:
  
 
*'''Type'''&nbsp;an appropriate Template Name for the subscription.  
 
*'''Type'''&nbsp;an appropriate Template Name for the subscription.  
Line 67: Line 61:
 
*'''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&nbsp;''Template''&nbsp;tab opens.  
<div class="image-green-border"><br/> [[File:Creating Subscription Create Subscription page 7.8.png|Create Subscription]]</div>  
+
<div class="image-green-border">[[File:Creating Subscription Create Subscription page 7.8.png|560px|Create Subscription]]</div>  
&nbsp;
+
 
+
 
'''Template'''
 
'''Template'''
  
Line 77: Line 69:
 
*'''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 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.  
 
*'''Click''' ''Next''. The ''Recipient'' tab open.  
 
*'''Click''' ''Next''. The ''Recipient'' tab open.  
<div class="image-green-border">[[File:Creating Subscription templates tab 7.8.png|1000px|Templates tab]]</div>  
+
<div class="image-green-border">[[File:Creating Subscription templates tab 7.8.png|720px|Templates tab]]</div>  
&nbsp;
+
 
+
 
'''Recipient'''
 
'''Recipient'''
  
 
To add recipients:
 
To add recipients:
  
1. '''Click '''the [[File:Add icon.jpeg|RTENOTITLE]] ''Add Recipients ''icon. The ''Add Recipients'' window opens.
+
1. '''Click '''the ''Add Recipients ''icon. The ''Add Recipients'' window opens.
  
 
2. '''Select'''&nbsp;''User Roles ''such as Approver, Internal Reviewer etc.
 
2. '''Select'''&nbsp;''User Roles ''such as Approver, Internal Reviewer etc.
Line 95: Line 85:
  
 
6.&nbsp;'''Click''' ''Add''. The user name and role get added in the list.
 
6.&nbsp;'''Click''' ''Add''. The user name and role get added in the list.
<div class="image-green-border">[[File:Creating Subscription Add recipients 7.8.png|1000px|Recipients tab]]</div> <div class="note-box">'''Note''': You can tag users in the Notifications Template using their usernames or Email IDs.</div>  
+
<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.
 
&nbsp;7.&nbsp;'''Click''' ''Next''. The ''Verify'' tab opens.
  
Line 103: Line 93:
  
 
'''Click'''&nbsp;''Save'' to create the Subscription. Notifications will be sent as and when the respective event occurs.
 
'''Click'''&nbsp;''Save'' to create the Subscription. Notifications will be sent as and when the respective event occurs.
 
+
<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.
 
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;
 +
 +
== 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 recipients email type (''To, Cc ''and ''Bcc'') and sender email type (''Reply To ''and ''From'') for the received emails.
 +
 +
To configure the subscription:
 +
 +
1.&nbsp;'''Click '''''User Administration > Notification Settings > Subscription'' on the ''Home ''page. The ''Subscriptions ''index page opens.
 +
 +
2.&nbsp;'''Click '''''Create Subscriptions''. The ''Create Subscription'' page opens.
 +
<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''.
 +
 +
5.&nbsp;'''Select '''the ''Event Name'' which you want to send the notification for. For example, ''Agreement Created''.
 +
 +
6.&nbsp;'''Select''' the ''Category Name''. For example, ''Agreement Notifications''.
 +
<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''.
 +
 +
8.&nbsp;'''Enter '''the ''Template Subject'' and the ''Template Body''.
 +
<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;
 +
<div class="image-green-border">[[File:Configuring email type for notification subscriptions4.png|720px|Configuring email type for notification subscriptions4.png]]</div>
 +
To add users provisioned in the system:
 +
 +
11.&nbsp;'''Search''' for the user using ''Refine Search'' ''here'' search bar.
 +
 +
12.&nbsp;'''Select '''the checkbox corresponding to the user. For example, ''Jill Water''.
 +
 +
13.&nbsp;'''Select''' ''Email Type''. For example, ''To''.
 +
 +
14.&nbsp;'''Click''' ''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>
 +
To add user emails captured during runtime while creating the agreement instance:
 +
 +
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''.
 +
<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''.
 +
 +
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.
 +
<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;
 +
*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.
 +
</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. 
 +
 +
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;
 
&nbsp;
Line 110: Line 162:
 
&nbsp;
 
&nbsp;
  
'''Related Topics''': Agreement&nbsp;Management |
+
'''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]] &nbsp;| [[Search_Sync|Search Sync]] | [[Legacy_Upload|Legacy Upload]]&nbsp;

Latest revision as of 11:50, 12 May 2022

Notification Settings

Creating Notification Categories

As an administrator, you can create various notification categories. These categories are then visible to the respective users under the Notifications tile. When creating a subscription, you can place your subscription in the appropriate notification category. 

To create a notifications category:

1. Click the Notification Settings tile On the User Administration page. The Notification Settings page opens.

2. Click the Create Notification Category button. 

RTENOTITLE
 
3. The Details tab opens.

4. The created category appears on the All Notifications Category page.

RTENOTITLE
 

5. Type an appropriate category name in the Category Name box, and click Save.

Editing Notification Categories

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

To edit a notification category:

1. Click the Notification Settings tile on the User Administration page. The Notification Settings page opens.

2. Select the desired entity check box in the Notification Category Name panel and click the Edit button. The Details tab opens.

3. Type or update the category name In the Category Name box, and click Update.

RTENOTITLE

4. The updated notification category name appears on the All Notifications Category page.

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 to be sent.
  • Define the event for which it will be sent.

To create a subscription:

1. Click the Notification Settings tile on the User Administration page. The All Notifications Category page opens. 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.

All Notification Category page

2. Click the Subscription tile. The Subscriptions page opens. 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.

Subscriptions page

3. Click the Create Subscription button. The Create Subscription page opens.  

There are four 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

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.
Create Subscription

Template

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

  • Type appropriate subject in the Template Subject box. 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 open.
Templates tab

Recipient

To add recipients:

1. Click the Add Recipients icon. The Add Recipients window opens.

2. Select User Roles such as Approver, Internal Reviewer etc.

3. Select User Attributes such as Created By, Modified by etc.

4. Check the Action User box if necessary.

5. Select a desired user from the displayed list or search a user using the search bar.

6. Click Add. The user name and role get added in the list.

RTENOTITLE
 
Note: You can tag users in the Notifications Template using their usernames or Email IDs.

 7. Click Next. The Verify tab opens.

Verify

On this tab, verify all the information you entered for the Subscription.

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

RTENOTITLE

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.

 

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 recipients email type (To, Cc and Bcc) and sender email type (Reply To and From) for the received emails.

To configure the subscription:

1. Click User Administration > Notification Settings > Subscription on the Home page. The Subscriptions index page opens.

2. Click Create Subscriptions. The Create Subscription page opens.

Configuring email type for notification subscriptions.png

3. Enter a name in Template name. For example, Email Type configuration.

4. Select the contract type in the Entity Name. For example, ICI Master Service Agreement.

5. Select the Event Name which you want to send the notification for. For example, Agreement Created.

6. Select the Category Name. For example, Agreement Notifications.

Configuring email type for notification subscriptions2.png

7. Click Next.

8. Enter the Template Subject and the Template Body.

Configuring email type for notification subscriptions3.png

9. Click Next. The Sender/Recipient tab opens.

10. Click Add Sender/Recipients (plus) action icon. The Add Sender/Recipients window opens. 

Configuring email type for notification subscriptions4.png

To add users provisioned in the system:

11. Search for the user using Refine Search here search bar.

12. Select the checkbox corresponding to the user. For example, Jill Water.

13. Select Email Type. For example, To.

14. Click Add. The user will be added to the subscription.

Configuring email type for notification subscriptions5.png

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

15. Choose the attribute  in which you captured email addresses during agreement instance creation in the Select Attributes field. For example, Observer Emails.

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

16. Select Email Type. For example, Reply To. When users reply to the email notifications, it will be sent to these configured email addresses. 

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 .
 
Configuring email type for notification subscriptions6.png

17. Click Add. The details will be added to the subscription with the selected properties.

18. 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.

19. 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.

Configuring email type for notification subscriptions7.png
 
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 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.
 
Configuring email type for notification subscriptions8.png

20. Click Next. The Verify page opens. 

21. Verify the details and click Create. The subscription is created.

Configuring email type for notification subscriptions9.png

 

 

 

Related Topics: Agreement ManagementManaging Organization | Managing Users | Managing User Groups | Managing Security Groups | Application Settings | Currencies | Reasons  | Search Sync | Legacy Upload