From ICIHelp7.15
Jump to: navigation, search
 
(28 intermediate revisions by 4 users not shown)
Line 2: Line 2:
 
= Searching Agreements and Requests =
 
= Searching Agreements and Requests =
  
You can search for agreements and requests using [[Using_Advanced_Search|Advanced search]] or from their respective pages ([[Agreements_Page|Agreements Page]], [[Requests_Page|Requests Page]]). You may want to search agreements and requests  for several reasons, such as:
+
You can search Agreements and Requests using Advanced search or from their respective pages (Agreements Page, Requests Page). You may want to search Agreements and Requests for one of the following reasons:
  
 
*View its details  
 
*View its details  
 
*See its status  
 
*See its status  
*Copy an existing agreement
+
*Copy an existing Agreement
 
*Make changes to it  
 
*Make changes to it  
  
The process for searching any entity (Agreements, Contract Types, Requests, Clauses, and so on) is identical. We will use Agreements as an example to understand the process on this help page. You can find a specific Agreement from the [[Agreements_Page|Agreements Page]] using any of the following searches:
+
The process for searching any entity (Agreements, Contract Types, Requests, Clauses, and so on) is identical. ICI provides the type ahead feature for search facets so that the results displayed are filtered while you are typing, thus enabling you to quickly arrive at the desired value. You can type in the text box between the search facet drop-down and the list of facet values, and ICI will display all the matching values which start with the typed content. The type ahead feature works as the ''Contains'' operator for the sake of consistency and ease-of-use. 
  
 +
This search is case-insensitive and ICI displays all the values of the specified facet Attribute and not just the top 1000 values. You can filter the search facet values, select one or multiple of these by checking the relevant checkboxes, and then again select another facet attribute and continue the process to apply multiple facet filters. As soon as you select another facet attribute, the textbox is refreshed. This feature is applicable to the following data types – String, User, Auto, Email, and URL. It is enabled on all search pages, including Index pages, Advanced Search page, Lookup Search page, and so on.
 +
