From ICIHelp8.1
Jump to: navigation, search
(Created page with " = Overview of ICM Bot = ICM Bot is a multichannel communication software application that allows users to interact with ICM in natural language. You can perform certa...")
 
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
  
 +
= Overview of ICI Bot =
  
 +
ICI Bot is a multichannel communication software application that allows users to interact with ICI in natural language. You can perform certain actions using ICI Bot  without logging on to ICI. Currently, the Email channel and Microsoft Teams are available, however other channels such as Skype will be made available in the future.
  
= Overview of ICM Bot =
+
ICI Bot&nbsp; identifies the purpose of your task from the emails you send to it. The sentences you compose in the email are analyzed to separate the data and identify your intent.<br/> You can draft your emails to ICI Bot&nbsp;as follows:
 
+
ICM Bot&nbsp;is a multichannel communication software application that allows users to interact with ICM in natural language. You can perform certain actions using ICM Bot&nbsp; without logging on to ICM. Currently, the&nbsp;Email channel and Microsoft Teams are available, however other channels such as Skype will be made available in the future.
+
 
+
ICM Bot&nbsp; identifies the purpose of your task from the emails you send to it. The sentences you compose in the email are analyzed to separate the data and identify your intent.<br/> You can draft your emails to ICM Bot&nbsp;as follows:
+
  
 
*Subject lines are not mandatory. However, for future reference, providing a subject line each time a conversation is initiated, makes it easier to consolidate all the communication with Bot&nbsp;under a single subject.&nbsp;  
 
*Subject lines are not mandatory. However, for future reference, providing a subject line each time a conversation is initiated, makes it easier to consolidate all the communication with Bot&nbsp;under a single subject.&nbsp;  
 
*Body of the email must contain queries in simple English (see examples below).  
 
*Body of the email must contain queries in simple English (see examples below).  
*Every email must conclude with /icmbot on the last line, before your signature.  
+
*Every email must conclude with /icibot on the last line, before your signature.  
  
Use ICM BOT by sending emails through any email client to perform a task. ICM Bot&nbsp; understands simple, plain English. For example, if you want to search for specific agreements within ICM, you can instruct ICM Bot&nbsp; in the email client to perform the search for you. You don’t have to log on to ICM to perform the search manually. The Bot&nbsp; performs a search and responds to your email with a list of agreements that match your defined criteria.
+
Use ICI BOT by sending emails through any email client to perform a task. ICI Bot&nbsp; understands simple, plain English. For example, if you want to search for specific agreements within ICI, you can instruct ICI Bot&nbsp; in the email client to perform the search for you. You don’t have to log on to ICI to perform the search manually. The Bot&nbsp; performs a search and responds to your email with a list of agreements that match your defined criteria.
  
Icertis Support or Professional Services (PS) teams will configure and communicate the email address which you need for using the ICM Bot. If you need any help using the Bot, send an email to the configured email address with ''/help'' in the body of your email. You can get the email ID from your PS team.
+
Icertis Support or Professional Services (PS) teams will configure and communicate the email address which you need for using the ICI Bot. If you need any help using the Bot, send an email to the configured email address with ''/help'' in the body of your email. You can get the email ID from your PS team.
  
ICM Bot&nbsp; saves you time by automating simple and repetitive tasks, allowing you to focus on other complex tasks in ICM.
+
ICI Bot&nbsp; saves you time by automating simple and repetitive tasks, allowing you to focus on other complex tasks in ICI.
  
== Prerequisites for using ICM Bot ==
+
== Prerequisites for using ICI Bot ==
  
*Users must be provisioned to use the ICM Bot&nbsp;services&nbsp;(users must be provisioned in ICM)  
+
*Users must be provisioned to use the ICI Bot&nbsp;services&nbsp;(users must be provisioned in ICI)  
*Only users provisioned in ICM can be configured for ICM Bot&nbsp; (Users must be configured to use ICM Bot&nbsp;)  
+
*Only users provisioned in ICI can be configured for ICI Bot&nbsp; (Users must be configured to use ICI Bot&nbsp;)  
  
== Configuring ICM Bot&nbsp;for ICM Users ==
+
== Configuring ICI Bot&nbsp;for ICI Users ==
  
An ICM user with administrative privileges can configure the users for ICM Bot&nbsp; services. To configure:
+
An ICI user with administrative privileges can configure the users for ICI Bot&nbsp; services. To configure:
  
 
1. '''Click'''&nbsp;the&nbsp;''Configuration''&nbsp;tile on&nbsp;My Dashboard. This opens the&nbsp;''Configuration''&nbsp;page.
 
1. '''Click'''&nbsp;the&nbsp;''Configuration''&nbsp;tile on&nbsp;My Dashboard. This opens the&nbsp;''Configuration''&nbsp;page.
Line 33: Line 31:
 
3.&nbsp;'''Click''' [[File:]]the&nbsp;&nbsp;icon next to&nbsp;''BotUserInclusionList''. This opens the&nbsp;''Masterdata Details''&nbsp;page.
 
