From ICIHelp7.15
Jump to: navigation, search
 
(55 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<font face=" Segoe UI ">
 
  
[[ICM Help| Home]] > [[Administrator]]   
+
= Creating&nbsp;a Subscription =
  
Using Subscriptions, you can create user notifications and assign appropriate recipients.<br/>
+
&nbsp;
While creating subscription:
+
# You have to define the entity (an agreement or a task for which the notification to be sent)
+
# You have to define the event at which it will be sent.<br/>
+
  
To create a subscription:<br/>
+
Using Subscriptions, you can create user notifications and assign appropriate recipients. When&nbsp;creating a subscription:
  
1. On the '''Admin''' page, click the '''Notification Settings''' tile. The '''All Notifications Category''' page appears.<br/>
+
*Define the entity or a task for which the notification to be sent.  
 +
*Define the event for which it will be sent.  
 +
<div><div style="float:left;">
 +
To create a subscription:
  
[[File: admin tiles.jpeg]]<br/>
+
'''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.
  
[[File: sub.jpeg]]<br/>
+
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>  
 +
3.&nbsp;'''Click '''the&nbsp;''Create Subscription ''button''. ''The&nbsp;''Create Subscription&nbsp;''page opens.&nbsp;&nbsp;
  
2. Click the '''Subscription''' tile. The '''Subscriptions''' page appears.<br/>
+
There are four tabs on this page:
 +
<ul style="margin-left: 40px;">
 +
<li>Details</li>
 +
<li>Template</li>
 +
<li>Recipient</li>
 +
<li>Verify</li>
 +
</ul>
 +
<div class="note-box">'''Note''':&nbsp;When creating or editing a subscription, the Administrator&nbsp;must make sure that the language preferences are set 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&nbsp;configuration team to add it to the database through scripts.&nbsp;</div>  
 +
&nbsp;
  
[[File:Create Subscription 1.png]]<br/>
+
'''Details'''
  
3. Click '''Create Subscription'''. The '''Create Subscription''' page appears. <br/> Enter the information for the following in the page.
+
Fill in the mandatory fields:
 +
<ul style="margin-left: 40px;">
 +
<li>'''Type'''&nbsp;an appropriate Template Name for the subscription.</li>
 +
<li>'''Select'''&nbsp;an Entity Name such as ''Agreement''.</li>
 +
<li>'''Select'''&nbsp;an Event Name, such as ''Agreement Approved.''</li>
 +
<li>'''Select''' a Category Name such as ''Agreement Notifications''.</li>
 +
<li>'''Click'''&nbsp;''Next''. The&nbsp;''Template''&nbsp;tab opens.</li>
 +
</ul>
 +
</div>
 +
&nbsp;
  
'''A)''' '''Details'''<br/>
+
&nbsp;
'''B)''' '''Template'''<br/>
+
'''C)''' '''Recipient'''<br/>
+
'''D)''' '''Verify'''<br/>
+
  
Let us go through each of the tabs in detail.<br/>
+
&nbsp;
 +
<div class="image-green-border"><br/> [[File:Creating Subscription Create Subscription page 7.8.png|Create Subscription]]</div> <div class="image-green-border">&nbsp;</div>
 +
'''Template'''
  
On the '''A)''' '''Details''' tab,
+
On the ''Template'' tab, define a template for user notifications and email notifications:
 +
<ul style="margin-left: 40px;">
 +
<li>'''Type '''appropriate subject in the ''Template Subject''&nbsp;box. All the notification emails using this template would have this content in the subject line.</li>
 +
<li>'''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.</li>
 +
<li>'''Click''' ''Next''. The ''Recipient'' tab open.</li>
 +
</ul>
 +
<div class="image-green-border">[[File:Creating Subscription templates tab 7.8.png|1000px|Templates tab]]</div> <div class="image-green-border">&nbsp;</div>
 +
'''Recipient'''
  