<div class="image-green-border">[[File:1080px-Searching for Agreements and Requests Agreements page 7.8 gr actions.png|720px|RTENOTITLE]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">You can find a specific Agreement from the Agreements Page using any of the following searches:</div>
 +
*Free Text Search
 
*Category Search  
 
*Category Search  
 
*Saved Search  
 
*Saved Search  
*Facet Search
 
 
*Index Page Search  
 
*Index Page Search  
  
=== Category Search ===
+
== Free Text&nbsp;Search ==
  
Follow these steps to search for requests using the Category drop-down list:
+
The operators C''ontains'' and ''Exactly ''on all search pages in the horizontal Search bar help the users in easy and quick searching. The operator ''Contains'' is the existing functionality, whereas ''Exactly'' is a new operator.
  
#'''Click''' the ''Agreement Management'' tile on [[My_Dashboard|My Dashboard]]. The [[Agreements_Page|Agreements Page]]&nbsp;opens, which displays all the existing agreements.  
+
The operators in the horizontal search bar include:
#Use the ''Categories'' drop-down list to filter the agreements and find the exact match that you are looking for. For example, search by status, created by or the status changed,&nbsp;date, among many other options. All options that match the selected category are displayed.  
+
 
#Select the desired criteria by marking the&nbsp;boxes next to that option. Agreements that match&nbsp;these&nbsp;specified criteria are displayed. <div class="image-green-border">[[File:Search agreement 2.png|Agreements page]]</div>
+
1.&nbsp;'''Select '''the Entity to search.
#Filter your search further by typing specific keywords in the ''Custom Keyword'' field and then '''click''' ''Apply''. You can use Boolean operators such as AND/OR or search by wildcards to filter the results. For example:  
+
 
 +
2.&nbsp;'''Select''' any one operator to search by from the drop-down list. You must enter a minimum of 3 characters to search by. On searching using just one or two characters, ICI displays a validation message prompting you to enter at least 3 characters. These fields are case-insensitive, hence characters may be entered in upper and/or lower case.
 +
<div class="image-green-border">[[File:Searching Agreements and Requests operators 7.8 gr actions.png|720px|RTENOTITLE]]</div>
 +
The following operators are available:
 +
 
 +
*Contains'': ''displays all the Agreements where the entered value appears anywhere in the free text search results. If you enter a string (multiple words), ICI considers the exact string including the spaces entered between these words. The functionality is the same as the existing one and you can perform a search using ''*'' or other wildcard search characters as well as the ''AND, OR'' operators manually. The default behavior among the entered words will remain as ''AND''.
 +
*Exactly'': ''works the same way as''Contains ''of the Custom Keyword search discussed above. The only difference is that ''Exactly'' in Free Text search searches for the exact match across Attributes of Agreements, user-defined Associations and system-defined Associations, whereas in Custom Keyword, it searches only in that specific Attribute. If you enter a string (multiple words), ICI considers the exact string including the spaces between these words. The functionality is the same as the existing one and you can perform a search using ''*'' or other wildcard search characters as well as the ''AND, OR'' operators manually. The default behavior among the entered words will remain as ''AND.''
 +
<div class="note-box">'''Note: '''The above values are configurable as per your requirement in terms of names, their sequence in the dropdown, and their default value.</div>
 +
== Category Search ==
 +
 
 +
To search for Requests using the Category drop-down list:
 +
 
 +
1.&nbsp;'''Click'''&nbsp;''Agreement Management''&nbsp;> ''Agreement ''on the ''Home ''page. The agreement index&nbsp;page&nbsp;opens, which displays all the existing Agreements.
 +
 
 +
2. '''Use '''the ''Categories'' drop-down list to filter the Agreements and find the exact match that you are looking for. For example, search by ''Status, Created By, Date'', and so on. All options that match the selected category are displayed.
 +
 
 +
3. '''Select '''the desired criteria by selecting the&nbsp;boxes next to that option. Agreements that match&nbsp;these&nbsp;specified criteria are displayed.
 +
<div class="image-green-border">[[File:Searching Agreements and Requests filters 7.8 gr actions.png|720px|RTENOTITLE]]</div>  
 +
4. '''Filter '''your search further by typing specific keywords in the ''Custom Keyword'' field and then '''click''' ''Apply''. You can use Boolean operators such as AND/OR or search by wildcards to filter the results. For example:
 
<ul style="margin-left: 80px;">
 
<ul style="margin-left: 80px;">
 
<li>APP* - displays agreements only in the APPROVED and WAITING FOR APPROVAL states</li>
 
<li>APP* - displays agreements only in the APPROVED and WAITING FOR APPROVAL states</li>
Line 29: Line 49:
 
<li>APP* OR DRA* - displays agreements only in the APPROVED, WAITING FOR APPROVAL and DRAFT states</li>
 
<li>APP* OR DRA* - displays agreements only in the APPROVED, WAITING FOR APPROVAL and DRAFT states</li>
 
</ul>
 
</ul>
<ol start="5">
+
 
<li>You can also type free text in the Refine Search Here... search box. A list of relevant agreements is displayed.</li>
+
5. You can also type free text in the Refine Search Here... search box. A list of relevant agreements is displayed.
</ol>
+
  
 
The operators C''ontains'' and ''Exactly ''on the search pages in the horizontal search bar help the users in easy and quick searching. The operator ''Contains'' is the existing functionality, whereas ''Exactly'' is a new operator.
 
The operators C''ontains'' and ''Exactly ''on the search pages in the horizontal search bar help the users in easy and quick searching. The operator ''Contains'' is the existing functionality, whereas ''Exactly'' is a new operator.
<div class="image-green-border">[[File:Free Text Search.png|Free Text Search operators]]</div>
+
 
 
The operators in the horizontal search bar include:
 
The operators in the horizontal search bar include:
  
#'''Select '''the Entity to search.  
+
1. '''Select '''the Entity to search.
#'''Select''' any one operator to search by from the drop-down list. You must enter a minimum of 3 characters to search by. On searching using just one or two characters, ICM displays a validation message prompting you to enter at least 3 characters. These fields are case-insensitive, hence characters may be entered in upper and/or lower case.  
+
 
 +
2. '''Select''' any one operator to search by from the drop-down list. You must enter a minimum of 3 characters to search by. On searching using just one or two characters, ICI displays a validation message prompting you to enter at least 3 characters. These fields are case-insensitive, hence characters may be entered in upper and/or lower case.
  
 
The following operators are available:
 
The following operators are available:
  
#''Contains: ''displays all the Agreements where the entered value appears anywhere in the free text search results. If you enter a string (multiple words), ICM considers the exact string including the spaces entered between these words. The functionality is the same as the existing one and you can perform a search using ''*'' or other wildcard search characters as well as the ''AND, OR'' operators manually. The default behavior among the entered words will remain as ''AND''.  
+
*Contains'': ''displays all the Agreements where the entered value appears anywhere in the free text search results. If you enter a string (multiple words), ICI considers the exact string including the spaces entered between these words. The functionality is the same as the existing one and you can perform a search using ''*'' or other wildcard search characters as well as the ''AND, OR'' operators manually. The default behavior among the entered words will remain as ''AND''.  
#''Exactly: ''works the same way as''Contains ''of the Custom Keyword search discussed above. The only difference is that ''Exactly'' in Free Text search searches for the exact match across Attributes of Agreements, user-defined Associations and system-defined Associations, whereas in Custom Keyword, it searches only in that specific Attribute. If you enter a string (multiple words), ICM considers the exact string including the spaces between these words. The functionality is the same as the existing one and you can perform a search using ''*'' or other wildcard search characters as well as the ''AND, OR'' operators manually. The default behavior among the entered words will remain as ''AND.''  
+
*Exactly'': ''works the same way as&nbsp;''Contains ''of the Custom Keyword search discussed above. The only difference is that ''Exactly'' in Free Text search searches for the exact match across Attributes of Agreements, user-defined Associations and system-defined Associations, whereas in Custom Keyword, it searches only in that specific Attribute. If you enter a string (multiple words), ICI considers the exact string including the spaces between these words. The functionality is the same as the existing one and you can perform a search using ''*'' or other wildcard search characters as well as the ''AND, OR'' operators manually. The default behavior among the entered words will remain as ''AND.''  
<div class="note-box">'''Note:'''The above values are <u>configurable</u> as per your requirement in terms of names, their sequence in the dropdown, and their default value.</div>  
+
<div class="note-box">'''Note:'''The above values are configurable as per your requirement in terms of names, their sequence in the dropdown, and their default value.</div>  
=== &nbsp; ===
+
=== Ability to Specify a Date Range on Facet Search ===
  
=== Saved Search ===
+
You can search Agreements within a specified date range using the Calendar picker in the search facets. This greatly enhances the usability of ICI for the business users.
  
Follow these steps to use your saved searches:
+
To do this:
  
#'''Click''' the ''Agreement Management'' tile on [[My_Dashboard|My Dashboard]]. The [[Agreements_Page|Agreements Page]]&nbsp; opens, which displays&nbsp;all the existing agreements.
+
1. '''Select '''a date filter (such as ''Created Date, Expiration Date, Effective Date)'' from the facet search drop-down in the ''Categories'' section of the ''Agreement Management'' page.
#'''Click''' the ''Saved Searches'' drop down and select the desired saved search. Refer to [[Using_Advanced_Search|Using Advanced Search]] for details on saving a search. The agreements that match your search&nbsp;criteria are displayed.  
+
  
Refer to [[Saved_Searches|Saved Searches]] for details on saving a search.
+
2.&nbsp;'''Enter''' the specific date range and advanced date range:
 +
<ul style="margin-left: 40px;">
 +
<li>'''Select''' the ''Specific Date Range'' to select the date in the ''yyyy-mm-dd'' format using the&nbsp;''Calendar ''icon.</li>
 +
<li>'''Select''' the ''Advanced Date Range'' and add the custom range with the following syntax indicating the duration (integer and unit).</li>
 +
</ul>
 +
<div class="image-green-border">Specify the relative time as follows:</div> <ul style="margin-left: 40px;">
 +
<li>''now: ''to indicate the current time.</li>
 +
<li>''now ''plus (+) or minus (-): to begin your string and indicate the offset of the duration of time.</li>
 +
<li>''a number and a unit'': where, the number is implied on specifying time duration. For example, ''d'' is same as ''1d ''and ''M'' is the same as ''1M.''</li>
 +
<li>Supported time units:
 +
*y: year, w: week of week year, d: day of the month, M: month of the year. For example: now-1y, now+2w, now-5d, now+2M.
 +
*h: number of hours (0~23), m: minute of the hour, s: second of the minute. For example: now-2h, now-30m, now+55s. </li>
  
&nbsp;
+
<div class="image-green-border">[[File:Search and Agreements1 gr actions home.png|720px|RTENOTITLE]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">An elaborate&nbsp;Help text on the user interface is available to explain how to specify the date range.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:Search and Agreements2 gr actions home.png|720px|RTENOTITLE]]</div> <div class="image-green-border">&nbsp;</div>
 +
=== Ability to search entities based on&nbsp;team members and their roles ===
  
=== Facet&nbsp;Search ===
+
Users can keep track of the Agreements that they are responsible for review and approvals through ''Team Member'' Category Search.&nbsp;Users can also apply other filters along with the team role to derive out-of-the-box saved search KPIs that help them manage Agreements and Amendments faster and easily.&nbsp;
  
You can search Agreements within a specified date range using the Calendar picker in the search facets. This greatly enhances the usability of ICM for the business users.
+
To search Agreements based on the user role:
  
To do this:
+
1.&nbsp;&nbsp;'''Click''' ''Agreement Management''&nbsp;> ''Agreements ''on the ''Home ''page. The ''Agreement ''index&nbsp;page opens.&nbsp;
 +
<div class="image-green-border">[[File:1-cate home.png|720px|RTENOTITLE]]<br/> &nbsp;<br/> Now let’s consider an example of searching Agreements with the ''PrimaryOwner'' role using the ''Team Member: Role Name'' category.<br/> <br/> 2.&nbsp; '''Enter''' a category or '''select''' one from the ''Categories'' drop-down. For example, ''Team Member: Role Name''.&nbsp;</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:2-cate gr actions.png|720px|RTENOTITLE]]<br/> &nbsp;</div> <div class="note-box">'''Note''': The result may vary for the nested query searches as highlighted in the screenshot above.</div>
 +