3.&nbsp;'''Click''' [[File:]]the&nbsp;&nbsp;icon next to&nbsp;''BotUserInclusionList''. This opens the&nbsp;''Masterdata Details''&nbsp;page.
  
4.&nbsp;'''Click'''&nbsp;''Edit&nbsp;''to add the email address of a user that needs to be configured into ICM.
+
4.&nbsp;'''Click'''&nbsp;''Edit&nbsp;''to add the email address of a user that needs to be configured into ICI.
  
 
5. '''Enter''' the user’s email address in the&nbsp;''UserAccessList''&nbsp;field.&nbsp;
 
5. '''Enter''' the user’s email address in the&nbsp;''UserAccessList''&nbsp;field.&nbsp;
 
<div class="note-box">'''Note''': You can enter multiple email addresses separated by commas.</div>  
 
<div class="note-box">'''Note''': You can enter multiple email addresses separated by commas.</div>  
6. '''Click'''&nbsp;''Update''. The specified users are now configured to use the ICM Bot&nbsp;services.
+
6. '''Click'''&nbsp;''Update''. The specified users are now configured to use the ICI Bot&nbsp;services.
  
== Tasks Performed by ICM Bot ==
+
== Tasks Performed by ICI Bot ==
  
You&nbsp;can instruct ICM Bot&nbsp; to perform the following tasks:
+
You&nbsp;can instruct ICI Bot&nbsp; to perform the following tasks:
  
 
*Retrieve your pending tasks  
 
*Retrieve your pending tasks  
Line 50: Line 48:
 
*Upload Documents for an Agreement  
 
*Upload Documents for an Agreement  
  
== Searching Agreements using ICM Bot ==
+
== Searching Agreements using ICI Bot ==
  
You can search Agreements for your search criteria. Searching agreements using ICM Bot&nbsp;is similar to looking for Agreements on the ICM Search page.
+
You can search Agreements for your search criteria. Searching agreements using ICI Bot&nbsp;is similar to looking for Agreements on the ICI Search page.
  
To search for Agreements, send an email to the ICM Bot&nbsp; with the following query:
+
To search for Agreements, send an email to the ICI Bot&nbsp; with the following query:
  
 
{| border="1" cellpadding="1" cellspacing="1"
 
{| border="1" cellpadding="1" cellspacing="1"
Line 68: Line 66:
  
 
!  
 
!  
'''ICM Bot's response:'''
+
'''ICI Bot's response:'''
  
 
|-
 
|-
Line 79: Line 77:
 
'''X''' is the search word. It can be a customer name, an Agreement name, and so on.
 
'''X''' is the search word. It can be a customer name, an Agreement name, and so on.
 
</blockquote>  
 
</blockquote>  
X and the Agreement are the search criteria for searching agreements in ICM.
+
X and the Agreement are the search criteria for searching agreements in ICI.
  
 
|  
 
|  
Do we have any ACME Agreement on record?<br/> /icmbot
+
Do we have any ACME Agreement on record?<br/> /icibot
  
Search for ACME agreement<br/> /icmbot
+
Search for ACME agreement<br/> /icibot
  
 
| Bot responds with a list of agreements matching ACME
 
| Bot responds with a list of agreements matching ACME
 
|}
 
|}
  
== Creating Agreements using ICM Bot ==
+
== Creating Agreements using ICI Bot ==
  
You can use the ICMBot&nbsp;to create an agreement for Contract Types that are not complex. You can create agreements from Contract Types:
+
You can use the ICIBot&nbsp;to create an agreement for Contract Types that are not complex. You can create agreements from Contract Types:
  
*that are configured in ICM Bot&nbsp;  
+
*that are configured in ICI Bot&nbsp;  
 
*with default templates (not where the template selection is required)  
 
*with default templates (not where the template selection is required)  
  
 
You must complete the entire process of creating an Agreement in a single email thread. For example, you cannot retrieve the pending tasks by replying to the email that you sent for creating the agreement.
 
You must complete the entire process of creating an Agreement in a single email thread. For example, you cannot retrieve the pending tasks by replying to the email that you sent for creating the agreement.
  
Creating an agreement is a multi-step process, in which ICM Bot&nbsp;guides you through each step. Creating an Agreement using ICM Bot&nbsp;includes the following steps:
+
Creating an agreement is a multi-step process, in which ICI Bot&nbsp;guides you through each step. Creating an Agreement using ICI Bot&nbsp;includes the following steps:
  
 
#Initiating the Agreement  
 
#Initiating the Agreement  
Line 106: Line 104:
 
=== Initiating the Agreement ===
 
=== Initiating the Agreement ===
  
Create an Agreement by sending an email to ICM Bot. You can create an Agreement using ICM Bot&nbsp;and publish it through ICM.
+
Create an Agreement by sending an email to ICI Bot. You can create an Agreement using ICI Bot&nbsp;and publish it through ICI.
  
 
Start creating the Agreement using this query:
 
Start creating the Agreement using this query:
Line 122: Line 120:
  
 
!  
 
!  
'''ICM Bot's response'''
+
'''ICI Bot's response'''
  
 
|-
 
|-
Line 132: Line 130:
  
 
|  
 
