From ICIHelp8.1
Jump to: navigation, search
 
(2 intermediate revisions by the same user not shown)
Line 5: Line 5:
  
 
= Using Advanced Search =
 
= Using Advanced Search =
<div class="image-green-border">&nbsp;</div>  
+
<div class="image-green-border">[[File:Advanced Search1-1.png|720px|Advanced Search1-1.png]]</div>  
Advanced Search provides the flexibility to search across entities by filtering results based on any Attribute combinations. You can further refine your search by selecting either the ''Contains ''or ''Exactly'' operator from the drop-down to quickly find specific Attributes, instead of searching across all Attributes.
+
Advanced Search provides the flexibility to search across entities by filtering results based on any Attribute combinations. You can further refine your search by selecting either the Contains or Exactly operator from the drop-down to quickly find specific Attributes, instead of searching across all Attributes.
  
 
You may want to search for a specific entity like a Request or Agreement for one of the following reasons:
 
You may want to search for a specific entity like a Request or Agreement for one of the following reasons:
Line 39: Line 39:
  
 
1.&nbsp;'''Click''' the "Advanced"&nbsp;link on the "Home"&nbsp;page. The "Advanced Search"&nbsp;page opens.
 
1.&nbsp;'''Click''' the "Advanced"&nbsp;link on the "Home"&nbsp;page. The "Advanced Search"&nbsp;page opens.
<div class="image-green-border">[[File:Saved Searches1.PNG|720px|Saved Searches1.PNG]]</div>  
+
<div class="image-green-border">[[File:Advanced Search3.PNG|600px|Advanced Search3.PNG]]</div>  
 
2. '''Enter '''or&nbsp;'''select''' appropriate entities from the entity dropdown list&nbsp;and type the keywords in the "Refine Search"&nbsp;box.
 
2. '''Enter '''or&nbsp;'''select''' appropriate entities from the entity dropdown list&nbsp;and type the keywords in the "Refine Search"&nbsp;box.
<div class="image-green-border">[[File:Saved Searches2.PNG|360px|Saved Searches2.PNG]]</div>  
+
<div class="image-green-border">[[File:Advanced Search4.PNG|360px|Advanced Search4.PNG]]</div>  
 
'''Note:''' Default entities are already selected and displayed with respective entity groupings.
 
'''Note:''' Default entities are already selected and displayed with respective entity groupings.
  
 
3. '''Select''' data type from the data type filter dropdown.
 
3. '''Select''' data type from the data type filter dropdown.
<div class="image-green-border">[[File:Saved Searches4.PNG|120px|Saved Searches4.PNG]]</div>  
+
<div class="image-green-border">[[File:Advanced Search5.PNG|480px|Advanced Search5.PNG]]</div>  
 
4.&nbsp;'''Click'''&nbsp;the "Search" button, the results matching your keywords are displayed.
 
4.&nbsp;'''Click'''&nbsp;the "Search" button, the results matching your keywords are displayed.
<div class="image-green-border">[[File:Saved Searches3.PNG|720px|Saved Searches3.PNG]]</div>  
+
<div class="image-green-border">[[File:Advanced Search6.PNG|720px|Advanced Search6.PNG]]</div>  
 
5. In the collapsible "Refine Search" section on the left, '''click'''&nbsp;the "Select Field"&nbsp;drop-down under the "Categories" field and select an option from the list provided. The number in the bracket indicates the number of items available containing that&nbsp;search term. You can select multiple options.&nbsp;For example, selecting the field "Status, displays the count of Agreements that have status as "Draft", "Approved", "Cancelled", "Executed" and so on.&nbsp;If you select the status as "Approved" and "Cancelled",&nbsp;all Agreements in those&nbsp;states&nbsp;are displayed.&nbsp;
 
5. In the collapsible "Refine Search" section on the left, '''click'''&nbsp;the "Select Field"&nbsp;drop-down under the "Categories" field and select an option from the list provided. The number in the bracket indicates the number of items available containing that&nbsp;search term. You can select multiple options.&nbsp;For example, selecting the field "Status, displays the count of Agreements that have status as "Draft", "Approved", "Cancelled", "Executed" and so on.&nbsp;If you select the status as "Approved" and "Cancelled",&nbsp;all Agreements in those&nbsp;states&nbsp;are displayed.&nbsp;
<div class="image-green-border">[[File:Saved Searches6.PNG|720px|Saved Searches6.PNG]]</div>  
+
<div class="image-green-border">[[File:Advanced Search7.PNG|720px|Advanced Search7.PNG]]</div>  
 