<br/> 3.&nbsp;&nbsp;'''Select''' the checkbox next to the Role(s) for which you want to view the Agreements. For example, ''PrimaryOwner''. &nbsp;All Agreements were logged on user is ''PrimaryOwner'' are displayed.&nbsp;
 +
<div class="image-green-border">[[File:3-cate gr actions.png|720px|RTENOTITLE]]<br/> &nbsp;<br/> 4.&nbsp;&nbsp; &nbsp;Let’s refine our search, '''select''' categories like ''Team Member: User Name'' (for example, ''Morita Akemi'') from the ''Categories'' drop-down.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">[[File:4-cate gr actions.png|720px|RTENOTITLE]]&nbsp;<br/>  <br/> 5.&nbsp;&nbsp; &nbsp;To further refine our search, select additional categories such as ''Status'' (for example, ''Status: Waiting For Approval'') from the Categories drop-down.<br/> <br/> All Agreements where Team role is ''PrimaryOwner'', ''User Name ''is''Morita Akemi'', and ''Status'' is ''Waiting For Approval'' are displayed as shown in the screenshot below.<br/> <br/> [[File:5-cate gr actions.png|720px|RTENOTITLE]]</div>
 +
== Saved Search ==
  
#'''Select '''a date filter (such as ''Created Date, Expiration Date, Effective Date)'' from the facet search drop-down in the ''Categories'' section of the ''Agreement Management'' page.
+
Follow these steps to use your saved searches:
#'''Enter''' the ''specific date range'' ''and advanced date range'': <ol style="list-style-type:lower-alpha;">
+
</ol>  </ol>
+
  