:a. In the '''Template Name''' box, type an appropriate template name for the subscription.<br/>
+
To add recipients:
  
:b. In the '''Entity Name''' list, click the appropriate entity.<br/>
+
1. '''Click '''the [[File:Add icon.jpeg|RTENOTITLE]] ''Add Recipients ''icon. The ''Add Recipients'' window opens.
  
:c. In the '''Event Name''' list, click the appropriate entity name.<br/>
+
2. '''Select'''&nbsp;''User Roles ''such as Approver, Internal Reviewer etc.
  
:d. In the '''Category Name''' list, click the appropriate category name.<br/>
+
3. '''Select '''''User Attributes'' such as Created By, Modified by etc.
  
:e. Click '''Next'''. The '''Template''' tab appears.<br/>
+
4. '''Check&nbsp;'''the ''Action User'' box if necessary.
  
[[File:Create Subscription 2 Details.png]]<br/>
+
5. '''Select '''a desired user from the displayed list or search a user using the search bar.
  
'''B)''' '''Template'''
+
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>
 +
&nbsp;
 +
<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.
  
On the '''Template''' tab, define a template for user notifications and email notifications.<br/>
+
&nbsp;
  
:a. In the '''Template Subject''' box, type a relevant entity name for the template.<br/>
+
'''Verify'''
  
:b. In the '''Template Body''', type an appropriate message text. Click the '''Attributes''' list to tag respective attributes in the template body. You can also format the selected attributes by using menu options. <br/>
+
On this tab, verify all the information you entered for the Subscription.
 
+
<div class="image-green-border">'''Click'''&nbsp;''Save'' to create the Subscription. Notifications will be sent as and when the respective event occurs.</div> <div class="image-green-border">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.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:7.11-NotificationTemplatespage.png|RTENOTITLE]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">'''Related Topics''': [[User_Administration|User_Administration]] | [[Create_Notification_Categories|Creating Notification Categories]] | [[Create_a_Notification_Rule|Create_a_Notification_Rule]]</div> </div>
:C. Click '''Next'''. The '''Recipient''' tab appears.<br/>
+
 
+
[[File:Create Subscription 3 Template.png]]<br/>
+
 
+
'''C)''' '''Recipient'''<br/>
+
 
+
On the '''Recipient''' tab, add recipients as follows:<br/>
+
 
+
:a. Click [[File: Add icon.jpeg]] next to '''Add Recipients'''.<br/>
+
 
+
[[File: add rec.jpeg]]<br/>
+
 
+
:b. In the '''Add Recipient''' dialogue box, select respective users.<br/>
+
 
+
:c. In the '''Select Roles''' list, click the appropriate role.<br/>
+
 
+
:d. In the '''Select User Attributes''' list, click the appropriate attributes, and select the '''Action User''' box.<br/>
+
 
+
:e. Select a user from the user tiles. You can use scroll arrows [[File: 400.jpeg]] to browse through the user tiles.<br/>
+
 
+
:f. Click '''Add'''. The user name and role appear as a tile.<br/>
+
 
+
:g. Click '''Next'''. The '''Verify''' tab appears.<br/>
+
 
+
'''D)''' '''Verify'''<br/>
+
 
+
On the '''Verify''' tab, verify all the information for the Subscription. <br/>  
+
 
+
[[File:Create Subscription 5 Verify.png]]<br/>
+
 
+
Click '''Save''' to create a '''Subscription'''. <br/>
+
Once a subscription is created, notifications will be sent as and when the respective event occurs.
+
 
+
 
+
Related Topics:<br/>
+
[[Edit a Subscription]]<br/>
+
 
+
</font>
+
<link-page pagebefore="Edit_Notification_Categories|Edit Notification Categories" pageafter="Edit_a_Subscription | Edit a Subscription" />
+

Latest revision as of 10:10, 18 November 2020

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.

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 the language preferences are set 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

Fill in 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 RTENOTITLE 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.

Recipients tab

 

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