From ICIHelp8.2
Jump to: navigation, search
 
(62 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
<font face=" Segoe UI ">
 
  
−
[[ICM Help| Home]] > [[ User Administration]] > Create a Subscription<br/> 
+
= Creating&nbsp;a Subscription =
  
−
Using Subscriptions, you can create user notifications and assign appropriate recipients.<br/>
+
Using Subscriptions, you can create user notifications and assign appropriate recipients. When&nbsp;creating a subscription:
−
'''While creating subscription:'''
+
−
# You have to define the entity or a task for which the notification to be sent.<br/>
+
−
# You have to define the event at which it will be sent.<br/>
+
−
<div>
+
−
      <div style="float:left;width:68%;" >
+
−
'''To create a subscription:'''<br/>
+
  
−
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.  
  
−
[[File: admin tiles.jpeg]]<br/>
+
To create a subscription:
  
−
[[File: sub.jpeg]]<br/>
+
1'''. Click '''the "Notification Settings" option under "Admin" tile and then '''click&nbsp;'''"Subscription". The "Subscriptions" page opens.&nbsp;All the existing subscriptions are displayed on this page such as Agreement Notifications, Clause Notifications. Each subscription groups has 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 appears.<br/>
+
2.'''&nbsp;Click''' "Create" on the "Subscriptions" page. The "Create Subscription" page opens.&nbsp;
  
−
[[File:Create Subscription 1.png]]<br/>
+
There are four tabs on this page:
  
−
3. Click '''Create Subscription'''. The '''Create Subscription''' page appears. <br/> Enter the information for the following in the page.
+
*Details
 +
*Template
 +
*Recipient
 +
*Verify
 +
<div class="image-green-border">[[File:AccessingSubsriptionMenu.png|720px]]</div> <div class="image-green-border">&nbsp;</div> <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 different languages, you can provide the localized content to the ICI&nbsp;configuration team to add it to the database through scripts.&nbsp;</div>
 +
'''Details'''
  
−
* '''Details'''<br/>
+
Fill in the mandatory fields:
−
* '''Template'''<br/>
+
−
* '''Recipient'''<br/>
+
−
* '''Verify'''<br/>
+
  
−
Let us go through each of the tabs in detail.<br/>
+
*'''Type'''&nbsp;an appropriate Template Name for the subscription.  
−
</div>
+
*'''Select'''&nbsp;an Entity Name, such as Agreement.
 +
*'''Select'''&nbsp;an Event Name, such as Agreement Approved.
 +
*'''Select''' a Category Name, such as Agreement Notifications.
 +
*'''Click'''&nbsp;Next. The&nbsp;Template&nbsp;tab opens.
 +
<div class="image-green-border">[[File:CreateSubscription - Details.png|600px]]</div>  
 +
'''Template'''
  
−
   
+
On the Template tab, define a template for user notifications and email notifications:
−
<div style="clear:both"></div>
+
−
'''Details''',
+
  
−
:a. In the '''Template Name''' box, type an appropriate template name for the subscription.<br/>
+
*'''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''' 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.
 +
<div class="image-green-border">[[File:CreateSubscription - Template.png|600px]]</div>  
 +
'''Sender/Recipient'''
  
−
:b. In the '''Entity Name''' list, click the appropriate entity name.<br/>
+
To add recipients:
−
:c. In the '''Event Name''' list, click the appropriate event name.<br/>
+
  
−
:d. In the '''Category Name''' list, click the appropriate category name.<br/>
+
1. '''Click '''the &nbsp;Add Recipients icon. The Add Recipients window opens.
  
−
:e. Click '''Next'''. The '''Template''' tab appears.<br/>
+
2. '''Select'''&nbsp;User Roles such as Approver, Internal Reviewer etc.
  
−
[[File:Create Subscription 2 Details.png]]<br/>
+
3. '''Select '''User Attributes such as Created By, Modified by etc.
  
−
'''Template'''
+
4. '''Check&nbsp;'''the Action User box if necessary.
  
−
On the '''Template''' tab, define a template for user notifications and email notifications.<br/>
+
5. '''Select '''a desired user from the displayed list or search a user using the search bar.
  
−
:a. In the '''Template Subject''' box, type a relevant entity name for the template.<br/>
+
6.&nbsp;'''Click''' Add. The user name and role get added in the list.
 +
<div class="image-green-border">[[File:CreateSubscription - AddSender.png|600px]]</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>
 +
The details of added recipient are displayed in a tile, as shown the image below:
 +
<div class="image-green-border">[[File:AddedRecipientTile.png|200px]]</div>  
 +
7.&nbsp;'''Click''' Next. The Verify tab opens.
  
−
: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/>
+
'''Verify'''
  
−
:C. Click '''Next'''. The '''Recipient''' tab appears.<br/>
+
On this tab, verify all the information you entered for the Subscription.
  
−
[[File:Create Subscription 3 Template.png]]<br/>
+
'''Click'''&nbsp;"Create" to create the Subscription.
  
−
'''Recipient'''<br/>
+
[[File:CreateSubscription - Final.png|500px]]
  
−
On the '''Recipient''' tab, add recipients as follows:<br/>
+
Notifications will be sent as and when the respective event occurs.
  
−
:a. Click [[File: Add icon.jpeg]] next to '''Add Recipients'''.<br/>
+
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.
  
−
[[File: add rec.jpeg]]<br/>
+
== Configuring the associated document type for attachment&nbsp; ==
  
−
:b. In the '''Add Recipient''' dialogue box, select respective users.<br/>
+
ICI users can share the main agreement document as part of various email notifications that gettriggered for the agreement.In addition to the main agreement document, users can now send associated documents as part of various email notifications that get triggered for the agreement from time to time. Access tothese documents can be controlled based on the type of document – internal, external, or&nbsp;restricted. For example, some documents may only be shared with internal users, some may beshared with internal and external users, whereas some may not be shared with anyone.
  
−
:c. In the '''Select Roles''' list, click the appropriate role.<br/>
+
Now,&nbsp;
  
−
:d. In the '''Select User Attributes''' list, click the appropriate attributes, and select the '''Action User''' box.<br/>
+
*Administrators can tag the associated document contract type in the email notification&nbsp;template for agreements, assignment agreements, termination agreements, and&nbsp;amendments.&nbsp;
 +
*Users can define:&nbsp;
 +
**The type of notification as internal or external.&nbsp;
 +
**The type of associated document instance as internal, external, or restricted. 
 +
*Based on the type of notification and type of tagged associated documents, attachments&nbsp;are added to the email notification
  
−
:e. Select a user from the user tiles. You can use scroll arrows [[File: 400.jpeg]] to browse through the user tiles.<br/>
+
Users can configure the associated document to send in an email as an attachment with the base agreement by adding the global seeded attribute Type of Associated Document while creating or editing an Association contract type.
  
−
:f. Click '''Add'''. The user name and role appear as a tile.<br/>
+
To edit the Associated Document Contract Type:&nbsp;
  
−
:g. Click '''Next'''. The '''Verify''' tab appears.<br/>
+
1.&nbsp;'''Click'''&nbsp;"Configure" > Contract Types on the Home page. The Contract Types index page opens.
  
−
'''Verify'''<br/>
+
2.&nbsp;'''Click''' the "View Details" icon corresponding to the Associated Document contract type you want to edit. For example, ICMAnnexure1. The contract Type Details page opens.
 +
<div class="image-green-border">[[File:ListofContractTypes.png|720px]]</div>  
 +
3.&nbsp;'''Click''' Edit on the Contract Summary page. The Edit Contract Type page opens.
 +
<div class="image-green-border">[[File:EditingAContractType - Details.png|720px]]</div>
 +
4.&nbsp;'''Clik&nbsp;'''Next.&nbsp;The&nbsp;Attributes&nbsp;page opens.&nbsp;'''Select''' and add the attribute Type of Associated Document from the Available Attributes pane to the Select Attributes pane using the action arrows.
 +
<div class="image-green-border">[[File:EditingAContractType - Attributes.png|720px]]</div>
 +
5.&nbsp;'''Click&nbsp;'''Save.&nbsp;The&nbsp;Attribute saved successfully&nbsp;message is displayed.&nbsp;
  
−
On the '''Verify''' tab, verify all the information for the Subscription. <br/>
+
6.&nbsp;'''Click''' Next. The Associations tab opens.
  
−
[[File:Create Subscription 5 Verify.png]]<br/>
+
7.&nbsp;'''Enter''' the details on Association, Display Preference and Team tabs.
  
−
Click '''Save''' to create a '''Subscription'''. <br/>
+
8.&nbsp;'''Verify''' the details and '''click''' Update. The Associated Document contract type is updated with the Type of Associated Document attribute.
−
Once a subscription is created, notifications will be sent as and when the respective event occurs.
+
  
 +
== Configuring a notification subscription for association attachment&nbsp; ==
  
−
'''Related Topics:'''<br/>
+
Users can define and set the notification mode and tag the associated document as attachment for the notifications email while creating or editing the Notification Subscriptions.
−
[[Edit a Subscription]]<br/>
+
  
 +
To configure Notifications:&nbsp;
  
−
<link-page pagebefore="Edit_Notification_Categories|Edit Notification Categories" pageafter="Edit_a_Subscription | Edit a Subscription" />
+
1.&nbsp;'''Click''' Admin > Notification Settings > Subscription on the Home page. The Subscription page opens.
 +
<div class="image-green-border">[[File:AccessingSubsriptionMenu.png|650px]]</div>
 +
2. '''Click'''&nbsp;"Create". The "Create Subscription" page opens.
 +
 
 +
3.&nbsp;'''Enter''' the Template Name. For example, ClauseNotificationTest.
 +
 
 +
4.&nbsp;'''Enter''' the Entity Name for which you want to send notifications. For example, Clause.
 +
 
 +
5.&nbsp;'''Enter''' the Event Name to trigger notifications. For example, Clause Created.
 +
 
 +
6.&nbsp;'''Enter''' the Category Name. For example, Clause Notifications.
 +
 
 +
7.&nbsp;'''Enter''' the Notification Mode. For example, '''select''' Internal.
 +
 
 +
The available options are:&nbsp;
 +
 
 +
*Internal: select to send notifications to internal users.
 +
*External: select to send notifications to external users.&nbsp;
 +
<div class="image-green-border">[[File:CreateSubscription - Details.png|600px]]</div>
 +
8. '''Click''' Next. The Template page opens.
 +
 
 +
9.&nbsp;'''Tag''' the AssociatedDocAttachement attribute for associated documents in the Template. This enables the attachment of Associated Documents in notifications.
 +
<div class="note-box">'''Note''':&nbsp;The tag AssociatedDocAttachement supports attachments of associated documents in all ICI supported file formats.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:CreateSubscription - Template.png|600px]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''':&nbsp;The associated document tag AssociatedDocAttachement will only be available for selection and tagging in a Notification Template if enabled through technical configuration for an instance.</div>
 +
10.&nbsp;'''Click''' Add Recipients. The "Add Recipients" window opens.
 +
<div class="image-green-border">[[File:CreateSubscription - AddSender.png|600px]]</div>
 +
11. '''Select''' Attributes to send the notification to users added during the creation of an agreement instance. For example, External Signatory.
 +
 
 +
Configurators can also search and add users through&nbsp;Search User&nbsp;field.&nbsp;
 +
 
 +
12.&nbsp;'''Select&nbsp;'''Action User&nbsp;checkbox.&nbsp;
 +
<div class="image-green-border">[[File:AddSenderRecipient-Attributes.png|720px]]</div>
 +
13.&nbsp;'''Click''' Add. The user is added to the Subscription.&nbsp;
 +
<div class="image-green-border">[[File:AddSenderRecipient-Attributes.png|720px]]</div>
 +
14.&nbsp;'''Click''' Next. The Verify page opens.
 +
 
 +
15.&nbsp;'''Verify''' the details and '''click''' "Create". The Subscription is created.
 +
<div class="image-green-border">[[File:Subscription ContractType.png|500px]]</div>
 +
The configured subscription is displayed on the Subsriptions page.
 +
 
 +
== Defining a type of Association while creating Association instance ==
 +
 
 +
Users can define the attachment type for associated documents by setting the value in the Type of Associated Document attribute while creating a new association, editing the existing association from the Agreement Details page as well as from Association Management menu tile on the Home page.
 +
 
 +
To set the type of association while creating new association instance:&nbsp;
 +
 
 +
1. '''Click'''&nbsp;"Agreements" on the "Home" page.
 +
 
 +
2.&nbsp;'''Click''' the "View Details" icon corresponding to the agreement you want to open. For example, Master Services Agreement. The agreement Details page opens.
 +
 
 +
3.&nbsp;'''Expand''' the Associations tab in the left navigation pane.
 +
 
 +
4.&nbsp;'''Click''' the Create Association icon corresponding to the association you want to add to the agreement. For example, Annexure 1. The Create Association page opens.
 +
<div class="image-green-border">[[File:Agreements-Associations.png|720px]]</div>
 +
5. '''Select''' the file and upload in the Select File field. For example, Annexure 1 data.xlsx.
 +
 
 +
6.&nbsp;'''Select''' the value in the Type of Associated Document attribute. For example, select External.
 +
 
 +
The available options are&nbsp;:&nbsp;
 +
 
 +
*Internal: select to send notifications to internal users.
 +
*External: select to send notifications to external users.
 +
*Restricted: select to restrict the attachment of an associated document in notifications.
 +
 
 +
When Notification Mode is set as Internal in the Notification Subscription, Associated Documents will be attached in the notification email if the Type of Associated Document set as Internal or External and will not be attached if set as Restricted.&nbsp;<br/> When Notification Mode is set as External in the Notification Subscription, Associated Documents will be attached in the notification email only when the Type of Associated Document is also set as External and will not be attached if set as Internal or Restricted.<br/> 7.&nbsp;&nbsp;'''Enter''' other details.<br/> 8.&nbsp;'''Click''' Next.&nbsp;<br/> 9.&nbsp;Complete the creation of Association following the standard ICI workflow.<br/> 10. '''Publish''' and '''Approve''' the Agreement.
 +
 
 +
The notification will be sent with the attached associated documents to the intended users as per the configured notification subscription for the agreement.<br/> &nbsp;
 +
<div class="image-green-border">'''Related Topics''': [[Notification_Settings|Notification Settings]] |&nbsp;[[User_Administration|User_Administration]] | [[Create_Notification_Categories|Creating Notification Categories]] | [[Create_a_Notification_Rule|Create_a_Notification_Rule]]</div>

Latest revision as of 11:37, 20 January 2022

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" option under "Admin" tile and then click "Subscription". The "Subscriptions" page opens. All the existing subscriptions are displayed on this page such as Agreement Notifications, Clause Notifications. Each subscription groups has various notification templates of various events that fit into the respective category. You can also edit or delete the displayed categories.

2. Click "Create" on the "Subscriptions" page. The "Create Subscription" page opens. 

There are four tabs on this page:

  • Details
  • Template
  • Recipient
  • Verify
AccessingSubsriptionMenu.png
 
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 different 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.
CreateSubscription - Details.png

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 opens.
CreateSubscription - Template.png

Sender/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.

CreateSubscription - AddSender.png
 
Note: You can tag users in the Notifications Template using their usernames or Email IDs.

The details of added recipient are displayed in a tile, as shown the image below:

AddedRecipientTile.png

7. Click Next. The Verify tab opens.

Verify

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

Click "Create" to create the Subscription.

CreateSubscription - Final.png

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.

Configuring the associated document type for attachment 

ICI users can share the main agreement document as part of various email notifications that gettriggered for the agreement.In addition to the main agreement document, users can now send associated documents as part of various email notifications that get triggered for the agreement from time to time. Access tothese documents can be controlled based on the type of document – internal, external, or restricted. For example, some documents may only be shared with internal users, some may beshared with internal and external users, whereas some may not be shared with anyone.

Now, 

  • Administrators can tag the associated document contract type in the email notification template for agreements, assignment agreements, termination agreements, and amendments. 
  • Users can define: 
    • The type of notification as internal or external. 
    • The type of associated document instance as internal, external, or restricted.
  • Based on the type of notification and type of tagged associated documents, attachments are added to the email notification

Users can configure the associated document to send in an email as an attachment with the base agreement by adding the global seeded attribute Type of Associated Document while creating or editing an Association contract type.

To edit the Associated Document Contract Type: 

1. Click "Configure" > Contract Types on the Home page. The Contract Types index page opens.

2. Click the "View Details" icon corresponding to the Associated Document contract type you want to edit. For example, ICMAnnexure1. The contract Type Details page opens.

ListofContractTypes.png

3. Click Edit on the Contract Summary page. The Edit Contract Type page opens.

EditingAContractType - Details.png

4. Clik Next. The Attributes page opens. Select and add the attribute Type of Associated Document from the Available Attributes pane to the Select Attributes pane using the action arrows.

EditingAContractType - Attributes.png

5. Click Save. The Attribute saved successfully message is displayed. 

6. Click Next. The Associations tab opens.

7. Enter the details on Association, Display Preference and Team tabs.

8. Verify the details and click Update. The Associated Document contract type is updated with the Type of Associated Document attribute.

Configuring a notification subscription for association attachment 

Users can define and set the notification mode and tag the associated document as attachment for the notifications email while creating or editing the Notification Subscriptions.

To configure Notifications: 

1. Click Admin > Notification Settings > Subscription on the Home page. The Subscription page opens.

AccessingSubsriptionMenu.png

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

3. Enter the Template Name. For example, ClauseNotificationTest.

4. Enter the Entity Name for which you want to send notifications. For example, Clause.

5. Enter the Event Name to trigger notifications. For example, Clause Created.

6. Enter the Category Name. For example, Clause Notifications.

7. Enter the Notification Mode. For example, select Internal.

The available options are: 

  • Internal: select to send notifications to internal users.
  • External: select to send notifications to external users. 
CreateSubscription - Details.png

8. Click Next. The Template page opens.

9. Tag the AssociatedDocAttachement attribute for associated documents in the Template. This enables the attachment of Associated Documents in notifications.

Note: The tag AssociatedDocAttachement supports attachments of associated documents in all ICI supported file formats.
 
CreateSubscription - Template.png
 
 
Note: The associated document tag AssociatedDocAttachement will only be available for selection and tagging in a Notification Template if enabled through technical configuration for an instance.

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

CreateSubscription - AddSender.png

11. Select Attributes to send the notification to users added during the creation of an agreement instance. For example, External Signatory.

Configurators can also search and add users through Search User field. 

12. Select Action User checkbox. 

AddSenderRecipient-Attributes.png

13. Click Add. The user is added to the Subscription. 

AddSenderRecipient-Attributes.png

14. Click Next. The Verify page opens.

15. Verify the details and click "Create". The Subscription is created.

Subscription ContractType.png

The configured subscription is displayed on the Subsriptions page.

Defining a type of Association while creating Association instance

Users can define the attachment type for associated documents by setting the value in the Type of Associated Document attribute while creating a new association, editing the existing association from the Agreement Details page as well as from Association Management menu tile on the Home page.

To set the type of association while creating new association instance: 

1. Click "Agreements" on the "Home" page.

2. Click the "View Details" icon corresponding to the agreement you want to open. For example, Master Services Agreement. The agreement Details page opens.

3. Expand the Associations tab in the left navigation pane.

4. Click the Create Association icon corresponding to the association you want to add to the agreement. For example, Annexure 1. The Create Association page opens.

Agreements-Associations.png

5. Select the file and upload in the Select File field. For example, Annexure 1 data.xlsx.

6. Select the value in the Type of Associated Document attribute. For example, select External.

The available options are : 

  • Internal: select to send notifications to internal users.
  • External: select to send notifications to external users.
  • Restricted: select to restrict the attachment of an associated document in notifications.

When Notification Mode is set as Internal in the Notification Subscription, Associated Documents will be attached in the notification email if the Type of Associated Document set as Internal or External and will not be attached if set as Restricted. 
When Notification Mode is set as External in the Notification Subscription, Associated Documents will be attached in the notification email only when the Type of Associated Document is also set as External and will not be attached if set as Internal or Restricted.
7.  Enter other details.
8. Click Next. 
9. Complete the creation of Association following the standard ICI workflow.
10. Publish and Approve the Agreement.

The notification will be sent with the attached associated documents to the intended users as per the configured notification subscription for the agreement.
 

Related Topics: Notification Settings | User_Administration | Creating Notification Categories | Create_a_Notification_Rule
Retrieved from "https://iciwikiapac.icertis.com:443/ICIHelp8.2/index.php?title=Create_a_Subscription&oldid=22868"