|  
I want to create an agreement<br/> /icmbot
+
I want to create an agreement<br/> /icibot
  
| ICM Bot responds to specify the Contract Type
+
| ICI Bot responds to specify the Contract Type
 
|}
 
|}
  
 
=== Selecting the Contract Type ===
 
=== Selecting the Contract Type ===
  
After you initiate the Agreement (step 1), ICM Bot&nbsp;responds by sending the available Contract Types. The list only contains those Contract Types that are configured in ICM Bot&nbsp;and not the list of Contract Types that are configured in the ICM application. Select a Contract Type by sending an email with one of the following queries:
+
After you initiate the Agreement (step 1), ICI Bot&nbsp;responds by sending the available Contract Types. The list only contains those Contract Types that are configured in ICI Bot&nbsp;and not the list of Contract Types that are configured in the ICI application. Select a Contract Type by sending an email with one of the following queries:
  
 
{| border="1" cellpadding="1" cellspacing="1"
 
{| border="1" cellpadding="1" cellspacing="1"
Line 151: Line 149:
  
 
!  
 
!  
'''ICM Bot's response'''
+
'''ICI Bot's response'''
  
 
|-
 
|-
Line 158: Line 156:
  
 
|  
 
|  
I want to use '''X''' with type of paper "'''Y'''".<br/> /icmbot
+
I want to use '''X''' with type of paper "'''Y'''".<br/> /icibot
  
 
'''where:'''
 
'''where:'''
Line 167: Line 165:
 
</blockquote>  
 
</blockquote>  
 
|  
 
|  
I want to use 1 with type of paper "Own". /icmbot
+
I want to use 1 with type of paper "Own". /icibot
  
| ICM Bot responds with a list of attributes
+
| ICI Bot responds with a list of attributes
 
|-
 
|-
 
| Create an agreement with Third Party type of paper
 
| Create an agreement with Third Party type of paper
 
|  
 
|  
I want to use '''X''' with type of paper '''Y'''.<br/> /icmbot
+
I want to use '''X''' with type of paper '''Y'''.<br/> /icibot
  
 
'''where:'''
 
'''where:'''
Line 181: Line 179:
 
'''Y '''is the type of paper.
 
'''Y '''is the type of paper.
 
</blockquote>  
 
</blockquote>  
| I want to you use 1 with type of paper "Third Party".<br/> /icmbot
+
| I want to you use 1 with type of paper "Third Party".<br/> /icibot
| ICM Bot responds with a list of attributes
+
| ICI Bot responds with a list of attributes
 
|}
 
|}
  
 
=== Filling in the Attribute Details ===
 
=== Filling in the Attribute Details ===
  
After you select the Contract Type, ICM Bot sends a list of attributes to you. This list contains mandatory and optional attributes and a hint, wherever possible. Reply by filling in the values of the attributes in the table.
+
After you select the Contract Type, ICI Bot sends a list of attributes to you. This list contains mandatory and optional attributes and a hint, wherever possible. Reply by filling in the values of the attributes in the table.
  
 
{| border="1" cellpadding="1" cellspacing="1"
 
{| border="1" cellpadding="1" cellspacing="1"
Line 215: Line 213:
 
|}
 
|}
  
== Retrieving&nbsp;your Pending Tasks using ICM Bot ==
+
== Retrieving&nbsp;your Pending Tasks using ICI Bot ==
  
 
You can retrieve a specific or all your pending tasks by sending the following query in the body of your email:
 
You can retrieve a specific or all your pending tasks by sending the following query in the body of your email:
Line 231: Line 229:
  
 
|  
 
|  
'''ICM Bot's response:'''
+
'''ICI Bot's response:'''
  
 
|-
 
|-
Line 241: Line 239:
  
 
|  
 
|  
Any pending tasks for me?<br/> /icmbot
+
Any pending tasks for me?<br/> /icibot
  
Anything pending for me?<br/> /icmbot
+
Anything pending for me?<br/> /icibot
  
| ICM Bot responds with a list of your pending tasks
+
| ICI Bot responds with a list of your pending tasks
 
|-
 
|-
 
|  
 
|  
Line 254: Line 252:
  
 
|  
 
|  
Any tasks pending for approval?<br/> /icmbot
+
Any tasks pending for approval?<br/> /icibot
  
Anything for me to approve?<br/> /icmbot
+
Anything for me to approve?<br/> /icibot
  
| ICM Bot responds with a list of your pending approval tasks
+
| ICI Bot responds with a list of your pending approval tasks
 
|-
 
|-
 
| &nbsp;
 
| &nbsp;
 
| Tasks pending for review
 
| Tasks pending for review
 
|  
 
|  
Any tasks pending for review?<br/> /icmbot
+
Any tasks pending for review?<br/> /icibot
  
Anything for me to review?<br/> /icmbot
+
Anything for me to review?<br/> /icibot
  
| ICM Bot responds with a list of your pending review tasks
+
| ICI Bot responds with a list of your pending review tasks
 
|}
 
|}
  
== Approving and Rejecting Tasks using ICM Bot ==
+
== Approving and Rejecting Tasks using ICI Bot ==
  