6. '''Click '''the Cancel icon on inidividual filters to remove them.&nbsp;
 
6. '''Click '''the Cancel icon on inidividual filters to remove them.&nbsp;
  
7. Choose "Custom Keyword" filter with desired text and '''c''''''lick '''the "Apply" button to further refine the search.
+
7. Choose "Custom Keyword" filter with desired text and '''click&nbsp;'''the "Apply" button to further refine the search.
<div class="image-green-border">[[File:Saved Searches7.PNG|220px|Saved Searches7.PNG]]</div>  
+
<div class="image-green-border">[[File:Advanced Search8.PNG|240px|Advanced Search8.PNG]]</div>  
 
8. '''Click '''the "Clear All" button to remove all the filters at a time.
 
8. '''Click '''the "Clear All" button to remove all the filters at a time.
  
Line 63: Line 63:
 
*...(space)...:&nbsp;Type multiple search terms with a space in between.&nbsp;It shows existing items which include the search terms  
 
*...(space)...:&nbsp;Type multiple search terms with a space in between.&nbsp;It shows existing items which include the search terms  
  
10. To save this search, '''c''''''lick''' the the "Save'''&nbsp;'''View" button and follow that flow. Refer to "Saved Searches" in Wiki for more details.
+
10. To save this search, '''c''''lick' the the "Save'''&nbsp;'''View" button and follow that flow. Refer to "Saved Searches" in Wiki for more details.
  
 
== Searching&nbsp;for Agreements/Amendments using Notes ==
 
== Searching&nbsp;for Agreements/Amendments using Notes ==
Line 71: Line 71:
 
To Search an Agreement using Notes:
 
To Search an Agreement using Notes:
  
1.&nbsp;'''Create '''an Agreement. For example, ICMAutomationBasicAgreement_659.
+
1.&nbsp;'''Create '''an Agreement.
  
2.&nbsp;'''Navigate '''to the "''Notes"&nbsp;''tab on the "''Agreement Details"'' page and&nbsp;'''click''' the "''Add Note"''&nbsp;button.
+
2.&nbsp;'''Navigate '''to the "Notes"&nbsp;tab on the "Agreement Details" page and&nbsp;'''click''' the "Add Note"&nbsp;button.
  
3.&nbsp;'''Add''' a meaningful note for the Agreement in the "''Add Note"'' drawer.
+
3.&nbsp;'''Add''' a meaningful note for the Agreement in the "Add Note" drawer.
  
4.&nbsp;'''Click '''the "''Add"&nbsp;''button to save your note.
+
4.&nbsp;'''Click '''the "Add"&nbsp;button to save your note.
 
<div class="image-green-border">[[File:Advanced Search2.PNG|600px|Advanced Search2.PNG]]</div>  
 
<div class="image-green-border">[[File:Advanced Search2.PNG|600px|Advanced Search2.PNG]]</div>  
5.&nbsp;'''Click''' the "Advanced&nbsp;''Search" link''&nbsp;on the "''Home"&nbsp;''page.
+
5.&nbsp;'''Click''' the "Advanced&nbsp;Search" link&nbsp;on the "Home"&nbsp;page.
  
6.&nbsp;'''Select''' an Agreement entity on the Advanced&nbsp;''Search ''page.
+
6.&nbsp;'''Select''' an Agreement entity on the Advanced&nbsp;Search page.
<div class="image-green-border">7.&nbsp;'''Enter '''the search text from the notes entered in step 3 to find the Agreement. For example, 27Nov17.</div>  
+
<div class="image-green-border">7.&nbsp;'''Enter '''the search text from the notes entered in step 3 to find the Agreement.</div>  
8.&nbsp;'''Click '''the "''Search" button''. ICI&nbsp;lists the searched Agreement&nbsp;based on the notes containing the text entered in the search field.
+
8.&nbsp;'''Click '''the "Search" button. ICI&nbsp;lists the searched Agreement&nbsp;based on the notes containing the text entered in the search field.
 