</ol>
+
1.&nbsp;'''Click''' ''Agreement Management'' > ''Agreements ''on the ''Home ''page. The agreement&nbsp;index page&nbsp;opens, which displays&nbsp;all the existing agreements.
  
*'''Select''' the ''Specific Date Range'' to select the date in the ''yyyy-mm-dd'' format using the&nbsp;''Calendar ''icon.
+
2.&nbsp;'''Click''' the ''Saved Searches'' drop down and select the desired saved search. Refer to ''Using Advanced Search ''for details on saving a search. The agreements that match your search&nbsp;criteria are displayed.
*'''Select''' the ''Advanced Date Range'' and add the custom range with the following syntax indicating the duration (integer and unit)
+
<div class="image-green-border">Specify the relative time as follows:</div> <ul style="margin-left: 40px;">
+
<li>''now: ''to indicate the current time.</li>
+
<li>''now ''plus (+) or minus (-): to begin your string and indicate the offset of the duration of time.</li>
+
<li>''a number and a unit'': where, the number is implied on specifying time duration. For example, ''d'' is same as ''1d ''and ''M'' is the same as ''1M.''</li>
+
<li>Supported time units:</li>
+
<li>y: year, w: week of week year, d: day of the month, M: month of the year. For example: now-1y, now+2w, now-5d, now+2M.</li>
+
<li>h: number of hours (0~23), m: minute of the hour, s: second of the minute. For example: now-2h, now-30m, now+55s.</li>
+
</ul>
+
<div class="image-green-border">[[File:Specify Date Range on Facet Search.png|Specify Date Range on Facet Search.png]]</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">An elaborate&nbsp;Help text on the user interface is available to explain how to specify the date range.[[File:Help Text on Date Range of Facet Search.png|Help Text on Date Range of Facet Search.png]]</div>
+
&nbsp;
+
  
=== Index Page Search ===
+
Refer to ''Saved Searches'' for details on saving a search.
  
Search functionality includes a drop-down of operators in the ''Custom Keyword'' box below the facet list. It greatly helps the users in quick and efficient search. The operators include:
+
== Index Page Search ==
  
*Contains: This is an existing functionality in ''Custom Keyword'' search.  
+
Search functionality includes a drop-down of operators in the ''Custom Keyword'' box below the facet list. This is available on all Search pages except the ''Advanced Search'' page and&nbsp;helps the users in quick and efficient search. The operators include:
*Exactly: This is a new operator.  
+
 
*Starts With: This is a new operator.  
+
*''Contains'': This is an existing functionality in ''Custom Keyword'' search.  
 +
*''Exactly'': This is a new operator.  
 +