To approve or reject tasks, you must first request a list of your pending tasks. This step depends on the query you send to retrieve pending tasks (as shown above). Reply to the same email in which you received your pending tasks. It is important to use the same email thread, or ICM Bot&nbsp;may run into issues.
+
To approve or reject tasks, you must first request a list of your pending tasks. This step depends on the query you send to retrieve pending tasks (as shown above). Reply to the same email in which you received your pending tasks. It is important to use the same email thread, or ICI Bot&nbsp;may run into issues.
  
Reply to the ICM Bot’s email with the list of your pending tasks, as follows:
+
Reply to the ICI Bot’s email with the list of your pending tasks, as follows:
  
 
{| border="1" cellpadding="1" cellspacing="1"
 
{| border="1" cellpadding="1" cellspacing="1"
Line 288: Line 286:
  
 
!  
 
!  
'''ICM Bot's response:'''
+
'''ICI Bot's response:'''
  
 
|-
 
|-
Line 297: Line 295:
 
Please approve '''X '''with a note "'''Add Notes'''",&nbsp;where:
 
Please approve '''X '''with a note "'''Add Notes'''",&nbsp;where:
 
<blockquote>
 
<blockquote>
'''X''' is the serial number of the record. Replace '''X''' with the serial number of the record (from ICM Bot’s email) you wish to approve.
+
'''X''' is the serial number of the record. Replace '''X''' with the serial number of the record (from ICI Bot’s email) you wish to approve.
 
</blockquote>  
 
</blockquote>  
 
Add your note in the '''Add Notes'''section
 
Add your note in the '''Add Notes'''section
  
 
|  
 
|  
Approve 1 with a note “approved, subject to additional details”<br/> /icmbot
+
Approve 1 with a note “approved, subject to additional details”<br/> /icibot
  
| ICM Bot responds that the task is Approved
+
| ICI Bot responds that the task is Approved
 
|-
 
|-
 
| Reject tasks
 
| Reject tasks
Line 315: Line 313:
  
 
|  
 
|  
Please reject 3 with a note "rejected, important details missing."<br/> /icmbot
+
Please reject 3 with a note "rejected, important details missing."<br/> /icibot
  
| ICM Bot responds that the task is rejected
+
| ICI Bot responds that the task is rejected
 
|}
 
|}
  
== Downloading Agreement Documents using ICM Bot ==
+
== Downloading Agreement Documents using ICI Bot ==
  
You can download the documents of any agreement through ICM Bot. The document are sent by the ICM Bot as an attachment.
+
You can download the documents of any agreement through ICI Bot. The document are sent by the ICI Bot as an attachment.
  
 
'''Note''': You will only get the Associated Document if the download function is available,&nbsp;depending on your privileges and the state the Agreement is in.
 
'''Note''': You will only get the Associated Document if the download function is available,&nbsp;depending on your privileges and the state the Agreement is in.
Line 331: Line 329:
 
*Searching for the Agreement  
 
*Searching for the Agreement  
 
<ol start="2">
 
<ol start="2">
<li>To respond to the email that you receive from ICM Bot for your pending task, send any one of the following queries:</li>
+
<li>To respond to the email that you receive from ICI Bot for your pending task, send any one of the following queries:</li>
 
</ol>
 
</ol>
  
Line 346: Line 344:
  
 
!  
 
!  
'''ICM Bot's response:'''
+
'''ICI Bot's response:'''
  
 
|-
 
|-
Line 362: Line 360:
 
</blockquote>  
 
</blockquote>  
 
|  
 
|  
Please send me 1<br/> /icmbot
+
Please send me 1<br/> /icibot
  
Can you send me 1?&nbsp; &nbsp; &nbsp; &nbsp; /icmbot
+
Can you send me 1?&nbsp; &nbsp; &nbsp; &nbsp; /icibot
  
| ICM Bot downloads the requested agreement document and sends them as attachment.
+
| ICI Bot downloads the requested agreement document and sends them as attachment.
 
|}
 
|}
  
 
&nbsp;
 
&nbsp;
  
== Uploading Documents using ICM Bot ==
+
== Uploading Documents using ICI Bot ==
 +
 
 +
You can upload documents to an existing agreement directly from ICI Bot.
  
You can upload documents to an existing agreement directly from ICM Bot. To upload documents:
+
To upload documents:
  
 
#Send email for either one of the following:  
 
#Send email for either one of the following:  
Line 396: Line 396:
  
 
!  
 
!  
'''ICM Bot's response:'''
+
'''ICI Bot's response:'''
  
 
|-
 
|-
Line 408: Line 408:
 
</blockquote>  
 
</blockquote>  
 
|  
 
|  
Upload the attached document to 1<br/> /icmbot
+
Upload the attached document to 1<br/> /icibot
  
| ICM Bot replies that the document is successfully uploaded
+
| ICI Bot replies that the document is successfully uploaded
 
|}
 
|}
  
== Error Scenarios in ICM Bot ==
+
== Error Scenarios in ICI Bot ==
  