<div class="image-green-border">&nbsp;</div>  
 
<div class="image-green-border">&nbsp;</div>  
 
== Retrieving Saved Searches ==
 
== Retrieving Saved Searches ==
  
'''Click''' the ''Saved Searches "More Views"'' dropdown and select the desired saved search. This displays the results matching the criteria defined in the saved search. Refer to Saved Searches for details on saving a search.
+
'''Click''' the Saved Searches "More Views" dropdown and select the desired saved search. This displays the results matching the criteria defined in the saved search. Refer to "Saved Searches" for details on saving a search.
  
 
&nbsp;
 
&nbsp;
  
== Using Search ==
+
== Applying facets to business status search filter ==
  
#Enter a search term and press enter or '''click '''the search icon. For example, ''NDA''. The search will be initiated and a drop-down is displayed.&nbsp;
+
To provide a better user experience and ease of use, faceted filters using string operators, such as “Contains”, “Exactly”, “Starts With” and “Does Not Contain” are being added to the “Business Status” filters.
  
Each search result displays:
+
The "Contains" facet can be applied to the Business Status filter. For example, it can be applied to search agreements&nbsp;in one or more&nbsp;state/s.
 
+
<div class="image-green-border">[[File:Advanced Search9.PNG|600px|Advanced Search9.PNG]]</div>  
*Type of entity, for example ''Agreement''.  
+
When the filter is applied, all agreements in other states such as "Approved", "Executed" and so on are displayed in the results.
*Name of the record, for example agreement name ''ICMOMContract_686'', with an information icon next to it. Hovering over the icon displays ''Created By'', ''Created Date'' and ''Status ''of the record.&nbsp;  
+
<div class="image-green-border">[[File:Advanced Search10.PNG|720px|Advanced Search10.PNG]]</div>  
*More instances where the search term has been found. This is indicated by a text, for example ''+ 2 more''. Hovering over this text displays more information on the matching results.
+
*Where the search term has been found, for example ''Found in: Attributes''.  
+
<ol start="2">
+
<li>'''Click '''the ''View All Results''. The results details page opens.</li>
+
</ol>
+
<div class="note-box">Note: If the user navigates to the results details page by clicking the ''Search ''tile on the ''Home ''page, the default search mode is ''Metadata''. While navigating to the results details page by clicking the ''View All Results'' link, the default search mode is ''Combined''. In this case, the search term is matched with both metadata as well as the full text of the records that are searched. In the example above, the search term ''NDA ''is matched with both attributes and full text of the document.</div>  
+
 
&nbsp;
 
&nbsp;
  
== Applying facets to business status search filter ==
 
 
To provide a better user experience and ease of use, faceted filters using string operators, such as “Contains”, “Exactly”, “Starts With” and “Does Not Contain” are being added to the “Business Status” filters.
 
 
The Does Not Contain facet can be applied to the Business Status filter. For example, it can be applied to search agreements that are in any state other than Draft.
 
<div class="image-green-border">[[File:7.15 Business Status filter 01.png|720px|7.15 Business Status filter 01.png]]</div>
 
When the filter is applied, all agreements in other states such as Approved, Executed and so on are displayed in the results.
 
<div class="image-green-border">[[File:7.15 Business Status filter 02.png|720px|7.15 Business Status filter 02.png]]</div>
 
The search results can also be saved using the Saved Search button.
 
<div class="image-green-border">[[File:7.15 Business Status filter 03.png|720px|7.15 Business Status filter 03.png]]</div>
 
'''Click '''the ''Saved Search'' icon. The Save Search pop-up window opens.
 
<div class="image-green-border">[[File:7.15 Business Status filter 04.png|720px|7.15 Business Status filter 04.png]]</div> <div class="image-green-border">The search results can be saved, for example as&nbsp;''Non-Draft Agreements''.</div> <div class="image-green-border">&nbsp;</div> <div class="image-green-border">&nbsp;</div>
 
 
== Enabling search for external users with login privileges ==
 
== Enabling search for external users with login privileges ==
  
Line 126: Line 108:
  
 
To conduct searches as an external user:<br/> 1. '''Log on''' to ICI. The Home page opens.
 