*''Starts With'': This is a new operator.  
  
 
This is applicable for the following data types – Auto, Email, String and User.
 
This is applicable for the following data types – Auto, Email, String and User.
<div class="image-green-border">[[File:Index Page Search.png|Index Page Search]]</div>  
+
<div class="image-green-border">[[File:1080px-Custom keyword gr actions.png|720px|RTENOTITLE]]</div>  
 
To perform a Search using the ''Custom Keyword'' drop-down:
 
To perform a Search using the ''Custom Keyword'' drop-down:
  
#'''Select '''the Entity to search.  
+
1. '''Select '''the Entity to search.
#'''Select''' any one operator to search by from the ''Custom Keyword'' drop-down list. You must enter a minimum of 3 characters to search by. On searching using just one or two characters, ICM displays a validation message prompting you to enter at least 3 characters. These fields are case-insensitive, hence characters can be entered in upper and/or lower case.  
+
 
 +
2.'''Select''' any one operator to search by from the ''Custom Keyword'' drop-down list. You must enter a minimum of 3 characters to search by. On searching using just one or two characters, ICI displays a validation message prompting you to enter at least 3 characters. These fields are case-insensitive, hence characters can be entered in upper and/or lower case.
  
 
The following operators are available:
 
The following operators are available:
  
*''Contains: ''displays all Agreements where the selected Attribute facet value contains the entered value anywhere in the Attribute value. The functionality is the same as the existing one and you can perform a search using ''*'' or any other wildcard search characters as well as the ''AND, OR'' operators manually. The default behavior among the entered words will remain as ''AND''.  
+
*Contains: displays all Agreements where the selected Attribute facet value contains the entered value anywhere in the Attribute value. The functionality is the same as the existing one and you can perform a search using ''*'' or any other wildcard search characters as well as the ''AND, OR'' operators manually. The default behavior among the entered words will remain as ''AND''.  
<div class="image-green-border">[[File:Index Page Search - Contains.png|Index Page Search - Contains operator]]</div>  
+
<div class="image-green-border">[[File:Search and Agreement3 gr actions home.png|720px|RTENOTITLE]]</div>  
*''Exactly: ''displays all the Agreements where the selected Attribute facet value exactly contains the entered value anywhere in the Attribute value. If you enter a string (multiple words), ICM considers the exact string including the spaces between these words.  
+
*Exactly:''displays all the Agreements where the selected Attribute facet value exactly contains the entered value anywhere in the Attribute value. If you enter a string (multiple words), ICI considers the exact string including the spaces between these words.''
<div class="image-green-border">[[File:Index Page Search - Exactly.png|Index Page Search - Exactly operator]]</div>  
+
<div class="image-green-border">[[File:Search ad Agreement3 gr actions home.png|720px|RTENOTITLE]]</div>  
*''Starts With:'' displays all Agreements where the selected Attribute facet value starts with the entered value. If you enter a string (multiple words), ICM considers the exact string including the spaces entered between these words.  
+
*Starts With: displays all Agreements where the selected Attribute facet value starts with the entered value. If you enter a string (multiple words), ICI considers the exact string including the spaces entered between these words.  
<div class="image-green-border">[[File:Index Page Search - Starts With.png|Index Page Search - Starts With operator]]</div>  
+
<div class="image-green-border">[[File:1080px-Automation gr actions.png|720px|RTENOTITLE]]</div>  
 
*''Let’s see some examples:''  
 
*''Let’s see some examples:''  
 +
**If you select ''Customer name'' as search facet, and enter ''Icertis Canada'' in the custom keyword box, then ICI searches Agreements where the customer name Attribute value starts with''Icertis Canada'', such as, ''Icertis Canada Products Ltd, Icertis Canada Services Ltd,'' and so on. ICI does not display Agreements where customer name is ''Icertis Europe Products Ltd, Canada Interactive Ltd or Icertis Advanced Systems Canada Ltd''.
 +
**If you search ''Icertis Can*'', ICI does not display any results unless there is really an Agreement with a customer name starting with ''Icertis Can*.'' Thus, ICI matches the exact entered value and checks if there is any Agreement where customer name starts with exactly the same value and will display only results that exactly match.
 +
**If you search using quotes, such as “''Icertis”'' or ''‘Icertis’'', ICI displays Agreements where the customer name actually has ''“Icertis”'' or ''‘Icertis’'' values respectively. Thus, ICI does not display any results, unless there is really any Agreement where the customer name was entered with single or double quotes. 
 +
<div class="note-box">'''Note: '''The above values are configurable as per your requirement in terms of names, their sequence in the dropdown, and their default value.</div>
 +
== Searches pinned as Favorites ==
  