In case of errors or validation issues, ICM Bot tries to send relative responses. Only in cases where ICM Bot is not able to figure out the reason for the error, such as Internal Server Error from ICM, does it send a generic error response.
+
In case of errors or validation issues, ICI Bot tries to send relative responses. Only in cases where ICI Bot is not able to figure out the reason for the error, such as Internal Server Error from ICI, does it send a generic error response.
  
 
=== Invalid Message ===
 
=== Invalid Message ===
  
*'''Scenario''': You forgot to include /icmbot at the end of your previous email or you misspelt the command.  
+
*'''Scenario''': You forgot to include /icibot at the end of your previous email or you misspelt the command.  
*'''Error''': ICM Bot sends a message indicating that it did not find /icmbot on a new line in an email.  
+
*'''Error''': ICI Bot sends a message indicating that it did not find /icibot on a new line in an email.  
  
 
=== Invalid sequence of query ===
 
=== Invalid sequence of query ===
  
 
*'''Scenario''': All queries must follow a certain sequence, such as a query of pending tasks before trying to approve an agreement. Alternatively, changing the sequence during an ongoing conversation, also results in this error. For example,&nbsp;while creating an Agreement, you should first send a query to create an agreement, then select Contract Type and fill in the attributes. You cannot send a query to approve an agreement in between.  
 
*'''Scenario''': All queries must follow a certain sequence, such as a query of pending tasks before trying to approve an agreement. Alternatively, changing the sequence during an ongoing conversation, also results in this error. For example,&nbsp;while creating an Agreement, you should first send a query to create an agreement, then select Contract Type and fill in the attributes. You cannot send a query to approve an agreement in between.  
*'''Error''': ICM BOT requests you to send a query in a new email thread and start a new conversation. You should follow the proper sequence to complete your query.  
+
*'''Error''': ICI BOT requests you to send a query in a new email thread and start a new conversation. You should follow the proper sequence to complete your query.  
  
 
=== User Permissions ===
 
=== User Permissions ===
  
*'''Scenario''': You are not provisioned or configured for ICM Bot services.  
+
*'''Scenario''': You are not provisioned or configured for ICI Bot services.  
*'''Error''': ICM Bot sends a response indicating that either you do not have permission or are not configured to access the Bot services.  
+
*'''Error''': ICI Bot sends a response indicating that either you do not have permission or are not configured to access the Bot services.  
  
 
&nbsp;
 
&nbsp;
  
= Integration with Collaboration Tool MS Teams using ICM Bot =
+
= Integration with Collaboration Tool MS Teams using ICI Bot =
  
By integrating the ICM platform with MS Teams, users can collaborate for contract authoring, negotiations, etc. This not only provides a better, seamless user experience, but also helps to discuss ideas, and in turn significantly improve the cycle time.
+
By integrating the ICI platform with MS Teams, users can collaborate for contract authoring, negotiations, etc. This not only provides a better, seamless user experience, but also helps to discuss ideas, and in turn significantly improve the cycle time.
  
 
Through this integration, we support:
 
Through this integration, we support:
  
*Invoking ICM Bot in the Teams app  
+
*Invoking ICI Bot in the Teams app  
*Querying My Pending Tasks using the ICM Bot to be able to collaborate with others and take decisions on pending tasks and expedite the contracting process  
+
*Querying My Pending Tasks using the ICI Bot to be able to collaborate with others and take decisions on pending tasks and expedite the contracting process  
*Searching for Agreements using ICM Bot so that the user can find the relevant, share their status and make informed decisions  
+
*Searching for Agreements using ICI Bot so that the user can find the relevant, share their status and make informed decisions  
*Using ICM Bot to get answers to frequently asked questions  
+
*Using ICI Bot to get answers to frequently asked questions  
  
 
&nbsp;
 
&nbsp;
  
=== Installing the ICM Bot App ===
+
=== Installing the ICI Bot App ===
  
The ICM Bot app can be installed from the Additional apps on the App store. Once inside the app, you can type your questions. ICM Bot retrieves the logged in user’s information and displays responses based on the authorization in the Security Groups. If the user invoking ICM Bot does not have a valid ICM account, then you will get a message indicating that your ICM profile could not be found and you need to contact the ICM Administrator.
+
The ICI Bot app can be installed from the Additional apps on the App store. Once inside the app, you can type your questions. ICI Bot retrieves the logged in user’s information and displays responses based on the authorization in the Security Groups. If the user invoking ICI Bot does not have a valid ICI account, then you will get a message indicating that your ICI profile could not be found and you need to contact the ICI Administrator.
  
'''Note:''' To get the ICM Bot app in App store, the ICM Bot needs to set up in your environment by the ICM Administrator.
+
'''Note:''' To get the ICI Bot app in App store, the ICI Bot needs to set up in your environment by the ICI Administrator.
<div class="image-green-border">[[File:7.9 ICM Bot 1.png|720px|7.9 ICM Bot 1]]</div> <div class="image-green-border">&nbsp;</div>  
+
<div class="image-green-border">[[File:7.9 ICM Bot 1 7.16.png|720px]]</div> <div class="image-green-border">&nbsp;</div>  
=== Using ICM Bot to find Agreements ===
+
=== Using ICI Bot to find Agreements ===
  