To conduct searches as an external user:<br/> 1. '''Log on''' to ICI. The Home page opens.
<div class="image-green-border">[[File:7.15 External User Search 01.png|720px|7.15 External User Search 01.png]]</div>  
+
<div class="image-green-border">[[File:External User1.PNG|720px|External User1.PNG]]</div>  
2. To search for an agreement, '''click '''''Agreement Management > Agreements''. The agreements index page opens.
+
2. To search for an agreement, '''click '''Agreements. The agreements index page opens.
<div class="image-green-border">[[File:7.15 External User Search 02.png|720px|7.15 External User Search 02.png]]</div>  
+
<div class="image-green-border">[[File:External User2-1.PNG|720px|External User2-1.PNG]]</div>  
3. '''Type '''the name of the agreement you want to find in the search bar. For example, MSA.
+
3. '''Type '''the name of the agreement you want to find in the search bar. For example, Legal Contract.
<div class="image-green-border">[[File:7.15 External User Search 03.png|720px|7.15 External User Search 03.png]]</div>  
+
<div class="image-green-border">[[File:External User2.PNG|280px|External User2.PNG]]</div>  
 
4. '''Click '''the search icon. The agreement record is displayed in the search results.
 
4. '''Click '''the search icon. The agreement record is displayed in the search results.
<div class="image-green-border">[[File:7.15 External User Search 04.png|720px|7.15 External User Search 04.png]]</div>  
+
<div class="image-green-border">[[File:External User3.PNG|720px|External User3.PNG]]</div>  
5. '''Click '''the ''Saved Searches ''drop-down to access any saved searches.
+
5. '''Click '''the Saved Searches "More Views" dropdown to access any saved searches.
<div class="note-box">'''Note''': Only those saved searches that are created by Administrators will appear in the drop-down.</div>  
+
<div class="image-green-border">[[File:External User4.PNG|360px|External User4.PNG]]</div> <div class="image-green-border">&nbsp;</div> <div class="note-box">'''Note''': Only those saved searches that are created by Administrators will appear in the drop-down.</div>  
6. '''Click '''the ''Categories ''drop-down.
+
6. '''Click '''the Categories dropdown.
<div class="image-green-border">[[File:7.15 External User Search 05.png|720px|7.15 External User Search 05.png]]</div>  
+
<div class="image-green-border">[[File:External User5.PNG|280px|External User5.PNG]]</div>  
7. '''Enter '''a facet to further filter the search. For example, ''Agreement Name''. The number of records matching the filter will be displayed. In this example, only 1 result is displayed.
+
7. '''Enter '''a facet to further filter the search. For example, Agreement Name. The number of records matching the filter will be displayed. In this example, only 1 result is displayed.
<div class="image-green-border">[[File:7.15 External User Search 06.png|720px|7.15 External User Search 06.png]]</div>  
+
<div class="image-green-border">[[File:External User6.PNG|280px|External User6.PNG]]</div>  
 
&nbsp;
 
&nbsp;
  

Latest revision as of 07:16, 19 December 2021

 

 

Using Advanced Search

Advanced Search1-1.png

Advanced Search provides the flexibility to search across entities by filtering results based on any Attribute combinations. You can further refine your search by selecting either the Contains or Exactly operator from the drop-down to quickly find specific Attributes, instead of searching across all Attributes.

You may want to search for a specific entity like a Request or Agreement 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 is identical. We will use Agreements as an example to understand the process.

You can search in several ways in ICI:

  • Search just for specific entities from their respective pages, such as the Agreements page
  • Perform an Advanced Search to look for an entity across ICI
  • Retrieving a saved search

 

Performing an Advanced Search

The Advanced Search includes options to search for any entity, filtering the search by type of data, keywords with conditions, a Natural Language Search, as well as the detailed "Refine View" search that appears along with all ICI entities as well. Some seeded default entities are already selected and displayed with respective entity groupings, and they are:

  • Agreement.
  • Associated Document.
  • Contract Request.
  • Masterdata.
  • Clause
  • Template

To perform an advanced search:

1. Click the "Advanced" link on the "Home" page. The "Advanced Search" page opens.

Advanced Search3.PNG

2. Enter or select appropriate entities from the entity dropdown list and type the keywords in the "Refine Search" box.