*If you select ''Customer name'' as search facet, and enter ''Icertis Canada'' in the custom keyword box, then ICM searches Agreements where the customer name Attribute value starts with''Icertis Canada'', such as, ''Icertis Canada Products Ltd, Icertis Canada Services Ltd,'' and so on. ICM does not display Agreements where customer name is ''Icertis Europe Products Ltd, Canada Interactive Ltd or Icertis Advanced Systems Canada Ltd''.
+
Follow these steps to search using a favorite search:
*If you search ''Icertis Can*'', ICM does not display any results unless there is really an Agreement with a customer name starting with ''Icertis Can*.'' Thus, ICM matches the exact entered value and checks if there is any Agreement where customer name starts with exactly the same value and will display only results that exactly match.
+
*If you search using quotes, such as “''Icertis”'' or ''‘Icertis’'', ICM displays Agreements where the customer name actually has ''“Icertis”'' or ''‘Icertis’'' values respectively. Thus, ICM does not display any results, unless there is really any Agreement where the customer name was entered with single or double quotes.
+
<div class="note-box">'''Note: '''The above values are <u>configurable</u> as per your requirement in terms of names, their sequence in the dropdown, and their default value.</div>
+
&nbsp;
+
  
=== Searches pinned as Favorites ===
+
1.&nbsp;'''Click''' ''Agreement Management''&nbsp;> Agreements on the ''Home ''page. The agreement&nbsp;index page&nbsp;opens which displays&nbsp;all the existing Agreements.
 
+
Follow these steps to search using a favorite search:
+
  
#'''Click''' the ''Agreement Management'' tile on [[My_Dashboard|My Dashboard]]. The [[Agreements_Page|Agreements Page]]&nbsp;opens which displays&nbsp;all the existing Agreements.
+
2.&nbsp;'''Click''' one of the searches defined as favorite, just below the feature tiles. Refer to ''Using Advanced Search'' for details on adding searches as favorites. The&nbsp; ''Agreements'' that match the criteria &nbsp;in your favorite search are displayed.
#'''Click''' one of the searches defined as favorite, just below the feature tiles. Refer to [[Using_Advanced_Search|Using Advanced Search]] for details on adding searches as favorites. The&nbsp; Agreements that match the criteria &nbsp;in your favorite search are displayed.  
+
  
 
&nbsp;
 
&nbsp;
Line 125: Line 148:
 
&nbsp;
 
&nbsp;
  
'''Related Topics:'''&nbsp;[[Using_Advanced_Search|Advanced Search]] &nbsp;| &nbsp;[[Saved_Searches|Saved Searches]] &nbsp;| &nbsp;[[Agreements_Page|Agreements Page]]
+
'''Related Topics:'''&nbsp;[[Using_Advanced_Search|Advanced Search]] | [[Saved_Searches|Saved Searches]] | [[Agreements|Agreements]]&nbsp;|&nbsp;[[Requests|Requests]]

Latest revision as of 10:47, 17 November 2020

Searching Agreements and Requests

You can search Agreements and Requests using Advanced search or from their respective pages (Agreements Page, Requests Page). You may want to search Agreements and Requests for one of the following reasons:

  • View its details
  • See its status
  • Copy an existing Agreement
  • Make changes to it

The process for searching any entity (Agreements, Contract Types, Requests, Clauses, and so on) is identical. ICI provides the type ahead feature for search facets so that the results displayed are filtered while you are typing, thus enabling you to quickly arrive at the desired value. You can type in the text box between the search facet drop-down and the list of facet values, and ICI will display all the matching values which start with the typed content. The type ahead feature works as the Contains operator for the sake of consistency and ease-of-use. 

This search is case-insensitive and ICI displays all the values of the specified facet Attribute and not just the top 1000 values. You can filter the search facet values, select one or multiple of these by checking the relevant checkboxes, and then again select another facet attribute and continue the process to apply multiple facet filters. As soon as you select another facet attribute, the textbox is refreshed. This feature is applicable to the following data types – String, User, Auto, Email, and URL. It is enabled on all search pages, including Index pages, Advanced Search page, Lookup Search page, and so on.

RTENOTITLE
 
You can find a specific Agreement from the Agreements Page using any of the following searches:
  • Free Text Search
  • Category Search
  • Saved Search
  • Index Page Search

Free Text Search

The operators Contains and Exactly on all search pages in the horizontal Search bar help the users in easy and quick searching. The operator Contains is the existing functionality, whereas Exactly is a new operator.

The operators in the horizontal search bar include:

1. Select the Entity to search.

2. Select any one operator to search by from the drop-down list. You must enter a minimum of 3 characters to search by. On searching using just one or two characters, ICI displays a validation message prompting you to enter at least 3 characters. These fields are case-insensitive, hence characters may be entered in upper and/or lower case.