The Bot is integrated with ICM using ICM APIs. The Bot accepts the NLP (Natural Language Processing) queries from the user through MS Teams&nbsp;and displays the results based on the search criteria.&nbsp;
+
The Bot is integrated with ICI using ICI APIs. The Bot accepts the NLP (Natural Language Processing) queries from the user through MS Teams&nbsp;and displays the results based on the search criteria.&nbsp;
  
 
In the 7.9&nbsp;release, performing a text based search for Agreements is supported. For example, ''A query to the bot ’''find msa with microsoft’ will list all the agreements where words ‘msa’ and ‘microsoft’ are present.
 
In the 7.9&nbsp;release, performing a text based search for Agreements is supported. For example, ''A query to the bot ’''find msa with microsoft’ will list all the agreements where words ‘msa’ and ‘microsoft’ are present.
<div class="image-green-border">[[File:7.9 ICM Bot 3.png|720px|7.9 ICM Bot 3]]</div> <div class="image-green-border">&nbsp;</div>  
+
<div class="image-green-border">[[File:7.9 ICM Bot 3 7.16.png|720px]]</div> <div class="image-green-border">&nbsp;</div>  
=== Using ICM Bot to query for My Pending Tasks&nbsp; ===
+
=== Using ICI Bot to query for My Pending Tasks&nbsp; ===
  
Based on the query, ICM Bot renders the top 5 results in the chat window along with a link to the ICM search results page. The top 5 results display the URL to the respective Agreement. These results are the same as those that will be available through the Advanced Search page in ICM. Clicking the hyperlink next to the Agreement name will navigate you to the Agreement to take necessary action.
+
Based on the query, ICI Bot renders the top 5 results in the chat window along with a link to the ICI search results page. The top 5 results display the URL to the respective Agreement. These results are the same as those that will be available through the Advanced Search page in ICI. Clicking the hyperlink next to the Agreement name will navigate you to the Agreement to take necessary action.
<div class="image-green-border">[[File:7.9 ICM Bot 4.png|720px|7.9 ICM Bot 4]]</div> <div class="image-green-border">&nbsp;</div>  
+
<div class="image-green-border">[[File:7.9 ICM Bot 4 7.16.png|720px]]</div> <div class="image-green-border">&nbsp;</div>  
=== Using ICM Bot for general FAQ ===
+
=== Using ICI Bot for general FAQ ===
  
The ICM Bot provides answers based on the predefined Knowledge Base. In case the knowledge base does not have the query defines, ICM Bot displays a message indicating that there are no current responses to the query.
+
The ICI Bot provides answers based on the predefined Knowledge Base. In case the knowledge base does not have the query defines, ICI Bot displays a message indicating that there are no current responses to the query.
<div class="image-green-border">[[File:7.9 ICM Bot 5.png|720px|7.9 ICM Bot 5]]</div>  
+
<div class="image-green-border">[[File:7.9 ICM Bot 5 7.16.png|720px]]</div>  
 
&nbsp;
 
&nbsp;
  
Line 473: Line 473:
 
&nbsp;
 
&nbsp;
  
'''Related Topics:'''&nbsp;[[Agreement_Management|Agreement_Management]]
+
'''Related Topics:'''&nbsp;[[Agreement_Management|Agreement Management]]&nbsp;|&nbsp;[[Release_Notes|Release Notes]]&nbsp;|

Latest revision as of 05:29, 10 June 2021

Overview of ICI Bot

ICI Bot is a multichannel communication software application that allows users to interact with ICI in natural language. You can perform certain actions using ICI Bot  without logging on to ICI. Currently, the Email channel and Microsoft Teams are available, however other channels such as Skype will be made available in the future.

ICI Bot  identifies the purpose of your task from the emails you send to it. The sentences you compose in the email are analyzed to separate the data and identify your intent.
You can draft your emails to ICI Bot as follows:

  • Subject lines are not mandatory. However, for future reference, providing a subject line each time a conversation is initiated, makes it easier to consolidate all the communication with Bot under a single subject. 
  • Body of the email must contain queries in simple English (see examples below).
  • Every email must conclude with /icibot on the last line, before your signature.

Use ICI BOT by sending emails through any email client to perform a task. ICI Bot  understands simple, plain English. For example, if you want to search for specific agreements within ICI, you can instruct ICI Bot  in the email client to perform the search for you. You don’t have to log on to ICI to perform the search manually. The Bot  performs a search and responds to your email with a list of agreements that match your defined criteria.

Icertis Support or Professional Services (PS) teams will configure and communicate the email address which you need for using the ICI Bot. If you need any help using the Bot, send an email to the configured email address with /help in the body of your email. You can get the email ID from your PS team.

ICI Bot  saves you time by automating simple and repetitive tasks, allowing you to focus on other complex tasks in ICI.

Prerequisites for using ICI Bot

  • Users must be provisioned to use the ICI Bot services (users must be provisioned in ICI)
  • Only users provisioned in ICI can be configured for ICI Bot  (Users must be configured to use ICI Bot )