Advanced Search4.PNG

Note: Default entities are already selected and displayed with respective entity groupings.

3. Select data type from the data type filter dropdown.

Advanced Search5.PNG

4. Click the "Search" button, the results matching your keywords are displayed.

Advanced Search6.PNG

5. In the collapsible "Refine Search" section on the left, click the "Select Field" drop-down under the "Categories" field and select an option from the list provided. The number in the bracket indicates the number of items available containing that search term. You can select multiple options. For example, selecting the field "Status, displays the count of Agreements that have status as "Draft", "Approved", "Cancelled", "Executed" and so on. If you select the status as "Approved" and "Cancelled", all Agreements in those states are displayed. 

Advanced Search7.PNG

6. Click the Cancel icon on inidividual filters to remove them. 

7. Choose "Custom Keyword" filter with desired text and click the "Apply" button to further refine the search.

Advanced Search8.PNG

8. Click the "Clear All" button to remove all the filters at a time.

9. A list of these Agreements is displayed as a search result in the tabular format. Enhance your search using wildcards as follows:

  • ...*: Type a search term in between the star characters. It shows existing items which include the respective search term...: Prefix * to a search term. It shows existing items which end with this term
  • ...*: Suffix * to a search term. It shows existing items which start with this term
  • "...": Type a search term in double quotes. It shows existing items which include the search term
  • ...(space)...: Type multiple search terms with a space in between. It shows existing items which include the search terms

10. To save this search, c'lick' the the "Save View" button and follow that flow. Refer to "Saved Searches" in Wiki for more details.

Searching for Agreements/Amendments using Notes


You can search for Agreements/ Amendments based on the Notes entered by them. You can search for these entities in the Notes, from the Advanced Search page and within the Notes tab.

Note: The search is restricted to 1000 characters whether it is entered from a text area or a rich text area.  

To Search an Agreement using Notes:

1. Create an Agreement.

2. Navigate to the "Notes" tab on the "Agreement Details" page and click the "Add Note" button.

3. Add a meaningful note for the Agreement in the "Add Note" drawer.

4. Click the "Add" button to save your note.

Advanced Search2.PNG

5. Click the "Advanced Search" link on the "Home" page.

6. Select an Agreement entity on the Advanced Search page.

7. Enter the search text from the notes entered in step 3 to find the Agreement.

8. Click the "Search" button. ICI lists the searched Agreement based on the notes containing the text entered in the search field.

 

Retrieving Saved Searches

Click the Saved Searches "More Views" dropdown and select the desired saved search. This displays the results matching the criteria defined in the saved search. Refer to "Saved Searches" for details on saving a search.

 

Applying facets to business status search filter

To provide a better user experience and ease of use, faceted filters using string operators, such as “Contains”, “Exactly”, “Starts With” and “Does Not Contain” are being added to the “Business Status” filters.

The "Contains" facet can be applied to the Business Status filter. For example, it can be applied to search agreements in one or more state/s.

Advanced Search9.PNG

When the filter is applied, all agreements in other states such as "Approved", "Executed" and so on are displayed in the results.

Advanced Search10.PNG

 

Enabling search for external users with login privileges

ICI’s collaboration portal allows external users with login privileges to access the platform and perform assigned tasks within ICI itself. 

With this release, a search option has been introduced on contract requests, agreements, associations and masterdata index pages, so that external users can easily search records. The attributes displayed as columns of the search grid are included as facets in the filter options to perform a more refined search.
 

To conduct searches as an external user:
1. Log on to ICI. The Home page opens.

External User1.PNG

2. To search for an agreement, click Agreements. The agreements index page opens.

External User2-1.PNG

3. Type the name of the agreement you want to find in the search bar. For example, Legal Contract.

External User2.PNG

4. Click the search icon. The agreement record is displayed in the search results.

External User3.PNG

5. Click the Saved Searches "More Views" dropdown to access any saved searches.

External User4.PNG
 
Note: Only those saved searches that are created by Administrators will appear in the drop-down.

6. Click the Categories dropdown.

External User5.PNG

7. Enter a facet to further filter the search. For example, Agreement Name. The number of records matching the filter will be displayed. In this example, only 1 result is displayed.

External User6.PNG