RTENOTITLE

The following operators are available:

  • Contains: displays all the Agreements where the entered value appears anywhere in the free text search results. If you enter a string (multiple words), ICI considers the exact string including the spaces entered between these words. The functionality is the same as the existing one and you can perform a search using * or other wildcard search characters as well as the AND, OR operators manually. The default behavior among the entered words will remain as AND.
  • Exactly: works the same way asContains of the Custom Keyword search discussed above. The only difference is that Exactly in Free Text search searches for the exact match across Attributes of Agreements, user-defined Associations and system-defined Associations, whereas in Custom Keyword, it searches only in that specific Attribute. If you enter a string (multiple words), ICI considers the exact string including the spaces between these words. The functionality is the same as the existing one and you can perform a search using * or other wildcard search characters as well as the AND, OR operators manually. The default behavior among the entered words will remain as AND.
Note: The above values are configurable as per your requirement in terms of names, their sequence in the dropdown, and their default value.

Category Search

To search for Requests using the Category drop-down list:

1. Click Agreement Management > Agreement on the Home page. The agreement index page opens, which displays all the existing Agreements.

2. Use the Categories drop-down list to filter the Agreements and find the exact match that you are looking for. For example, search by Status, Created By, Date, and so on. All options that match the selected category are displayed.

3. Select the desired criteria by selecting the boxes next to that option. Agreements that match these specified criteria are displayed.

RTENOTITLE

4. Filter your search further by typing specific keywords in the Custom Keyword field and then click Apply. You can use Boolean operators such as AND/OR or search by wildcards to filter the results. For example:

  • APP* - displays agreements only in the APPROVED and WAITING FOR APPROVAL states
  •  ?PP* - displays agreements only in the APPROVED and WAITING FOR APPROVAL states
  • APP* OR DRA* - displays agreements only in the APPROVED, WAITING FOR APPROVAL and DRAFT states

5. You can also type free text in the Refine Search Here... search box. A list of relevant agreements is displayed.

The operators Contains and Exactly on the search pages in the horizontal search bar help the users in easy and quick searching. The operator Contains is the existing functionality, whereas Exactly is a new operator.

The operators in the horizontal search bar include:

1. Select the Entity to search.

2. Select any one operator to search by from the drop-down list. You must enter a minimum of 3 characters to search by. On searching using just one or two characters, ICI displays a validation message prompting you to enter at least 3 characters. These fields are case-insensitive, hence characters may be entered in upper and/or lower case.

The following operators are available:

  • Contains: displays all the Agreements where the entered value appears anywhere in the free text search results. If you enter a string (multiple words), ICI considers the exact string including the spaces entered between these words. The functionality is the same as the existing one and you can perform a search using * or other wildcard search characters as well as the AND, OR operators manually. The default behavior among the entered words will remain as AND.
  • Exactly: works the same way as Contains of the Custom Keyword search discussed above. The only difference is that Exactly in Free Text search searches for the exact match across Attributes of Agreements, user-defined Associations and system-defined Associations, whereas in Custom Keyword, it searches only in that specific Attribute. If you enter a string (multiple words), ICI considers the exact string including the spaces between these words. The functionality is the same as the existing one and you can perform a search using * or other wildcard search characters as well as the AND, OR operators manually. The default behavior among the entered words will remain as AND.
Note:The above values are configurable as per your requirement in terms of names, their sequence in the dropdown, and their default value.

Ability to Specify a Date Range on Facet Search

You can search Agreements within a specified date range using the Calendar picker in the search facets. This greatly enhances the usability of ICI for the business users.

To do this:

1. Select a date filter (such as Created Date, Expiration Date, Effective Date) from the facet search drop-down in the Categories section of the Agreement Management page.

2. Enter the specific date range and advanced date range:

  • Select the Specific Date Range to select the date in the yyyy-mm-dd format using the Calendar icon.
  • Select the Advanced Date Range and add the custom range with the following syntax indicating the duration (integer and unit).