Configuring ICI Bot for ICI Users

An ICI user with administrative privileges can configure the users for ICI Bot  services. To configure:

1. Click the Configuration tile on My Dashboard. This opens the Configuration page.

2. Click the Masterdata tile on the Configuration page. This displays all the types of Masterdata.

3. Click [[File:]]the  icon next to BotUserInclusionList. This opens the Masterdata Details page.

4. Click Edit to add the email address of a user that needs to be configured into ICI.

5. Enter the user’s email address in the UserAccessList field. 

Note: You can enter multiple email addresses separated by commas.

6. Click Update. The specified users are now configured to use the ICI Bot services.

Tasks Performed by ICI Bot

You can instruct ICI Bot  to perform the following tasks:

  • Retrieve your pending tasks
  • Approve or Reject a task
  • Search Agreements
  • Download agreement documents
  • Create Agreements
  • Upload Documents for an Agreement

Searching Agreements using ICI Bot

You can search Agreements for your search criteria. Searching agreements using ICI Bot is similar to looking for Agreements on the ICI Search page.

To search for Agreements, send an email to the ICI Bot  with the following query:

Action:

Such as:

Sample of email to send:

ICI Bot's response:

Search for Agreements

Do we have any X Agreement on record? where:

X is the search word. It can be a customer name, an Agreement name, and so on.

X and the Agreement are the search criteria for searching agreements in ICI.

Do we have any ACME Agreement on record?
/icibot

Search for ACME agreement
/icibot

Bot responds with a list of agreements matching ACME

Creating Agreements using ICI Bot

You can use the ICIBot to create an agreement for Contract Types that are not complex. You can create agreements from Contract Types:

  • that are configured in ICI Bot 
  • with default templates (not where the template selection is required)

You must complete the entire process of creating an Agreement in a single email thread. For example, you cannot retrieve the pending tasks by replying to the email that you sent for creating the agreement.

Creating an agreement is a multi-step process, in which ICI Bot guides you through each step. Creating an Agreement using ICI Bot includes the following steps:

  1. Initiating the Agreement
  2. Selecting the Contract Type
  3. Filling in the Attribute Details

Initiating the Agreement

Create an Agreement by sending an email to ICI Bot. You can create an Agreement using ICI Bot and publish it through ICI.

Start creating the Agreement using this query:

Action

Such as

Sample of email to send

ICI Bot's response

Initiate Agreement

Create an agreement

I want to create an agreement
/icibot

ICI Bot responds to specify the Contract Type

Selecting the Contract Type

After you initiate the Agreement (step 1), ICI Bot responds by sending the available Contract Types. The list only contains those Contract Types that are configured in ICI Bot and not the list of Contract Types that are configured in the ICI application. Select a Contract Type by sending an email with one of the following queries:

Action

Such as

Sample of email to send

ICI Bot's response

Create an agreement by using Own type of paper

I want to use X with type of paper "Y".
/icibot

where:

X is the serial number of the agreement

Y is the type of paper.

I want to use 1 with type of paper "Own". /icibot

ICI Bot responds with a list of attributes
Create an agreement with Third Party type of paper

I want to use X with type of paper Y.
/icibot

where:

X is the serial number of the agreement.

Y is the type of paper.

I want to you use 1 with type of paper "Third Party".
/icibot
ICI Bot responds with a list of attributes

Filling in the Attribute Details

After you select the Contract Type, ICI Bot sends a list of attributes to you. This list contains mandatory and optional attributes and a hint, wherever possible. Reply by filling in the values of the attributes in the table.


Sr. No.

Name

Is Mandatory

Value

1.

Explain why this NDA is necessary at this time True New agreement
2. Requester Name True John Doe

Retrieving your Pending Tasks using ICI Bot

You can retrieve a specific or all your pending tasks by sending the following query in the body of your email:

Action:

Such as:

Sample of email to send:

ICI Bot's response:

Retrieve pending tasks

Any pending tasks

Any pending tasks for me?
/icibot

Anything pending for me?
/icibot

ICI Bot responds with a list of your pending tasks

 

Tasks pending for approval

Any tasks pending for approval?
/icibot

Anything for me to approve?
/icibot

ICI Bot responds with a list of your pending approval tasks
  Tasks pending for review

Any tasks pending for review?
/icibot

Anything for me to review?
/icibot

ICI Bot responds with a list of your pending review tasks

Approving and Rejecting Tasks using ICI Bot

To approve or reject tasks, you must first request a list of your pending tasks. This step depends on the query you send to retrieve pending tasks (as shown above). Reply to the same email in which you received your pending tasks. It is important to use the same email thread, or ICI Bot may run into issues.

Reply to the ICI Bot’s email with the list of your pending tasks, as follows:

Action:

Such as:

Sample of email to send:

ICI Bot's response:

Approve tasks

Please approve X with a note "Add Notes", where:

X is the serial number of the record. Replace X with the serial number of the record (from ICI Bot’s email) you wish to approve.

Add your note in the Add Notessection

Approve 1 with a note “approved, subject to additional details”
/icibot

ICI Bot responds that the task is Approved
Reject tasks

Please reject X with a note "Add Notes", where:

X is the serial number of the record. Replace X with the serial number of the record that you want to reject.

Add your note in the Add Notes section.

Please reject 3 with a note "rejected, important details missing."
/icibot

ICI Bot responds that the task is rejected

Downloading Agreement Documents using ICI Bot

You can download the documents of any agreement through ICI Bot. The document are sent by the ICI Bot as an attachment.

Note: You will only get the Associated Document if the download function is available, depending on your privileges and the state the Agreement is in.

  1. Send an email to get the Agreement for which you need the Associated Documents. You can do so by:
  • Retrieving your pending tasks, or
  • Searching for the Agreement
  1. To respond to the email that you receive from ICI Bot for your pending task, send any one of the following queries:

Action:

Such as:

Sample of email to send:

ICI Bot's response:

Download Agreement Documents

Please send me X

Can you send me X?

where:

X is the serial number of the agreement in the pending tasks and search agreement email.

Please send me 1
/icibot

Can you send me 1?        /icibot

ICI Bot downloads the requested agreement document and sends them as attachment.

 

Uploading Documents using ICI Bot

You can upload documents to an existing agreement directly from ICI Bot.

To upload documents:

  1. Send email for either one of the following:
  • Request for a list of pending tasks
  • Search Agreements
  1. Attach the document to the email
  2. Reply to the response of the above queries

Action:

Such as:

Sample of email to send:

ICI Bot's response:

Upload document

Upload an attached document toX
 
where:

X is the serial number of record you received in an earlier email.

Upload the attached document to 1
/icibot

ICI Bot replies that the document is successfully uploaded

Error Scenarios in ICI Bot

In case of errors or validation issues, ICI Bot tries to send relative responses. Only in cases where ICI Bot is not able to figure out the reason for the error, such as Internal Server Error from ICI, does it send a generic error response.

Invalid Message

  • Scenario: You forgot to include /icibot at the end of your previous email or you misspelt the command.
  • Error: ICI Bot sends a message indicating that it did not find /icibot on a new line in an email.

Invalid sequence of query

  • Scenario: All queries must follow a certain sequence, such as a query of pending tasks before trying to approve an agreement. Alternatively, changing the sequence during an ongoing conversation, also results in this error. For example, while creating an Agreement, you should first send a query to create an agreement, then select Contract Type and fill in the attributes. You cannot send a query to approve an agreement in between.
  • Error: ICI BOT requests you to send a query in a new email thread and start a new conversation. You should follow the proper sequence to complete your query.

User Permissions

  • Scenario: You are not provisioned or configured for ICI Bot services.
  • Error: ICI Bot sends a response indicating that either you do not have permission or are not configured to access the Bot services.

 

Integration with Collaboration Tool MS Teams using ICI Bot

By integrating the ICI platform with MS Teams, users can collaborate for contract authoring, negotiations, etc. This not only provides a better, seamless user experience, but also helps to discuss ideas, and in turn significantly improve the cycle time.

Through this integration, we support:

  • Invoking ICI Bot in the Teams app
  • Querying My Pending Tasks using the ICI Bot to be able to collaborate with others and take decisions on pending tasks and expedite the contracting process
  • Searching for Agreements using ICI Bot so that the user can find the relevant, share their status and make informed decisions
  • Using ICI Bot to get answers to frequently asked questions

 

Installing the ICI Bot App

The ICI Bot app can be installed from the Additional apps on the App store. Once inside the app, you can type your questions. ICI Bot retrieves the logged in user’s information and displays responses based on the authorization in the Security Groups. If the user invoking ICI Bot does not have a valid ICI account, then you will get a message indicating that your ICI profile could not be found and you need to contact the ICI Administrator.

Note: To get the ICI Bot app in App store, the ICI Bot needs to set up in your environment by the ICI Administrator.

7.9 ICM Bot 1 7.16.png
 

Using ICI Bot to find Agreements

The Bot is integrated with ICI using ICI APIs. The Bot accepts the NLP (Natural Language Processing) queries from the user through MS Teams and displays the results based on the search criteria. 

In the 7.9 release, performing a text based search for Agreements is supported. For example, A query to the bot ’find msa with microsoft’ will list all the agreements where words ‘msa’ and ‘microsoft’ are present.

7.9 ICM Bot 3 7.16.png
 

Using ICI Bot to query for My Pending Tasks 

Based on the query, ICI Bot renders the top 5 results in the chat window along with a link to the ICI search results page. The top 5 results display the URL to the respective Agreement. These results are the same as those that will be available through the Advanced Search page in ICI. Clicking the hyperlink next to the Agreement name will navigate you to the Agreement to take necessary action.

7.9 ICM Bot 4 7.16.png
 

Using ICI Bot for general FAQ

The ICI Bot provides answers based on the predefined Knowledge Base. In case the knowledge base does not have the query defines, ICI Bot displays a message indicating that there are no current responses to the query.

7.9 ICM Bot 5 7.16.png

 

 

 

Related Topics: Agreement Management | Release Notes |