Specify the relative time as follows:
  • now: to indicate the current time.
  • now plus (+) or minus (-): to begin your string and indicate the offset of the duration of time.
  • a number and a unit: where, the number is implied on specifying time duration. For example, d is same as 1d and M is the same as 1M.
  • Supported time units:
    • y: year, w: week of week year, d: day of the month, M: month of the year. For example: now-1y, now+2w, now-5d, now+2M.
    • h: number of hours (0~23), m: minute of the hour, s: second of the minute. For example: now-2h, now-30m, now+55s.
    RTENOTITLE
     
    An elaborate Help text on the user interface is available to explain how to specify the date range.
     
    RTENOTITLE
     

    Ability to search entities based on team members and their roles

    Users can keep track of the Agreements that they are responsible for review and approvals through Team Member Category Search. Users can also apply other filters along with the team role to derive out-of-the-box saved search KPIs that help them manage Agreements and Amendments faster and easily. 

    To search Agreements based on the user role:

    1.  Click Agreement Management > Agreements on the Home page. The Agreement index page opens. 

    RTENOTITLE
     
    Now let’s consider an example of searching Agreements with the PrimaryOwner role using the Team Member: Role Name category.

    2.  Enter a category or select one from the Categories drop-down. For example, Team Member: Role Name
     
    RTENOTITLE
     
    Note: The result may vary for the nested query searches as highlighted in the screenshot above.


    3.  Select the checkbox next to the Role(s) for which you want to view the Agreements. For example, PrimaryOwner.  All Agreements were logged on user is PrimaryOwner are displayed. 

    RTENOTITLE
     
    4.    Let’s refine our search, select categories like Team Member: User Name (for example, Morita Akemi) from the Categories drop-down.
     
    RTENOTITLE 

    5.    To further refine our search, select additional categories such as Status (for example, Status: Waiting For Approval) from the Categories drop-down.

    All Agreements where Team role is PrimaryOwner, User Name isMorita Akemi, and Status is Waiting For Approval are displayed as shown in the screenshot below.

    RTENOTITLE

    Saved Search

    Follow these steps to use your saved searches:

    1. Click Agreement Management > Agreements on the Home page. The agreement index page opens, which displays all the existing agreements.

    2. Click the Saved Searches drop down and select the desired saved search. Refer to Using Advanced Search for details on saving a search. The agreements that match your search criteria are displayed.

    Refer to Saved Searches for details on saving a search.

    Index Page Search

    Search functionality includes a drop-down of operators in the Custom Keyword box below the facet list. This is available on all Search pages except the Advanced Search page and helps the users in quick and efficient search. The operators include:

    • Contains: This is an existing functionality in Custom Keyword search.
    • Exactly: This is a new operator.
    • Starts With: This is a new operator.

    This is applicable for the following data types – Auto, Email, String and User.

    RTENOTITLE

    To perform a Search using the Custom Keyword drop-down:

    1. Select the Entity to search.

    2.Select any one operator to search by from the Custom Keyword drop-down list. You must enter a minimum of 3 characters to search by. On searching using just one or two characters, ICI displays a validation message prompting you to enter at least 3 characters. These fields are case-insensitive, hence characters can be entered in upper and/or lower case.

    The following operators are available:

    • Contains: displays all Agreements where the selected Attribute facet value contains the entered value anywhere in the Attribute value. The functionality is the same as the existing one and you can perform a search using * or any other wildcard search characters as well as the AND, OR operators manually. The default behavior among the entered words will remain as AND.
    RTENOTITLE
    • Exactly:displays all the Agreements where the selected Attribute facet value exactly contains the entered value anywhere in the Attribute value. If you enter a string (multiple words), ICI considers the exact string including the spaces between these words.
    RTENOTITLE
    • Starts With: displays all Agreements where the selected Attribute facet value starts with the entered value. If you enter a string (multiple words), ICI considers the exact string including the spaces entered between these words.
    RTENOTITLE
    • Let’s see some examples:
      • If you select Customer name as search facet, and enter Icertis Canada in the custom keyword box, then ICI searches Agreements where the customer name Attribute value starts withIcertis Canada, such as, Icertis Canada Products Ltd, Icertis Canada Services Ltd, and so on. ICI does not display Agreements where customer name is Icertis Europe Products Ltd, Canada Interactive Ltd or Icertis Advanced Systems Canada Ltd.
      • If you search Icertis Can*, ICI does not display any results unless there is really an Agreement with a customer name starting with Icertis Can*. Thus, ICI matches the exact entered value and checks if there is any Agreement where customer name starts with exactly the same value and will display only results that exactly match.
      • If you search using quotes, such as “Icertis” or ‘Icertis’, ICI displays Agreements where the customer name actually has “Icertis” or ‘Icertis’ values respectively. Thus, ICI does not display any results, unless there is really any Agreement where the customer name was entered with single or double quotes.
    Note: The above values are configurable as per your requirement in terms of names, their sequence in the dropdown, and their default value.

    Searches pinned as Favorites

    Follow these steps to search using a favorite search:

    1. Click Agreement Management > Agreements on the Home page. The agreement index page opens which displays all the existing Agreements.

    2. Click one of the searches defined as favorite, just below the feature tiles. Refer to Using Advanced Search for details on adding searches as favorites. The  Agreements that match the criteria  in your favorite search are displayed.

     

     

    Related Topics: Advanced Search | Saved Searches | Agreements | Requests